docs: Community READMEs (and more), iteration 1

[mjang]

Proposed changes

This is the first iteration for a new open source docs repository. Our intent is to move content, code, etc. from our existing internal docs repo.

I started with our template repository for open source, https://github.com/nginxinc/template-repository , and then:

• Defined differences for documentation based on
  • Current internal docs repository
  • Knowledge of our current / planned processes for working with communities
  • Lessons learned from the fossy.us 2024 conference

Issue: https://github.com/nginxinc/docs/issues/1029

Checklist

Since this is the first PR for this repository, we need to create a new checklist. If we accept the "README"-type files (including other names) that I've included in this PR, then our new checklist will include more info than we had before.

Unknowns

• I don't know how to resolve the F5 CLA error
• I've done my best to set up access parallel to our current docs repo. The screenshot (which I'll delete later) includes my best guesses:

What I did there at least got rid of the errors I had with the CODEOWNERS file

[ADubhlaoich]

LGTM, low LOGAF on my edit suggestions.

The product vs project nomenclature might be slightly confusing: all products are projects, but not all projects are products, as far as dotted lines go.

[mjang]

@travisamartin Since I'm at the end of my workday, and you're about to go on PTO for a week, I've added comments on what I'll do on Tuesday. You seem good with the one change that felt uncertain.

Thanks for the review!

[mjang]

@alessfg , I'm having trouble with the CLA build check. I see it works fine in my PR on the template repository: nginx/template-repository#47

I assume I've missed a step. Alessandro, do you know what it is?

(Addressed by @alessfg in a later comment)

[mjang]

For the record -- I'm awaiting approvals from @alessfg and @travisamartin , who are both on PTO this week. I've done my best to address comments so far.

[jputrino]

LGTM overall! Only additional suggestion I have is to list in the README which products' docs are in this repo and provide links to the open source repos for the products not represented here.

[alessfg]

As a general comment to the docs here, it seems that sometimes markdown is limited to x characters per line (I'm assuming 72-80) and sometimes it is not. My personal preference for markdown is to not limit the characters per line (my code editors default to treating each line as a paragraph), but I am generally okay with either option as long as it is consistent throughout the repo. (Given this repo is mostly going to consist of actual markdown docs it's even more relevant to ensure we are consistent throughout.)

I will also add that I am actually backporting some of the changes made here to the template repo -- great work altogether!

[mjang]

As a general comment to the docs here, it seems that sometimes markdown is limited to x characters per line (I'm assuming 72-80)

It's something we haven't applied rigorously to our docs. For the record, markdown linters normally limit lines to 80 characters, solely for readability in some editors.

[mjang]

@alessfg , I'm having trouble with the CLA build check. I see it works fine in my PR on the template repository: nginxinc/template-repository#47

I assume I've missed a step. Alessandro, do you know what it is?

As @alessfg told me in #1, we have to check that it works after we make this open.

[alessfg]

Suggested change

	## Commercial support
	## Commercial Support

[mjang]

We're now working towards Sentence Case. I realize i should add this info to the style guide.

[alessfg]

Good to know! I'm pretty sure the current version of the docs here use a mix of both so it'll probably need a cleanup before going public :)

[alessfg]

Found a couple minor typos -- someone should probably do an in depth check before we merge/repo goes public :)

[mjang]

As this repo is a WiP, I'm going to arbitrarily say that I have enough approvals to proceed with merge.