CRD doc generation leads to bad formatting
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 42/100
- Issue type
- Bug
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- kubernetes
- Domain
- documentation
Research direction
Start with the rendered NiFi CRD section at the linked crds.stackable.tech URL and identify how Quantity documentation is produced. Trace that input through the documentation generation flow, then verify that the affected Quantity fields render without the bad formatting across the generated CRD docs.
Written by the indexing model from the issue text.
Description
E.g. In the NiFi CRD docs here https://crds.stackable.tech/24.11.0/nifi.stackable.tech/nificluster/v1alpha1/#spec-nodes-config-resources-storage-stateRepo-capacity (probably is everywhere where Quantity is used).
Possible fixes:
- We can try to remove that doc comment from rendering
- Dominant language
- CSS
- Stars
- 13
- Forks
- 14
- Avg merge
- 4d 8h
- Merged PRs (30d)
- 10
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.
More from stackabletech/documentation
-
Withdraw ADR018 Open
Difficulty 1/5 Under an hour Newbie friendliness 68/100
stackabletech/documentation#734 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 55/100
stackabletech/documentation#779 ·
-
customer-request
Difficulty 4/5 3-5 days Newbie friendliness 35/100
stackabletech/documentation#773 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 25/100
stackabletech/documentation#754 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 25/100
stackabletech/documentation#753 ·
All issues in stackabletech/documentation
Similar issues
-
Add: hunch Open
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
AbdelStark/awesome-typesafe#104 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
A11y ♿️
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Link Checker Report Openautomated issue report
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
-
documentation improve or update documentation priority/low triage
Difficulty 2/5 Half a day Newbie friendliness 86/100
warpdotdev/docs#782 · 1 comment ·