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

Docs: Refactor all business features into feature reference + change "privacy level" page (Diátaxis) #10007

Merged

Conversation

benjaoming
Copy link
Contributor

@benjaoming benjaoming commented Feb 8, 2023

This refactor does the following:

  • Empties and removes the "Read the Docs for Business" navigation
  • Moves all existing business features into the common features section
  • The former "business feature index" is now an "About Read the Docs for Business" page that attempts to write a simple reference, which I think we can afford to be more technical in the future. The new "Reference / About" section will fit this content.
  • Moves "/commercial/subscriptions" to how-tos
  • Yes, I did a diagram that's very simplified, but it's the image that I'd want people to have in their head when they think about the relationship between RTD4B and RTD4C.

Open questions:

  • How do we refer to "landing pages" or "marketing website"? What's the word that we would use in our documentation? "Website" is the best term moving forwards, since we're unifying various landing page experience 👍
  • Should this PR also just jump straight into refactoring the old "About" navigation section into reference? Not seeing any blockers... Doing remaining work in a separate PR because we might want to go into details with the About Read the Docs for Business page

Refs: #9746


📚 Documentation previews 📚

@benjaoming benjaoming changed the base branch from main to diataxis/main February 8, 2023 16:07
@benjaoming
Copy link
Contributor Author

@ericholscher I'm gonna have a look at the other review feedback you've provided. Would you be able to have a quick look here at the 2 "open questions" in the description ⬆️ ?

@benjaoming benjaoming marked this pull request as ready for review February 9, 2023 18:02
@benjaoming benjaoming requested a review from a team as a code owner February 9, 2023 18:02
@benjaoming
Copy link
Contributor Author

Went over the open questions, and this PR is now open for review 🎉

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.

This is great! 💯 Lots of nitpicks, as usual :) Been hanging out with writers for too long.

Read the Docs for Business
--------------------------
About |com_brand|
=================
Copy link
Member

Choose a reason for hiding this comment

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

Does this work? I never know if it's going to expand first or not.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This one worked, but we can't write *|com_brand|* 🤦

image

Copy link
Member

@ericholscher ericholscher Feb 10, 2023

Choose a reason for hiding this comment

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

Yea... could be a good use case for myst, but not sure if they have substitutions heh :) There's a hack to get nested syntax, I think using another substitution or something janky.

docs/user/commercial/index.rst Outdated Show resolved Hide resolved
docs/user/commercial/index.rst Outdated Show resolved Hide resolved
docs/user/commercial/index.rst Outdated Show resolved Hide resolved
docs/user/commercial/index.rst Outdated Show resolved Hide resolved
docs/user/commercial/index.rst Outdated Show resolved Hide resolved
docs/user/commercial/index.rst Outdated Show resolved Hide resolved
docs/user/commercial/index.rst Outdated Show resolved Hide resolved
docs/user/commercial/index.rst Outdated Show resolved Hide resolved
@benjaoming
Copy link
Contributor Author

Seems everything is good! I'll leave a comment thread unresolved in case needs attention, but doesn't seem critical to me.

@benjaoming
Copy link
Contributor Author

Nice to get this in wrt other PRs on feature reference and TOC refactoring.

@benjaoming benjaoming merged commit 28da459 into readthedocs:diataxis/main Feb 10, 2023
@benjaoming benjaoming deleted the diataxis/project-privacy branch February 10, 2023 15:13
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

Successfully merging this pull request may close these issues.

2 participants