Support preview of REST api docs from local instance

Aperta

#83 aperta il 21/8/2024 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà: 4/5
Tempo stimato: 3-5 giorni
Idoneità per principianti: 38/100

Tipo di issue: Funzionalità
Chiarezza: Abbastanza chiara
Stato di attività: Ferma
Stack tecnologico: html
Ambito: api, documentation

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

enhancement

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.

Lingua principale: HTML
Stelle: 2
Fork: 17
Merge medio: 7g 18h
PR unite (30g): 3

Guida per i contributori

Apri la guida per i contributori

Come iniziare

Leggi tutta la issue e poi la guida ai contributi del progetto.
Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
Fai un fork del repository e lavora su un branch.
Apri una pull request che faccia riferimento al numero della issue.

Altre issue di pulp/pulp-docs

Create managed files for pulp-docs on ALL components Aperta

epic

Difficoltà 5/5 Più di una settimana Idoneità per principianti 25/100

pulp/pulp-docs#183 · 1 commento · Aperta il 3/3/2026
Changes fragments with linebreaks breaks display Aperta

bug

Difficoltà 3/5 1-2 giorni Idoneità per principianti 48/100

pulp/pulp-docs#171 · 1 reazione · Aperta il 20/1/2026
Add information about CI and publishing Aperta

documentation

Difficoltà 3/5 1-2 giorni Idoneità per principianti 45/100

pulp/pulp-docs#136 · Aperta il 13/6/2025
Add issue templates Aperta

enhancement

Difficoltà 2/5 1-3 ore Idoneità per principianti 55/100

pulp/pulp-docs#135 · Aperta il 13/6/2025
Create a page with reference to last legacy docs commits Aperta

enhancement

Difficoltà 3/5 1-2 giorni Idoneità per principianti 45/100

pulp/pulp-docs#97 · Aperta il 31/10/2024

Tutte le issue di pulp/pulp-docs

Issue simili

`Array.initialize` and `Array.repeat` throw on a negative count Aperta

Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100

gren-lang/core#167 · Aperta il 25/9/2026
fix(pg-meta): schemas.update and schemas.remove DO blocks fail when a name contains "$$" Aperta

external-issue to-triage

Difficoltà 2/5 1-3 ore Idoneità per principianti 88/100

supabase/supabase#50882 · Aperta il 24/9/2026
wkt: `WKTFieldMask.paths` is an immutable `public let paths: [String]` with no default `init(paths: [String] = [])` or `.with(_:)` helper, preventing in-place mutation Aperta

Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100

googleapis/google-cloud-swift#1151 · Aperta il 24/9/2026
SqliteSaver.list(filter=...) silently misses nested metadata values containing non-ASCII text Aperta

external

Difficoltà 2/5 1-3 ore Idoneità per principianti 65/100

langchain-ai/langgraph#9074 · 1 commento · Aperta il 24/9/2026
Correct FileCitationBody.index documentation to describe its position in output text Aperta

documentation specification

Difficoltà 1/5 Meno di un'ora Idoneità per principianti 90/100

openai/openai-openapi#584 · Aperta il 24/9/2026

Altre issue su Backend & API Design