Skip to content

Docs: Add new section "How-to / Troubleshooting" and move 2 existing troubleshooting pages #9914

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.

Sign up for GitHub

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
merged 11 commits into from
Jan 27, 2023
Merged

Docs: Add new section "How-to / Troubleshooting" and move 2 existing troubleshooting pages #9914

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
836c315
Relabel Build Troubleshooting as how-to and update introduction to a …
benjaoming Jan 18, 2023
ed207bd
Add new level "how-to guides / troubleshooting" with 2 troubleshootin…
benjaoming Jan 18, 2023
cbb8cb0
Fix up introduction to slow builds troubleshooting
benjaoming Jan 18, 2023
316418a
Add a tip box for the build issues page as well, slightly rephrased
benjaoming Jan 18, 2023
8693f12
Add suggestion for "Edit on GitHub"
benjaoming Jan 18, 2023
6788d24
refinement to "terminated by Read the Docs"
benjaoming Jan 18, 2023
41ec638
replace spoken word with written word
benjaoming Jan 18, 2023
b3033c9
Apply suggestions from code review
benjaoming Jan 19, 2023
9c8efc0
Merge branch 'diataxis/main' of github.com:readthedocs/readthedocs.or…
benjaoming Jan 27, 2023
8e9fd29
Reuse contribution :tip: box, addresse @ericholscher comments
benjaoming Jan 27, 2023
f65edeb
Merge branch 'diataxis/relabel-buildtroubleshooting' of github.com:be…
benjaoming Jan 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions docs/user/build-troubleshooting.rst → docs/user/guides/build-troubleshooting.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
Build troubleshooting
=====================
Troubleshooting build errors
============================

This section is very specific and may change over time.
Please help us keep it updated and contribute your own build errors and resolutions.

.. tip::

Please help us keep this section updated and contribute your own build errors and resolutions.
Send in helpful ideas 💡 to [email protected].


Git errors
Expand Down Expand Up @@ -60,7 +63,6 @@ Permission denied (publickey)
- ``https://bitbucket.org/<username>/<repo>/admin/access-keys/``



ERROR: Repository not found.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down
4 changes: 2 additions & 2 deletions docs/user/guides/build-using-too-many-resources.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
My Build is Using Too Many Resources
====================================
Troubleshooting slow builds
===========================

We limit build resources to make sure that users don't overwhelm our build systems.
If you are running into this issue,
Expand Down
14 changes: 14 additions & 0 deletions docs/user/guides/troubleshooting/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
How to troubleshoot specific issues
-----------------------------------

In the following guides,
you can learn how to fix specific common problems.

.. File locations are a bit odd here because of legacy.
.. We will move files to new locations and create redirects in a later refactor

.. toctree::
:maxdepth: 1

Build errors <../build-troubleshooting>
Slow builds <../build-using-too-many-resources>
2 changes: 1 addition & 1 deletion docs/user/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,7 @@ to help you create fantastic documentation for your project.
/guides/authors
/guides/administrators
/guides/developers
Troubleshooting </guides/troubleshooting/index>
/examples


Expand Down Expand Up @@ -158,7 +159,6 @@ and some of the core features of Read the Docs.

/builds
/build-customization
/build-troubleshooting
/environment-variables
/badges

Expand Down