Support for multiple source paths
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 45/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- go, kubernetes
- Domain
- documentation, tooling
Research direction
Start in processor/processor.go, where source paths are parsed, and read the controller-tools LoadRoots API referenced in the issue. Done means the generator accepts multiple source paths so each CRD can be documented together with its shared common directory, without relying on config.yaml exclusions.
Written by the indexing model from the issue text.
Description
When generating docs for the operator with mutliple CRDs in different paths, it would be nice to specify multiple source paths. For ex, in the following folder structure -
api
- crd1
- crd2
- common
common contains shared structs used by both crd1 and crd2 CRDs. To generate adocs for crd1, I would have to pass folders crd1 and common. Similarly crd2 and common folders if I want docs for crd2.
I looked at the code that parses the source paths (processor/processor.go) and found out that the controller-tools has a LoadRoots api that supports reading from multiple source paths. So it shouldnt be too complex to support multiple source paths.
As a workaround to this problem, we are using config.yaml to exclude types in each adoc.
- Dominant language
- Go
- Stars
- 174
- Forks
- 81
- PR merge metrics
- No merged PRs in 30d
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing 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.
More from elastic/crd-ref-docs
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
elastic/crd-ref-docs#204 ·
-
Support for +kubebuilder:validation:Required and omitemptyPossibly taken @swathinsankaran claimed this 112 days ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
elastic/crd-ref-docs#198 · 1 reaction ·
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
elastic/crd-ref-docs#191 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
elastic/crd-ref-docs#188 · 2 comments ·
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
elastic/crd-ref-docs#182 ·
All issues in elastic/crd-ref-docs
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
signal18/replication-manager#1981 ·
Maintainers usually reply within 1 day
-
Battery UI: German word "Speicher"Possibly taken @github-actions claimed this today. Openux
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
evcc-io/evcc#34716 · 1 comment ·
Maintainers usually reply within 1 day
-
ready-for-agent
Difficulty 2/5 1-3 hours Newbie friendliness 83/100
jasonfen/terminal-space-program#611 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
prime-radiant-inc/evener#4329 ·
Maintainers usually reply within 1 day