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: Add new section "How-to / Troubleshooting" and move 2 existing troubleshooting pages #9914

Conversation

benjaoming
Copy link
Contributor

@benjaoming benjaoming commented Jan 18, 2023

Refs: #9746

This is a fairly simple change:

  • Create a new sublevel in navigation: "How-to guides / Troubleshooting"
  • Move "Troubleshooting build errors"
  • Move "Troubleshooting slow builds"
  • Adds a new type of suggestion to send in comments and ideas (because Troubleshooting can benefit from the additional grounding in direct user feedback)

I imagine that we will be able to write troubleshooting guides much quicker in the future, given that they have an easily-expandable section now.

Some FAQ items might go and live there in the future.


📚 Documentation previews 📚

@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 13:23
@benjaoming benjaoming marked this pull request as draft January 18, 2023 13:40
@benjaoming
Copy link
Contributor Author

I just realized some other Troubleshooting content to be relabled - so launching "How-to guides / Troubleshooting" is already on the table and easier done in one PR 👍

@benjaoming benjaoming changed the title Docs: Relabel Build Troubleshooting as how-to content Docs: Add new section "How-to / Troubleshooting" and move 2 existing troubleshooting pages Jan 18, 2023
@benjaoming benjaoming marked this pull request as ready for review January 18, 2023 14:05
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.

Lots of comments for a tiny PR, but I think a new guide section is worth thinking about! Exciting.

docs/user/guides/build-using-too-many-resources.rst Outdated Show resolved Hide resolved
docs/user/guides/build-using-too-many-resources.rst Outdated Show resolved Hide resolved
docs/user/guides/build-using-too-many-resources.rst Outdated Show resolved Hide resolved
docs/user/guides/troubleshooting/index.rst Outdated Show resolved Hide resolved
docs/user/guides/troubleshooting/index.rst Outdated Show resolved Hide resolved
docs/user/guides/troubleshooting/index.rst Show resolved Hide resolved
docs/user/guides/troubleshooting/index.rst Show resolved Hide resolved
docs/user/index.rst Show resolved Hide resolved
@benjaoming benjaoming merged commit 4af8813 into readthedocs:diataxis/main Jan 27, 2023
@benjaoming benjaoming deleted the diataxis/relabel-buildtroubleshooting branch January 27, 2023 19:24
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.

3 participants