operator-framework / operator-framework/operator-sdk
Update scorecard docs to be more clear how to use the configuration file.
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 7.7k
- Forks
- 1.8k
- PR merge metrics
- No merged PRs in 30d
Description
What is the URL of the document?
https://sdk.operatorframework.io/docs/advanced-topics/scorecard/scorecard/#configuration
Which section(s) is the issue in?
What needs fixing?
A better description of when and how to use the configuration. There are no examples of passing in a configuration on the command line to override the existing config in a bundle. It isn't clear how to add my own tests to this configuration file either.
Additional context
One scenario we'd like is to be able to define tests in a config file and use that file for multiple bundles.
for b in bundles:
operator-sdk scorecard b --config mytests.yaml
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 with the Configuration section at https://sdk.operatorframework.io/docs/advanced-topics/scorecard/scorecard/#configuration and review the existing scorecard configuration behavior. Document command-line overrides using mytests.yaml, explain how to add tests, and show reuse of one configuration across multiple bundles. Done means the page clearly covers these examples and use cases.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- yaml
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 35/100