Skip to content

feat: Update NGF Get started guide and installation documents #224

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

Merged
merged 4 commits into from
Feb 25, 2025

Conversation

ADubhlaoich
Copy link
Contributor

@ADubhlaoich ADubhlaoich commented Feb 24, 2025

Proposed changes

This commit adds explicit guidance at the top of the Get started guide, directing the reader towards the Installation section for a production deployment. It also removes mention of the experimental channel, which is an unnecessary use case for trying NGF.

It also creates uniformity in the Helm and Manifest deployment documentation, by matching how sections are formatted, and creating an include file for identical instructions on upgrading the API resources.

Checklist

Before merging a pull request, run through this checklist and mark each as complete.

  • I have read the contributing guidelines
  • I have signed the F5 Contributor License Agreement (CLA)
  • I have rebased my branch onto main
  • I have ensured my PR is targeting the main branch and pulling from my branch from my own fork
  • I have ensured that the commit messages adhere to Conventional Commits
  • I have ensured that documentation content adheres to the style guide
  • If the change involves potentially sensitive changes1, I have assessed the possible impact
  • If applicable, I have added tests that prove my fix is effective or that my feature works
  • I have ensured that existing tests pass after adding my changes
  • If applicable, I have updated README.md and CHANGELOG.md

Footnotes

  1. Potentially sensitive changes include anything involving code, personally identify information (PII), live URLs or significant amounts of new or revised documentation. Please refer to our style guide for guidance about placeholder content.

This commit adds explicit guidance at the top of the Get started guide,
directing the reader towards the Installation section for a production
deployment. It also removes mention of the experimental channel, which
is an unnecessary use case for trying NGF.

It also creates uniformity in the Helm and Manifest deployment
documentation, by matching how sections are formatted, and creating an
include file for identical instructions on upgrading the API resources.
@ADubhlaoich ADubhlaoich requested review from a team as code owners February 24, 2025 13:35
Copy link

Deploy Preview will be available once build job completes!

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

@ADubhlaoich ADubhlaoich enabled auto-merge (squash) February 24, 2025 16:40
@ADubhlaoich ADubhlaoich merged commit 01c86c8 into main Feb 25, 2025
8 checks passed
@ADubhlaoich ADubhlaoich deleted the ngf/update-get-started branch February 25, 2025 13:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants