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

Agent V3 documentation changes #794

Draft
wants to merge 15 commits into
base: v3
Choose a base branch
from
Draft

Agent V3 documentation changes #794

wants to merge 15 commits into from

Conversation

ADubhlaoich
Copy link
Contributor

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.

  • I have read the CONTRIBUTING document
  • I have run make install-tools and have attached any dependency changes to this pull request
  • If applicable, I have added tests that prove my fix is effective or that my feature works
  • If applicable, I have checked that any relevant tests pass after adding my changes
  • If applicable, I have updated any relevant documentation (README.md)
  • If applicable, I have tested my cross-platform changes on Ubuntu 22, Redhat 8, SUSE 15 and FreeBSD 13

ADubhlaoich and others added 5 commits August 20, 2024 13:15
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
@ADubhlaoich ADubhlaoich self-assigned this Aug 21, 2024
@ADubhlaoich ADubhlaoich marked this pull request as draft August 21, 2024 14:43
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Aug 21, 2024
Copy link
Contributor

Deploy Preview will be available once build job completes!

Name Link
😎 Deploy Preview https://frontdoor-test-docs.nginx.com/previews/nginx-agent/794/

ADubhlaoich and others added 3 commits August 23, 2024 15:55
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.
@oCHRISo oCHRISo added the v3.x Issues and Pull Requests related to the major version v3 label Aug 29, 2024
ADubhlaoich and others added 5 commits September 3, 2024 16:45
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
Copy link
Contributor

🎉 Thank you for your contribution! It appears you have not yet signed the F5 Contributor License Agreement (CLA), which is required for your changes to be incorporated into an F5 Open Source Software (OSS) project. Please kindly read the F5 CLA and reply on a new comment with the following text to agree:


I have hereby read the F5 CLA and agree to its terms


2 out of 3 committers have signed the CLA.
✅ (ADubhlaoich)[https://github.com/ADubhlaoich]
✅ (nginx-jack)[https://github.com/nginx-jack]
@nginx-aoife
You can retrigger this bot by commenting recheck in this Pull Request. Posted by the CLA Assistant Lite bot.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies documentation Improvements or additions to documentation v3.x Issues and Pull Requests related to the major version v3
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants