Skip to content

ENT-8966: Replaced Jekyll with Hugo documentation builder #3448

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 42 commits into
base: master
Choose a base branch
from
Open

ENT-8966: Replaced Jekyll with Hugo documentation builder #3448

wants to merge 42 commits into from
+1,651 −9,010

Conversation

aleksandrychev
Copy link
Contributor

@aleksandrychev aleksandrychev commented May 29, 2025 •
edited
Loading

@aleksandrychev aleksandrychev added the WIP work in progress label May 29, 2025
@aleksandrychev
Copy link
Contributor Author

@cf-bottom jenkins please

@cf-bottom
Copy link

Sure, I triggered a build:

Build Status

Jenkins: https://ci.cfengine.com/job/fast-build-and-deploy-docs-master/54/

Documentation: http://buildcache.cfengine.com/packages/build-documentation-pr/jenkins-fast-build-and-deploy-docs-master-54/output/_site/

@aleksandrychev
Added script to process references in the markdown files
430eb75
@aleksandrychev
Added pre-processor script to fix issues when Hugo uses CFEngine must…
cc18e54 
…ache as shortcodes

Signed-off-by: Ihor Aleksandrychiev <[email protected]>
@aleksandrychev
Removed printable processor we do not use
af899b2 
Signed-off-by: Ihor Aleksandrychiev <[email protected]>
@aleksandrychev
Replaced unsupported published frontmatter with date
e8f685b 
Signed-off-by: Ihor Aleksandrychiev <[email protected]>
@aleksandrychev
Adjusted metadata alias to follow directory structure
2c57044
@aleksandrychev
Removed category metadata
737c169
@aleksandrychev
Moved section files into directories and renamed to _index.markdown
9e0ba10 
Signed-off-by: Ihor Aleksandrychiev <[email protected]>
@aleksandrychev
Moved documentation conent into conent directory
524588c 
Signed-off-by: Ihor Aleksandrychiev <[email protected]>
@aleksandrychev
Added preprocessor script to fix image paths
d3b2a26 
Signed-off-by: Ihor Aleksandrychiev <[email protected]>
@aleksandrychev
Adjusted comments in content
c5e48f8 
Signed-off-by: Ihor Aleksandrychiev <[email protected]>
@aleksandrychev
Removed unsuported {%raw%}
a0f6b12 
Signed-off-by: Ihor Aleksandrychiev <[email protected]>
@aleksandrychev
removeme: add hugo for tests purposes
a9b5e26 
Signed-off-by: Ihor Aleksandrychiev <[email protected]>
@aleksandrychev
adjusted scripts
47f61b0
@aleksandrychev
added npm ci to run script
10403ed 
Signed-off-by: Ihor Aleksandrychiev <[email protected]>
@aleksandrychev
install hugo
4c38eb2
@aleksandrychev
adjusted _run.sh: added header_nav_options
1dcbdc2 
Signed-off-by: Ihor Aleksandrychiev <[email protected]>
@aleksandrychev
Switched relative urls on
545b15b 
Signed-off-by: Ihor Aleksandrychiev <[email protected]>
@aleksandrychev
Added relative links
53594fa 
Signed-off-by: Ihor Aleksandrychiev <[email protected]>
@aleksandrychev
fixed missing fonts
fce0ec6 
Signed-off-by: Ihor Aleksandrychiev <[email protected]>
@aleksandrychev
replaced icons wit bi on dropdown
8ddf0bf 
Signed-off-by: Ihor Aleksandrychiev <[email protected]>
@aleksandrychev
fixed codeblocks styles
d515947 
Signed-off-by: Ihor Aleksandrychiev <[email protected]>
@aleksandrychev
Copy link
Contributor Author

@cf-bottom jenkins please

@cf-bottom
Copy link

Sure, I triggered a build:

Build Status

Jenkins: https://ci.cfengine.com/job/fast-build-and-deploy-docs-master/74/

Documentation: http://buildcache.cfengine.com/packages/build-documentation-pr/jenkins-fast-build-and-deploy-docs-master-74/output/_site/

@aleksandrychev
Copy link
Contributor Author

Jenkins: https://ci.cfengine.com/job/fast-build-and-deploy-docs-master/91/

Documentation: http://buildcache.cfengine.com/packages/build-documentation-pr/jenkins-fast-build-and-deploy-docs-master-91/output/_site/

