pulp / pulp-docs

Python Package to help aggregating Pulp's multirepo ecosystem into a unified doc.
https://pedro-psb.github.io/pulp-docs/
2 stars 4 forks source link

Gracefully deprecate legacy docs #33

Closed pedro-psb closed 3 months ago

pedro-psb commented 4 months ago

Progress

Some repositories didn't had doc pages before, so this task doesn't apply.

plugins

others

Approach

A) Banner with link + schedule deletion/freeze (choosed)

Pro: simple and low cost Cons: people with legacy links need to find the correspondent fresh content on the new docs

B) Per-Page Redirects (discarded)

Pros: require more work Cons: people with legacy links will go directly to fresh content

pedro-psb commented 4 months ago

After some brief discussion with @decko, @dkliban and @bmbouter , we've decided the following as a general strategy:

pedro-psb commented 4 months ago

As an small addition to this idea, instead of redirecting to the pulpproject.org home, we should redirect to a "transition section" with some minimum background and useful tips for using the new docs (such as "Help > Documentation Usage" page, which is currently a only placeholder)