operator-framework / operator-framework/operator-sdk
Add documentation style guide
Open
Nobody has claimed this yet.
kind/documentation
lifecycle/frozen
- Dominant language
- Go
- Stars
- 7.7k
- Forks
- 1.8k
- PR merge metrics
- No merged PRs in 30d
Description
To increase consistency, lets document decisions we make.
- For internal links, use relative links rather than absolute paths
- For example commands, do we use
$ operator-sdk initoroperator-sdk init - For all links, prefer
[text][link-name]to[text](https://link) - Verb forms in headers (e.g. present participle "Creating a project" vs. imperative "Create a project")
Feel free to add others.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No file, test, or entry point is named. Start by locating the repository's existing documentation and contribution guidance; the work is done when the listed conventions and any additional decisions are captured in a maintainable style guide.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100