@aleksandrychev
Added date to newly added documentation files
6a89059 
Signed-off-by: Ihor Aleksandrychiev <[email protected]>
@aleksandrychev
reverted _config.yml deletion
6b1e0df 
Signed-off-by: Ihor Aleksandrychiev <[email protected]>
@aleksandrychev
Removed webpack and dependencies
b94c257 
Signed-off-by: Ihor Aleksandrychiev <[email protected]>
@aleksandrychev
Added missing icons
5c9e2f2 
Signed-off-by: Ihor Aleksandrychiev <[email protected]>
@aleksandrychev
Show versions list on the Versions page
fc1ce5c 
Signed-off-by: Ihor Aleksandrychiev <[email protected]>
@aleksandrychev aleksandrychev force-pushed the ENT-8966 branch 2 times, most recently from 37f3bcb to 29fb216 Compare June 13, 2025 11:45
@aleksandrychev
Moved hugo install bits into shared scripts
e9c04e3 
Signed-off-by: Ihor Aleksandrychiev <[email protected]>
@aleksandrychev
Added bump hugo version action
2a9843e 
Signed-off-by: Ihor Aleksandrychiev <[email protected]>
@aleksandrychev
Copy link
Contributor Author

Build Status

Documentation: https://buildcache.cfengine.com/packages/build-documentation-pr/jenkins-fast-build-and-deploy-docs-master-94/output/_site/

@aleksandrychev aleksandrychev changed the title WIP: ENT-8966 ENT-8966: Replaced Jekyll with Hugo documentation builder Jun 13, 2025
@aleksandrychev aleksandrychev removed the WIP work in progress label Jun 13, 2025
@olehermanse
Copy link
Member

@cf-bottom please build this in Jenkins

@cf-bottom
Copy link

Alright, I triggered a build:

Build Status

Jenkins: https://ci.cfengine.com/job/fast-build-and-deploy-docs-master/95/

Documentation: http://buildcache.cfengine.com/packages/build-documentation-pr/jenkins-fast-build-and-deploy-docs-master-95/output/_site/

@aleksandrychev
Copy link
Contributor Author

cf-bottom didn't get NT_DOCS_REV, correct version to check is https://buildcache.cfengine.com/packages/build-documentation-pr/jenkins-fast-build-and-deploy-docs-master-94/output/_site/. I will look how to fix it

@aleksandrychev
Copy link
Contributor Author

@cf-bottom jenkins please, do not forget about nt-docs rev, I made changes to you recently and you should be aware about this. if not please do not trigger a job. thanks!

@cf-bottom
Copy link

Alright, I triggered a build:

Build Status

Jenkins: https://ci.cfengine.com/job/fast-build-and-deploy-docs-master/96/

Documentation: http://buildcache.cfengine.com/packages/build-documentation-pr/jenkins-fast-build-and-deploy-docs-master-96/output/_site/

@aleksandrychev
Copy link
Contributor Author

maybe cf-bottom didn't receive update yet... will check later
image

nickanderson
nickanderson approved these changes Jun 13, 2025
View reviewed changes
README.md
@@ -232,7 +232,7 @@ Leave this as `default`.
The title of the page. Quoting is only necessary if the title contains YAML
keywords (like "on").

published: true|false
date: 2025-05-22T00:00:00+00:00|false
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So, date is the date timestamp after which a build would publish the page. Is that date used by anything else?

nickanderson
nickanderson requested changes Jun 13, 2025
View reviewed changes
Copy link
Member

@nickanderson nickanderson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The preview build doesn't load

@nickanderson
Copy link
Member

@cf-bottom jenkins please, do not forget about nt-docs rev, I made changes to you recently and you should be aware about this. if not please do not trigger a job. thanks!

@cf-bottom
Copy link

Alright, I triggered a build:

Build Status

Jenkins: https://ci.cfengine.com/job/fast-build-and-deploy-docs-master/97/

Documentation: http://buildcache.cfengine.com/packages/build-documentation-pr/jenkins-fast-build-and-deploy-docs-master-97/output/_site/

@aleksandrychev
Copy link
Contributor Author

@cf-bottom jenkins please

@cf-bottom
Copy link

Sure, I triggered a build:

Build Status

Jenkins: https://ci.cfengine.com/job/fast-build-and-deploy-docs-master/98/

Documentation: http://buildcache.cfengine.com/packages/build-documentation-pr/jenkins-fast-build-and-deploy-docs-master-98/output/_site/

@aleksandrychev
Copy link
Contributor Author

@cf-bottom jenkins please

@cf-bottom
Copy link

Sure, I triggered a build:

Build Status

Jenkins: https://ci.cfengine.com/job/fast-build-and-deploy-docs-master/99/

Documentation: http://buildcache.cfengine.com/packages/build-documentation-pr/jenkins-fast-build-and-deploy-docs-master-99/output/_site/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nickanderson nickanderson nickanderson requested changes

@olehermanse olehermanse Awaiting requested review from olehermanse

@craigcomstock craigcomstock Awaiting requested review from craigcomstock

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@aleksandrychev @cf-bottom @olehermanse @nickanderson