redpanda-data / redpanda-data/connect
expose public API to generate markdown docs for custom plugins
Open
Nobody has claimed this yet.
configuration
enhancement
ux
- Dominant language
- Go
- Stars
- 8.8k
- Forks
- 969
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 64
Description
Docs generation is currently in internal/docs today.
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 by reading the existing implementation in internal/docs. Determine which documentation-generation capability must become public for custom plugins and what API boundary is appropriate. Done should mean custom plugins can invoke markdown documentation generation through a supported public API, with the expected behavior verified by the project’s tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- api, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100