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

feat: Migrate NGINX Gateway Fabric documentation into repository #81

Merged
merged 7 commits into from
Jan 23, 2025

Conversation

ADubhlaoich
Copy link
Contributor

@ADubhlaoich ADubhlaoich commented Jan 20, 2025

Proposed changes

With the newly open source documentation repository, we can now consolidate all NGINX documentation into one place. This has a lots of benefits which include but are not limited to more effective content re-use, pipeline engineering and style enforcement.

This pull request adds all of the content for NGINX Gateway Fabric, and updates all relevant folder and file names, including link references. Once this content has been successfully deployed, a PR to remove all documentation traces and tooling will be opened in the Gateway Fabric repository, decoupling the documentation fully.

It also updates the frontmatter of every single page in the documentation set. They are now all consistent in their fields and formatting, and a handful of IA or heading changes have been made as low-hanging fruit to bring the documentation set closer to full consistency.

Checklist

Before creating a PR, run through this checklist and mark each as complete.

  • I have signed the F5 Contributor License Agreement (CLA)

  • I have read the contributing guidelines

  • 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

  • I have updated any relevant documentation (README.md and CHANGELOG.md)

  • 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

  • If the change involves:

    • Code
    • Anything that resembles Personally identifying information (PII)
      • Make sure to use placeholders such as <username> in place of PII
    • URLs (watch for typosquatting)
    • Significant new/revised content

    In these cases, the change will require at least two (2) approvals before merging

With the newly open source documentation repository, we can now
consolidate all NGINX documentation into one place. This has a lots of
benefits which include but are not limited to more effective content
re-use, pipeline engineering and style enforcement.

This commit adds all of the content for NGINX Gateway Fabric, and
updates all relevant folder and file names, including link references.
Once this content has been successfully deployed, a PR to remove all
documentation traces and tooling will be opened in the Gateway Fabric
repository, decoupling the documentation fully.
@ADubhlaoich ADubhlaoich self-assigned this Jan 20, 2025
@ADubhlaoich
Copy link
Contributor Author

The main effort for this PR has actually been completed, and it runs locally as expected right now.

I'm keeping this in draft for the time being as I want to fix up the frontmatter metadata for the entire documentation set while I have it in front of me.

Copy link

Deploy Preview will be available once build job completes!

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

This commit removes an accidental duplicate of the includes folder, and
updates the frontmatter of every single page in the documentation set.
They are now all consistent in their fields and formatting, and a
handful of IA or heading changes have been made as low-hanging fruit to
bring the documentation set closer to full consistency.
@ADubhlaoich ADubhlaoich marked this pull request as ready for review January 21, 2025 16:51
@ADubhlaoich ADubhlaoich requested a review from a team as a code owner January 21, 2025 16:51
@ADubhlaoich
Copy link
Contributor Author

Opened the PR up, and updated the original message: I have updated the frontmatter for all but one file.

@ADubhlaoich
Copy link
Contributor Author

Created a paired PR for NGINX Gateway Fabric to remove the documentation from their repository once this has been merged.

nginx/nginx-gateway-fabric#3047

There is also a pending PR for the deployment configuration changes necessary once this has been merged.

@ADubhlaoich ADubhlaoich merged commit c976027 into main Jan 23, 2025
7 checks passed
@ADubhlaoich ADubhlaoich deleted the ngf/migrate-documentation branch January 23, 2025 17:25
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