Support preview of REST api docs from local instance
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- HTML
- Stars
- 2
- Forks
- 17
- Avg merge
- 7d 18h
- Merged PRs (30d)
- 3
Description
Currently the REST Api docs are build from the api-spec fetched from pulp-docs "docs-data" branch.
We should add an option (or automatic behavior) of trying to fetch from a local Pulp instance (like the one on port 5001), so the developer can preview the generated API docs from the pulp-docs served website.
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 locating the build step that fetches the api-spec from pulp-docs' docs-data branch and the generated website entry point; no file is named in the issue. Define how a local Pulp instance on port 5001 is selected, then verify the served site renders API docs from that local instance.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html
- Domain
- api, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100