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

docs: update style guidelines for documentation contributions #11712

Merged
merged 2 commits into from
Sep 14, 2023

Conversation

agilgur5
Copy link

Motivation

Update documentation guidelines to reference the much more detailed upstream k8s guidelines

  • Stumbled upon this for the first time in a long while, during recent PR reviews for the Developer tab of the docs

Modifications

  • refer to the k8s style guide, which is pretty highly quality with good examples

  • remove incorrect title-case comment

    • "And" is in fact usually not capitalized by most title-case writing standards
  • fix a missing comma and missing words here as well

    • e.g. "being reported spelling error" -> "being reported as a spelling error"
    • add a title to this bulleted list

Verification

make docs passes

- refer to the [k8s style guide](https://kubernetes.io/docs/contribute/style/style-guide/), which is pretty highly quality with good examples
  - and which I use often to guide my technical writing, including in many previous PRs to this repo
  - remove duplicative content that is already mentioned in the k8s style guide, such as "avoid jargon"
  - remove an example that contradicts the k8s style guide
    - it actually should be "the Workflow" as it is an API object: https://kubernetes.io/docs/contribute/style/style-guide/#use-upper-camel-case-for-api-objects

- remove incorrect title-case comment
  - "And" is in fact usually _not_ capitalized by most title-case writing standards
    - [Wikipedia style manual](https://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style/Titles_of_works#Capital_letters) specifically excludes "short coordinating conjunctions" and specifically lists "and"
    - same with [AMA style manual](https://titlecaseconverter.com/rules/#AMA)

- fix a missing comma and missing words here as well
  - e.g. "being reported spelling error" -> "being reported as a spelling error"
  - add a title to this bulleted list

Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
@agilgur5 agilgur5 added the area/docs Incorrect, missing, or mistakes in docs label Aug 30, 2023
@agilgur5
Copy link
Author

Blarg, spell check is failing on "shortcodes" and "EditorConfig", which I thought I could avoid by literally quoting the words 😕

Could backtick instead, but these aren't code, so may have to add to .spelling despite them only being used as a reference and not in our own docs

- unfortunately quoting these did not ignore them, so had to add them to the list 😕

Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
@terrytangyuan terrytangyuan merged commit c81fcdc into argoproj:master Sep 14, 2023
@agilgur5 agilgur5 deleted the docs-update-docs-guidelines branch September 14, 2023 14:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Incorrect, missing, or mistakes in docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants