Skip to content

Docs: Relabel pages to new top-level "Reference/Policies and legal documents" (Diátaxis) #9916

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

Merged

Conversation

benjaoming
Copy link
Contributor

@benjaoming benjaoming commented Jan 18, 2023

Refs: #9746

This top-level is easiest to introduce and populate in one go.

  • Move all articles that are either a policy or a legal document
  • Rename all policies to " policy", i.e. not "Policy for ".
  • Move contents from old section "Legal documents and policies" and remove legal/index.rst since its replaced by reference/policies.rst

📚 Documentation previews 📚

…op-level "Reference/Policies and legal documents"
@benjaoming benjaoming added the Needed: documentation Documentation is required label Jan 18, 2023
@benjaoming benjaoming requested a review from a team as a code owner January 18, 2023 15:16
@benjaoming benjaoming requested a review from agjohnson January 18, 2023 15:16
Copy link
Member

@ericholscher ericholscher left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Simple enough, we need to make sure we have a redirect for the rename here though. Are we tracking redirects anywhere?

@benjaoming
Copy link
Contributor Author

benjaoming commented Jan 19, 2023

Simple enough, we need to make sure we have a redirect for the rename here though.

Oh yes, I was really hesitating to make this rename, but it just felt sooo messy if I put an index of a section somewhere else.

What if we do this:

  1. Keep a standard placeholder at the location of the old page, with :orphan: + this page is moved here: <path>
  2. When we want to launch and create redirects, we look for all the placeholders and eliminate them.

benjaoming and others added 4 commits January 19, 2023 20:56
Co-authored-by: Eric Holscher <[email protected]>
…l/index (pending that we do a redirect instead), move Account Security to Security Policy.
@ericholscher
Copy link
Member

What if we do this:

  1. Keep a standard placeholder at the location of the old page, with :orphan: + this page is moved here: <path>
  2. When we want to launch and create redirects, we look for all the placeholders and eliminate them.

I think we just create the redirects now? We could make them on the distaxis branch, then just migrate them to latest & stable after merge.

@benjaoming
Copy link
Contributor Author

I think we just create the redirects now? We could make them on the distaxis branch

How does that work? Aren't user-defined redirects a global thing so we'd end up redirecting things that are currently live on main?

@benjaoming
Copy link
Contributor Author

Right Exact redirects FTW 💯

Outcome: /en/diataxis-main/legal/index.html -> /en/diataxis-main/reference/policies.html

@benjaoming
Copy link
Contributor Author

Alright, should be good to go now 👍

Can test if https://docs.readthedocs.io/en/diataxis-main/legal/index.html will redirect once this has been merged and built.

@benjaoming benjaoming merged commit 9c1fdd1 into readthedocs:diataxis/main Jan 27, 2023
@benjaoming benjaoming deleted the diataxis/relabel-policies branch January 27, 2023 21:54
@ericholscher
Copy link
Member

Looks like it redirected properly 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needed: documentation Documentation is required
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants