Skip to content

Conversation

@ADubhlaoich
Copy link
Member

Proposed changes

This commit makes a number of changes related to documentation:

  • It changes the folder from /docs to /site, matching other NGINX software, which retain /docs for development documentation
  • It updates go.mod with the new theme file
  • It updates the Docs section of the .gitignore file
  • It updates the deployment action to match the folder change, and adds the ability to change the theme version during deployment

Notably, the latest theme update has a new shortcode which allows for code files to be embedded from GitHub links, creating the possibility of single sources of truth in documentation examples.

Checklist

Before creating a PR, run through this checklist and mark each as complete.

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked that all unit tests pass after adding my changes
  • I have updated necessary documentation
  • I have rebased my branch onto main
  • I will ensure my PR is targeting the main branch and pulling from my branch from my own fork
This commit makes a number of changes related to documentation: - It changes the folder from /docs to /site, matching other NGINX software, which retain /docs for development documentation - It updates go.mod with the new theme file - It updates the Docs section of the .gitignore file - It updates the deployment action to match the folder change, and adds the ability to change the theme version during deployment Notably, the latest theme update has a new shortcode which allows for code files to be embedded from GitHub links, creating the possibility of single sources of truth in documentation examples.
@ADubhlaoich ADubhlaoich requested review from a team as code owners October 1, 2024 14:54
@github-actions github-actions bot added documentation Pull requests/issues for documentation github_actions Pull requests that update Github_actions code chore Pull requests for routine tasks labels Oct 1, 2024
@ADubhlaoich ADubhlaoich self-assigned this Oct 1, 2024
@github-actions
Copy link
Contributor

github-actions bot commented Oct 1, 2024

Deploy Preview will be available once build job completes!

Name Link
😎 Deploy Preview https://frontdoor-test-docs.nginx.com/previews/nginx-ingress-controller/6554/

@ADubhlaoich ADubhlaoich added the needs cherry pick Cherry pick this PR into a release branch label Oct 1, 2024
@codecov
Copy link

codecov bot commented Oct 1, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 53.11%. Comparing base (6957d3e) to head (5c7d677).
Report is 7 commits behind head on main.

Additional details and impacted files
@@ Coverage Diff @@ ## main #6554 +/- ## ========================================== + Coverage 53.07% 53.11% +0.03%  ========================================== Files 87 87 Lines 16191 16191 ========================================== + Hits 8594 8600 +6  + Misses 7189 7185 -4  + Partials 408 406 -2 

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link

@j1m-ryan j1m-ryan left a comment

Choose a reason for hiding this comment

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

@ADubhlaoich
Copy link
Member Author

@j1m-ryan GRMA: made the changes you described!

Copy link
Collaborator

@pdabelf5 pdabelf5 left a comment

Choose a reason for hiding this comment

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

Looks like there are a few more docs directory references

