feat: Update Contributing guidelines for writers

[ADubhlaoich]

Proposed changes

This commit updates the CONTRIBUTING_DOCS.md file to our contemporary standards for documentation formatting, adding mention of Hugo archetypes and our ghcode shortcode, while also removing some slightly redundant information.

Certain sentences have been removed or simplified to reduce the amount of contextual reading required: in certain cases, the reader is guided to refer to the style guide for more precise information, such as in the case of using images.

There will likely be follow-up work in the future to more cleanly delineate guidance for using Hugo and guidance around writing content in a general sense, to tightly scope the purpose of this document in relation to the style guide.

Closes issue #164

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 changes¹, 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. ↩

[github-actions]

✅ Deploy Preview will be available once build job completes!

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

---

[mjang]

While I won't stop this change, it feels like we're now writing CONTRIBUTING_DOCS.md for the developer.

[javorszky]

Hi, engineer on the NIC team here. I would very much love it if I, and other engineers, were also regarded as a target audience for this document. Part of our workflow is creating the features and the documentation for said features. In my view the less work the docs team needs to do on any doc changes, the better, but that can only happen if we, the engineers, know what to do in the first place 🙂

I also like overexplaining things. I'd rather that than having to open several new tabs to figure out what's what.

Though it doesn't matter, I do call them backticks.

[mjang]

Hi, engineer on the NIC team here. I would very much love it if I, and other engineers, were also regarded as a target audience for this document. Part of our workflow is creating the features and the documentation for said features. In my view the less work the docs team needs to do on any doc changes, the better, but that can only happen if we, the engineers, know what to do in the first place 🙂

I also like overexplaining things. I'd rather that than having to open several new tabs to figure out what's what.

Though it doesn't matter, I do call them backticks.

Hi @javorszky , I appreciate your perspective, and your efforts to create documentation for NIC. It's helpful, and I appreciate your work.

One of the reasons we created this open source repository is to appeal to less technical users. Today, we have contributions from both technical and less technical users. Most of the technical users are from within NGINX and F5. Since we have two audiences, I did suggest that we have F5-NGINX-* files for those of us from NGINX and F5.