argoproj / argo-workflows

Workflow Engine for Kubernetes
https://argo-workflows.readthedocs.io/
Apache License 2.0
15.11k stars 3.21k forks source link

docs: add some existing conventions to the docs style guide #13809

Open agilgur5 opened 4 weeks ago

agilgur5 commented 4 weeks ago

Motivation

These are existing conventions that we try to follow most of the time and I figured it would be better to have a centralized link for these. I would previously say "conventionally" / "by convention" or "consistently" / "to be consistent" or link to a past example during review, but having a single source-of-truth is better.

Modifications

note a few that have recently been mentioned off the top of my head:

Verification

make docs passes

Future Work

  1. [ ] add more existing conventions