Skip to content

Conversation

JTorreG
Copy link
Contributor

@JTorreG JTorreG commented Nov 30, 2023

Proposed changes

Update /docs documents to point to the docs.nginx.com

Closes #ISSUE

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

@JTorreG JTorreG requested a review from ADubhlaoich November 30, 2023 12:37
@JTorreG JTorreG requested a review from a team as a code owner November 30, 2023 12:37
@JTorreG JTorreG self-assigned this Nov 30, 2023
@github-actions github-actions bot added documentation Improvements or additions to documentation helm-chart Relates to helm chart labels Nov 30, 2023
@JTorreG JTorreG merged commit a5ae669 into docs/hugo-docs Nov 30, 2023
@JTorreG JTorreG deleted the hugo-docs-fix-links branch November 30, 2023 13:23
sjberman added a commit that referenced this pull request Nov 30, 2023
* Migrate docs to docs.nginx.com (#1226)

Change docs structure and add the required files to build documentation Hugo and publish with Netlify

Rewrite existing docs to work with Hugo


---------

Co-authored-by: Travis Martin <[email protected]>
Co-authored-by: Travis Martin <[email protected]>
Co-authored-by: Kate Osborn <[email protected]>
Co-authored-by: Alan Dooley <[email protected]>
Co-authored-by: Alan Dooley <[email protected]>

* fix: fix links in github docs to d-n-c (#1291)

* Fix installation docs for mismatched versions (#1287)

Problem: Our installation docs suggested installing Gateway API v1 and NGF v1, which are not compatible.

Solution: Fix the docs to mention both stable and edge versions, with proper versioning. Also updated the release process doc to ensure these are updated at release time as needed.

* Update Control Plane Configuration documentation for Hugo formatting (#1296)

This commit updates the control plane configuration documentation to
match NGINX's standardised Hugo formatting conventions: specifically,
avoiding breaking sentences across line and the use of shortcodes for a
note. There are also some minor content changes for product noun
conventions and rephrasing a few sentences.

---------

Co-authored-by: Jon Torre <[email protected]>

* docs: update architecture doc (#1295)

* docs: update architecture doc

* chore: update architecture description

---------

Co-authored-by: Alan Dooley <[email protected]>

---------

Co-authored-by: Jon Torre <[email protected]>
Co-authored-by: Travis Martin <[email protected]>
Co-authored-by: Travis Martin <[email protected]>
Co-authored-by: Kate Osborn <[email protected]>
Co-authored-by: Alan Dooley <[email protected]>
Co-authored-by: Alan Dooley <[email protected]>
miledxz added a commit to miledxz/nginx-gateway-fabric that referenced this pull request Jan 14, 2025
* Migrate docs to docs.nginx.com (nginx#1226)

Change docs structure and add the required files to build documentation Hugo and publish with Netlify

Rewrite existing docs to work with Hugo


---------

Co-authored-by: Travis Martin <[email protected]>
Co-authored-by: Travis Martin <[email protected]>
Co-authored-by: Kate Osborn <[email protected]>
Co-authored-by: Alan Dooley <[email protected]>
Co-authored-by: Alan Dooley <[email protected]>

* fix: fix links in github docs to d-n-c (nginx#1291)

* Fix installation docs for mismatched versions (nginx#1287)

Problem: Our installation docs suggested installing Gateway API v1 and NGF v1, which are not compatible.

Solution: Fix the docs to mention both stable and edge versions, with proper versioning. Also updated the release process doc to ensure these are updated at release time as needed.

* Update Control Plane Configuration documentation for Hugo formatting (nginx#1296)

This commit updates the control plane configuration documentation to
match NGINX's standardised Hugo formatting conventions: specifically,
avoiding breaking sentences across line and the use of shortcodes for a
note. There are also some minor content changes for product noun
conventions and rephrasing a few sentences.

---------

Co-authored-by: Jon Torre <[email protected]>

* docs: update architecture doc (nginx#1295)

* docs: update architecture doc

* chore: update architecture description

---------

Co-authored-by: Alan Dooley <[email protected]>

---------

Co-authored-by: Jon Torre <[email protected]>
Co-authored-by: Travis Martin <[email protected]>
Co-authored-by: Travis Martin <[email protected]>
Co-authored-by: Kate Osborn <[email protected]>
Co-authored-by: Alan Dooley <[email protected]>
Co-authored-by: Alan Dooley <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation helm-chart Relates to helm chart
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants