-
Notifications
You must be signed in to change notification settings - Fork 75
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.
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
Open
aleksandrychev
wants to merge
42
commits into
cfengine:master
Choose a base branch
from
aleksandrychev:ENT-8966
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+1,651
−9,010
Open
Changes from all commits
Commits
Show all changes
42 commits
Select commit
Hold shift + click to select a range
430eb75
Added script to process references in the markdown files
aleksandrychev cc18e54
Added pre-processor script to fix issues when Hugo uses CFEngine must…
aleksandrychev af899b2
Removed printable processor we do not use
aleksandrychev e8f685b
Replaced unsupported published frontmatter with date
aleksandrychev 2c57044
Adjusted metadata alias to follow directory structure
aleksandrychev 737c169
Removed category metadata
aleksandrychev 9e0ba10
Moved section files into directories and renamed to _index.markdown
aleksandrychev 524588c
Moved documentation conent into conent directory
aleksandrychev d3b2a26
Added preprocessor script to fix image paths
aleksandrychev c5e48f8
Adjusted comments in content
aleksandrychev a0f6b12
Removed unsuported {%raw%}
aleksandrychev a9b5e26
removeme: add hugo for tests purposes
aleksandrychev 47f61b0
adjusted scripts
aleksandrychev 10403ed
added npm ci to run script
aleksandrychev 4c38eb2
install hugo
aleksandrychev 1dcbdc2
adjusted _run.sh: added header_nav_options
aleksandrychev 545b15b
Switched relative urls on
aleksandrychev 53594fa
Added relative links
aleksandrychev fce0ec6
fixed missing fonts
aleksandrychev 8ddf0bf
replaced icons wit bi on dropdown
aleksandrychev d515947
fixed codeblocks styles
aleksandrychev 3c7e72c
fixed active menu items highlighting cause by relative paths
aleksandrychev 523f81c
adjusted title
aleksandrychev f90da80
Added redirect rules made to handle new documenation structure
aleksandrychev f2fb919
reveted content path in the menubuilder
aleksandrychev 2e2ffe7
copy content directory to hugo
aleksandrychev d485d17
copy over search index to the _site/assets
aleksandrychev 5024581
fixed content cp
aleksandrychev d442f94
updated hugo
aleksandrychev 422a473
Added searchBaseUrl config
aleksandrychev fbaf8be
updated theme code styles
aleksandrychev e94f864
Replaced deprecated hugo comments with HTML comments
aleksandrychev 0053f4f
Removed unnecessary files from hugo
aleksandrychev c0011a2
Removed unnessesary files from generator
aleksandrychev b7d4f2c
Removed Jekyl dependencies
aleksandrychev 6a89059
Added date to newly added documentation files
aleksandrychev 6b1e0df
reverted _config.yml deletion
aleksandrychev b94c257
Removed webpack and dependencies
aleksandrychev 5c9e2f2
Added missing icons
aleksandrychev fc1ce5c
Show versions list on the Versions page
aleksandrychev e9c04e3
Moved hugo install bits into shared scripts
aleksandrychev 2a9843e
Added bump hugo version action
aleksandrychev File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
name: Hugo version update | ||
|
||
on: | ||
schedule: | ||
- cron: "0 0 * * 0" #perform every sunday's night | ||
workflow_dispatch: | ||
|
||
jobs: | ||
update_hugo_version: | ||
if: github.repository_owner == 'cfengine' || github.repository_owner == 'mendersoftware' || github.repository_owner == 'NorthernTechHQ' | ||
runs-on: ubuntu-latest | ||
permissions: | ||
contents: write | ||
pull-requests: write | ||
steps: | ||
- uses: actions/checkout@v4 | ||
- name: Fetch latest Hugo release info | ||
id: fetch_hugo_version | ||
run: | | ||
release_info=$(curl -s https://api.github.com/repos/gohugoio/hugo/releases/latest) | ||
version=$(echo "$release_info" | jq -r '.tag_name' | sed 's/v//') | ||
# download checksums and find checksum of hugo_${version}_Linux-64bit.tar.gz | ||
checksum=$( curl -sSL https://github.com/gohugoio/hugo/releases/download/v${version}/hugo_${version}_checksums.txt | grep hugo_${version}_Linux-64bit.tar.gz | grep -oE "[a-z0-9]{64}") | ||
echo "version=$version" >> $GITHUB_OUTPUT | ||
echo "checksum=$checksum" >> $GITHUB_OUTPUT | ||
|
||
- name: Update install_hugo.sh | ||
run: | | ||
sed -i "s|https://github.com/gohugoio/hugo/releases/download/v.*_Linux-64bit.tar.gz|https://github.com/gohugoio/hugo/releases/download/v${{ steps.fetch_hugo_version.outputs.version }}/hugo_${{ steps.fetch_hugo_version.outputs.version }}_Linux-64bit.tar.gz|" generator/build/install_hugo.sh | ||
sed -i "s/.*sha256sum.*/RUN echo \"${{ steps.fetch_hugo_version.outputs.checksum }} hugo.tar.gz\" | sha256sum -c/" generator/build/install_hugo.sh | ||
- name: Create Pull Request | ||
uses: cfengine/create-pull-request@v7 | ||
with: | ||
commit-message: Upgraded Hugo version to ${{ steps.fetch_hugo_version.outputs.version }} | ||
title: Upgraded Hugo version to ${{ steps.fetch_hugo_version.outputs.version }} | ||
body: | | ||
This PR updates the version of Hugo used in the generator/build/install_hugo.sh to ${{ steps.fetch_hugo_version.outputs.version }}. | ||
reviewers: | | ||
aleksandrychev | ||
|
||
branch: hugo-version-update-${{ steps.fetch_hugo_version.outputs.version }} | ||
sign-commits: true |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -28,3 +28,5 @@ core.includes | |
# Mac Finder | ||
|
||
.DS_Store | ||
|
||
/hugo/node_modules |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,7 @@ | ||
--- | ||
layout: default | ||
title: API | ||
published: true | ||
date: 2025-05-22T00:00:00+00:00 | ||
sorting: 50 | ||
--- | ||
|
||
|
File renamed without changes
2 changes: 1 addition & 1 deletion
2
api/enterprise-api-examples.markdown → ...i/enterprise-api-examples/_index.markdown
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
...amples/browsing-host-information.markdown → ...amples/browsing-host-information.markdown
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
...e-api-examples/changes-api-usage.markdown → ...e-api-examples/changes-api-usage.markdown
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,7 @@ | ||
--- | ||
layout: default | ||
title: Tracking changes | ||
published: true | ||
date: 2025-05-22T00:00:00+00:00 | ||
sorting: 50 | ||
--- | ||
|
||
|
2 changes: 1 addition & 1 deletion
2
...ise-api-examples/checking-status.markdown → ...ise-api-examples/checking-status.markdown
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,7 @@ | ||
--- | ||
layout: default | ||
title: Checking status | ||
published: true | ||
date: 2025-05-22T00:00:00+00:00 | ||
sorting: 20 | ||
--- | ||
|
||
|
2 changes: 1 addition & 1 deletion
2
...e-api-examples/managing-settings.markdown → ...e-api-examples/managing-settings.markdown
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,7 @@ | ||
--- | ||
layout: default | ||
title: Managing settings | ||
published: true | ||
date: 2025-05-22T00:00:00+00:00 | ||
sorting: 30 | ||
--- | ||
|
||
|
2 changes: 1 addition & 1 deletion
2
...xamples/managing-users-and-roles.markdown → ...xamples/managing-users-and-roles.markdown
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
...erprise-api-examples/sql-queries.markdown → ...erprise-api-examples/sql-queries.markdown
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
api/enterprise-api-ref.markdown → ...nt/api/enterprise-api-ref/_index.markdown
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
api/enterprise-api-ref/actions-api.markdown → ...i/enterprise-api-ref/actions-api.markdown
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
...nterprise-api-ref/audit-logs-api.markdown → ...nterprise-api-ref/audit-logs-api.markdown
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
api/enterprise-api-ref/build-api.markdown → ...api/enterprise-api-ref/build-api.markdown
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
api/enterprise-api-ref/changes.markdown → ...t/api/enterprise-api-ref/changes.markdown
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
api/enterprise-api-ref/cmdb-api.markdown → .../api/enterprise-api-ref/cmdb-api.markdown
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
...rprise-api-ref/export-import-api.markdown → ...rprise-api-ref/export-import-api.markdown
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
...ort-import-compliance-report-api.markdown → ...ort-import-compliance-report-api.markdown
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
...-api-ref/federated-reporting-api.markdown → ...-api-ref/federated-reporting-api.markdown
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
api/enterprise-api-ref/file-changes.markdown → .../enterprise-api-ref/file-changes.markdown
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,7 @@ | ||
--- | ||
layout: default | ||
title: File changes API | ||
published: true | ||
date: 2025-05-22T00:00:00+00:00 | ||
--- | ||
|
||
|
||
|
2 changes: 1 addition & 1 deletion
2
...erprise-api-ref/first-time-setup.markdown → ...erprise-api-ref/first-time-setup.markdown
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
...rprise-api-ref/health-diagnostic.markdown → ...rprise-api-ref/health-diagnostic.markdown
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
api/enterprise-api-ref/host.markdown → content/api/enterprise-api-ref/host.markdown
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
api/enterprise-api-ref/inventory.markdown → ...api/enterprise-api-ref/inventory.markdown
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
api/enterprise-api-ref/ldap-api.markdown → .../api/enterprise-api-ref/ldap-api.markdown
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
...terprise-api-ref/personal-groups.markdown → ...terprise-api-ref/personal-groups.markdown
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
api/enterprise-api-ref/query.markdown → ...ent/api/enterprise-api-ref/query.markdown
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
...nterprise-api-ref/reset-password.markdown → ...nterprise-api-ref/reset-password.markdown
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
...enterprise-api-ref/shared-groups.markdown → ...enterprise-api-ref/shared-groups.markdown
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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?