ContainerSolutions/externalsecret-operator

Investigate why we are not able to use https://doc.crds.dev/ for generating crd docs, and fix it

Open

#152 opened on Jan 25, 2021

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)Go (27 forks)auto 404
good first issue

Repository metrics

Stars
 (192 stars)
PR merge metrics
 (PR metrics pending)

Description

Describe the solution you'd like Make necessary changes to the project to be able to use doc.crds.dev.

What is the added value? Would be very nice to have an autogenerated CRD docs for our CRDs.

Give us examples of the outcome

Works for multiple repos: https://twitter.com/hasheddan/status/1351254486581473281/retweets/with_comments

Not working with ours.

Contributor guide

Research direction
Investigate the requirements for doc.crds.dev compatibility and update CRD annotations or settings accordingly.
Tech stack
go
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
KubernetesGo
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70