Skip to content

troubleshooting doc - WIP#122

Open
shellygr wants to merge 1 commit intomasterfrom
shelly/troubleshooting
Open

troubleshooting doc - WIP#122
shellygr wants to merge 1 commit intomasterfrom
shelly/troubleshooting

Conversation

@shellygr
Copy link
Copy Markdown
Contributor

@shellygr shellygr commented Aug 5, 2023

Naming convention:

  • PRs for features that are in design should have the "proposal" label
  • PRs for features that haven't landed yet should have the "future" label
  • PRs for upcoming releases should have the "release" label
  • PRs with new documentation for existing features should have the "existing feature" label

Before requesting review:

  • Make sure there is a ticket in the DOC board in Jira
  • Make sure CI is passing
    • Spell check failure may require adding backticks around code or updating spelling_wordlist.txt
    • See README.md for information about style and markdown syntax
    • If the CI Details link gives a 404, you need to log in to readthedocs.com
  • Add link to generated documentation here
    • you can find this by following the read the docs link from the CI check
  • Ask for help in #documentation

Jira ticket: TODO
Link to generated documentation: TODO

@shellygr shellygr requested a review from a team as a code owner August 5, 2023 18:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant