redpanda-data / redpanda-data/console
Get topic documentation from s3/local filesystem
Open
Nobody has claimed this yet.
backend
feature
- Dominant language
- TypeScript
- Stars
- 4.3k
- Forks
- 432
- Avg merge
- 3d 6h
- Merged PRs (30d)
- 40
Description
It would be nice to have an ability to load topic documentation from filesystem or S3 bucket.
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
No files, tests, or entry points are named in the issue, so first map where topic documentation is loaded and displayed. Clarify the expected filesystem and S3 sources, configuration, and supported documentation format; done means topic documentation can be loaded from both requested sources.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- aws, typescript
- Domain
- backend, documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100