Skip to content
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

DO NOT MERGE #6603

Conversation

vepatel
Copy link
Contributor

@vepatel vepatel commented Oct 7, 2024

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.

Proposed changes

Describe the use case and detail of the change. If this PR addresses an issue on GitHub, make sure to include a link to
that issue here in this description (not in the title of the PR).

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.

There are a number of other CI configuration changes that have also
been made to account for this update.
@github-actions github-actions bot added documentation Pull requests/issues for documentation github_actions Pull requests that update Github_actions code labels Oct 7, 2024
Copy link

github-actions bot commented Oct 7, 2024

Deploy Preview will be available once build job completes!

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

@vepatel vepatel closed this Oct 7, 2024
@vepatel vepatel deleted the test-cherry-pick-release-3.7-df554a4efaa66085cb85f88b092eece7ea5478e4 branch October 7, 2024 16:28
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 github_actions Pull requests that update Github_actions code
Projects
Status: Done 🚀
Development

Successfully merging this pull request may close these issues.

2 participants