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.

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
Show file tree
Hide file tree
Changes from 5 commits
Commits
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
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
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 comments or ideas 💡 to [email protected]
or contribute directly by clicking :guilabel:`Edit on GitHub` in the top right corner of this page.


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



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

Expand Down
21 changes: 15 additions & 6 deletions docs/user/guides/build-using-too-many-resources.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,20 @@
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,
there are a couple fixes that you might try.
In case you are waiting a long time for your builds to finish
or your builds are terminated by Read the Docs,
you may want to have a look at the most common issues that slow down builds.

.. note:: The current build limits can be found on our :doc:`/builds` page.
.. note::

Build resources on Read the Docs are limited to make sure that users don't overwhelm our build systems.
The current build limits can be found on our :doc:`/builds` page.

.. tip::

Please help us keep this section updated and contribute your own performance improvements.
Send in your helpful comments or ideas 💡 to [email protected]
or contribute directly by clicking :guilabel:`Edit on GitHub` in the top right corner of this page.

Reduce formats you're building
------------------------------
Expand Down
14 changes: 14 additions & 0 deletions docs/user/guides/troubleshooting/index.rst
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
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