openshift / openshift/openshift-apiserver
Missing README.md
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 49
- Forks
- 117
- Avg merge
- 17h 1m
- Merged PRs (30d)
- 1
Description
Hi Team,
The current state of the README.md is:
TODO: ADD README.md here
It's been like this since https://github.com/openshift/openshift-apiserver/commit/01c7eec4b7bf3baeb1eb2a7c36ec23b569f378d1
Is there any chance we can get a TLDR written into this; Hopefully one that describes a short list of services that are expected to be handed off to the openshift-apiserver and why it exists?
This will make it a lot easier for the support-staff when troubleshooting API-related issues.
Cheers,
Michael
Contributor guide
No contributing guide indexed for this repository
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 with README.md and the linked commit that introduced the TODO. Replace the placeholder with a concise overview of the services handed off to openshift-apiserver and why it exists, with enough context for support staff troubleshooting API issues. Done means the README contains that TLDR instead of the TODO.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 30/100