Migrate docs to docs.nginx.com

[Jcahilltorre]

Proposed changes

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

• Rewrite existing docs to work with Hugo

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

[sjberman]

We'll probably want to think of a better place to store the developer docs, rather than docs-developer. We also probably want docs/proposals to be stored elsewhere (not in public docs).

[pleshakov]

Hi @Jcahilltorre

I'd like to double check on how much feedback (if any) this PR needs any feedback at this point.
What is left or necessary to make this PR transition from Draft to Ready for Review?

[netlify]

✅ Deploy Preview for nginx-gateway-fabric ready!

Name	Link
🔨 Latest commit	19b159d
🔍 Latest deploy log	https://app.netlify.com/sites/nginx-gateway-fabric/deploys/65492eb95393e8000805530c
😎 Deploy Preview	https://deploy-preview-1226--nginx-gateway-fabric.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[ciarams87]

Couple of small comments that don't need to be addressed now, and a question, but otherwise looks good! Thanks! 🚀

[sjberman]

There are various linting errors returned from our pipeline that need to be fixed.

Also, we have links in the repo (like the README) that lead users to our docs. If we aren't yet publishing our docs to docs.nginx.com, then we need to update those links to the hugo content directory so users don't lose our docs reference. Do the links in the docs to other pages (the relrefs) work when viewing in github? Or are these links only functional on the nginx docs website?

I'm just concerned that users won't be able to properly view and navigate the docs in Github while the docs are in this hugo format without yet being published to the docs website.

[Jcahilltorre]

There are various linting errors returned from our pipeline that need to be fixed.

Also, we have links in the repo (like the README) that lead users to our docs. If we aren't yet publishing our docs to docs.nginx.com, then we need to update those links to the hugo content directory so users don't lose our docs reference. Do the links in the docs to other pages (the relrefs) work when viewing in github? Or are these links only functional on the nginx docs website?

I'm just concerned that users won't be able to properly view and navigate the docs in Github while the docs are in this hugo format without yet being published to the docs website.

There are various linting errors returned from our pipeline that need to be fixed.

Also, we have links in the repo (like the README) that lead users to our docs. If we aren't yet publishing our docs to docs.nginx.com, then we need to update those links to the hugo content directory so users don't lose our docs reference. Do the links in the docs to other pages (the relrefs) work when viewing in github? Or are these links only functional on the nginx docs website?

I'm just concerned that users won't be able to properly view and navigate the docs in Github while the docs are in this hugo format without yet being published to the docs website.

Followed up on this via slack. In short we can hold on until docs are ready to be published in the main docs site

[pleshakov]

@kate-osborn
running docs locally using the instructions for hugo (hugo server) yields different table of contents - are you using an up to date version.

[kate-osborn]

@kate-osborn running docs locally using the instructions for hugo (hugo server) yields different table of contents - are you using an up to date version.

I was looking at the preview linked by the netlify bot. I'll try running locally

[kate-osborn]

@kate-osborn running docs locally using the instructions for hugo (hugo server) yields different table of contents - are you using an up to date version.

I was looking at the preview linked by the netlify bot. I'll try running locally

Local preview looks better. Thanks for the tip @pleshakov

[sjberman]

LGTM, pending the linting errors

[Jcahilltorre]

the latest preview of the branch is available here: https://hugo-docs--preview-nginx-gateway-fabric.netlify.app/nginx-gateway-fabric/

[Jcahilltorre]

Fixed lint issues