33 results - 19 files .dockerignore: 1: docs* .fossa.yml: 7: - docs .gitignore: 52: # Ignore local docs dependencies 55: docs/public 56: docs/themes/f5-hugo 58: docs/.netlify .markdownlint-cli2.yaml: 13: - "docs/**" # Ignore docs folder for now .pre-commit-config.yaml: 3: exclude: (^docs/_vendor/|.*pb2.*) 11: exclude: docs/layouts/shortcodes/nic-.*.html CODEOWNERS: 2: /docs/ @nginxinc/kic @nginxinc/nginx-docs CONTRIBUTING.md: 31: Follow our [Installation Guide](https://github.com/nginxinc/kubernetes-ingress/blob/main/docs/content/installation) to 34: Read the [documentation](https://github.com/nginxinc/kubernetes-ingress/tree/main/docs) and README.md: 144: | Edge/Nightly | For testing and experimenting | Use the edge or nightly images from [DockerHub](https://hub.docker.com/r/nginx/nginx-ingress/), [GitHub Container](https://github.com/nginxinc/kubernetes-ingress/pkgs/container/kubernetes-ingress), [Amazon ECR Public Gallery](https://gallery.ecr.aws/nginx/nginx-ingress) or [Quay.io](https://quay.io/repository/nginx/nginx-ingress) or [build your own image](https://docs.nginx.com/nginx-ingress-controller/installation/building-nginx-ingress-controller/). | [Build your own image](https://docs.nginx.com/nginx-ingress-controller/installation/building-nginx-ingress-controller/). | [Manifests](https://github.com/nginxinc/kubernetes-ingress/tree/main/deployments). [Helm chart](https://github.com/nginxinc/kubernetes-ingress/tree/main/charts/nginx-ingress). | [Documentation](https://github.com/nginxinc/kubernetes-ingress/tree/main/docs/content). [Examples](https://github.com/nginxinc/kubernetes-ingress/tree/main/examples). | .github/dependabot.yml: 59: directory: /docs .github/labeler.yml: 35: - head-branch: ['^docs/', '^doc/'] .github/scripts/release-notes-update.sh: 9: DOCS_TO_UPDATE_FOLDER=${ROOTDIR}/docs/content .github/scripts/release-version-update.sh: 12: DOCS_TO_UPDATE_FOLDER=${ROOTDIR}/docs/content 124: echo -n "${new_ic_version}" > ./docs/layouts/shortcodes/nic-version.html 125: echo -n "${new_helm_chart_version}" > ./docs/layouts/shortcodes/nic-helm-version.html 126: echo -n "${new_operator_version}" > ./docs/layouts/shortcodes/nic-operator-version.html .github/scripts/variables.sh: 21: find . -type f \( -name "*.go" -o -name go.mod -o -name go.sum -o -name "*.tmpl" -o -name "version.txt" \) -not -path "./docs*" -exec md5sum {} + | LC_ALL=C sort | md5sum | awk '{ print $1 }' .github/workflows/ci.yml: 63: files=$(git diff --name-only HEAD^ | egrep -v "^docs/" | egrep -v "^examples/" | egrep -v "^README.md") 64: docs_files=$(git diff --name-only HEAD^ | grep "^docs/") 209: run: cd docs && make docs-ci .github/workflows/codeql-analysis.yml: 38: files=$(git diff --name-only HEAD^ | egrep -v "^docs/" | egrep -v "^examples/" | egrep -v "^README.md") .github/workflows/dependabot-hugo.yml: 6: - "docs/go.mod" 41: working-directory: docs .github/workflows/docs-build-push.yml: 19: - "docs/**" 37: docs_build_path: "./docs" .github/workflows/fossa.yml: 8: - "docs/**" .github/workflows/mend.yml: 8: - docs/** 
@github-actions github-actions bot removed the chore Pull requests for routine tasks label Oct 1, 2024
@ADubhlaoich
Copy link
Member Author

@pdabelf5 GRMA, pushed changes!

Learned a lot about the CI/CD while going through everything - I'd really like to fork a version of the cherry-pick workflow for elsewhere in the org.

ADubhlaoich and others added 3 commits October 2, 2024 09:01
Co-authored-by: Paul Abel <128620221+pdabelf5@users.noreply.github.com> Signed-off-by: Alan Dooley <github@adubhlaoi.ch>
@ADubhlaoich ADubhlaoich enabled auto-merge (squash) October 2, 2024 09:25
@ADubhlaoich ADubhlaoich merged commit df554a4 into main Oct 2, 2024
82 checks passed
@ADubhlaoich ADubhlaoich deleted the docs/folder-action-updates branch October 2, 2024 09:33
nginx-jack pushed a commit to nginx-jack/kubernetes-ingress that referenced this pull request Oct 7, 2024
…x#6554) This commit makes a number of changes related to documentation: - It changes the folder from /docs to /site, matching other NGINX software, which retain /docs for development documentation - It updates go.mod with the new theme file - It updates the Docs section of the .gitignore file - It updates the deployment action to match the folder change, and adds the ability to change the theme version during deployment Notably, the latest theme update has a new shortcode which allows for code files to be embedded from GitHub links, creating the possibility of single sources of truth in documentation examples. There are a number of other CI configuration changes that have also been made to account for this update.
@pdabelf5 pdabelf5 removed github_actions Pull requests that update Github_actions code needs cherry pick Cherry pick this PR into a release branch labels Dec 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Pull requests/issues for documentation

4 participants