Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Gracefully deprecate legacy docs #33

Closed
6 tasks done
pedro-psb opened this issue Apr 10, 2024 · 2 comments
Closed
6 tasks done

Gracefully deprecate legacy docs #33

pedro-psb opened this issue Apr 10, 2024 · 2 comments

Comments

@pedro-psb
Copy link
Member

pedro-psb commented Apr 10, 2024

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)

  • Link to new docs (on the appropriate repo page)
  • Inform what will happen to the legacy website (either be deleted after some day or remain freezed).

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)

  • Remove old legacy content
  • Create per-page redirects to matching content (no banner necessary in this case)

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

@pedro-psb
Copy link
Member Author

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

  • Schedule a redirection of for July 2024:
  • For now, add banners to websites with schedule information and a link to the new website.

@pedro-psb
Copy link
Member Author

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)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant