Agent V3 documentation changes #794
Open
Conversation
This file contains 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 commit adds placeholder pages for new documentation related to Agent v3, and shifts the v2 pages into their own discrete section, alongside layout changes to nudge users to v3. It also addresses some low hanging fruit for design system adherence, renaming pages and updating titles. The majority of content work will be done in subsequent PRs.
feat: Agent v3 documentation architectural changes
* Add docs-build-push github workflow * Remove slash from docs_source_path
Cherry-pick doc-actions tooling from main for v3 documentation branch
github-actions
bot
added
the
documentation
✅ Deploy Preview will be available once build job completes!
|
This commit adds the Agent v2 metrics catalogue to the new v2 subsection. It is achieved by copying the existing catalogue within the NGINX Management Suite documentation, since it covers the same content.
This commit adds a placeholder document for exporting metrics, and adds the key template information for how-to documents to the exporting metrics and migrating from v2 to v3 pages. It also cleans up metadata description instances on the folder index pages.
This commit adds a placeholder document for exporting metrics, and adds the key template information for how-to documents to the exporting metrics and migrating from v2 to v3 pages. It also cleans up metadata description instances on the folder index pages.
Fix broken URL
(cherry-pick) Bump documentation theme version
This commit updates the documentation Makefile and README, reflecting changes to it across NGINX's open source repositories for consistency. It removes unnecessary targets: Netlify is no longer used, nor was the Makefile used for Netlify for quite some time. The guidance for Makefile targets in the README is updated accordingly, as well formatting instructions for how we use Hugo contemporaneously.
(cherry-pick) Update Makefile and README
Cherry-pick bump docs-action to v1.0.5
|
✅ All required contributors have signed the F5 CLA for this PR. Thank you! |
Add Agent v2 and v3 metrics pages.
Update README.md with correct make target behaviors Add hugo-entrypoint to allow extra commands when docker starts Update hugo theme version in go.mod
…e1f30b3910b2991f8c8b6b51588752aeb46 Add hugo version check and theme update to Makefile
…07d0fce0cbad706e9b4043781439ac54441 [Cherry pick] Fix docs docker failing without git context
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Proposed changes
This draft PR encapsulates the v3 documentation branch which all subsequent work targets.
It will be merged into the v3 branch close to release date: this description will be updated at a later point to reflect changes.
Checklist
Before creating a PR, run through this checklist and mark each as complete.
CONTRIBUTINGdocumentmake install-toolsand have attached any dependency changes to this pull requestREADME.md)