operator-framework / operator-framework/operator-sdk
Docs: Have an operator scope doc per type
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 7.7k
- Forks
- 1.8k
- PR merge metrics
- No merged PRs in 30d
Description
Feature Request
Is your feature request related to a problem? Please describe.
Currently, we have just one doc that explains the operator scope and how to change it which is very specific for Go. However, it has been linked in the Ansible/Helm doc and then, its user may might harder to understand.
Describe the solution you'd like
- Move current the operator scope doc to Golang section
- Create one doc specific for Helm and other for Ansible in each respective sections.
- Update the links in the docs to reflect the changes.
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
Start by locating the current operator scope document and searching the documentation for links to it. Move the existing document into the Go section, create corresponding Helm and Ansible documents in their sections, and update all references so each link targets the appropriate guide.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ansible, go, helm
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100