-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
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
Promote and restructure guides #8528
Merged
Merged
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
49ffef9
Move some guides to feature documentation
astrojuanlu a84eb3c
Restructure guides
astrojuanlu 037a15b
Rename guide for clarity
astrojuanlu d0bd8d3
Small style improvement
astrojuanlu 34ae50b
Improve wording on extra guides links
astrojuanlu fb0de8f
Move user-defined redirects to core features
astrojuanlu b930940
Remove deprecated content from custom domains documentation
astrojuanlu d9c8752
Merge canonical urls content into custom domains documentation
astrojuanlu a34972f
Merge Google Analytics content into Traffic Analytics
astrojuanlu 845ed86
Rename heading for clarity
astrojuanlu 30b7ce2
Update some titles for SEO
astrojuanlu File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
Guides for project administrators | ||
--------------------------------- | ||
|
||
These guides cover common use cases | ||
relevant for managing documentation projects, | ||
using the Read the Docs web interface, | ||
and making changes to the configuration files. | ||
|
||
For an introduction to Read the Docs, | ||
have a look at our :doc:`/tutorial/index`. | ||
|
||
.. toctree:: | ||
:maxdepth: 1 | ||
|
||
technical-docs-seo-guide | ||
manage-translations-sphinx | ||
advanced-search | ||
hiding-a-version | ||
deprecating-content | ||
pdf-non-ascii-languages | ||
importing-private-repositories | ||
wipe-environment |
4 changes: 2 additions & 2 deletions
4
docs/guides/searching-with-readthedocs.rst → docs/guides/advanced-search.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
Guides for documentation authors | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is a much better way to think about the guide structure 💯 |
||
-------------------------------- | ||
|
||
These guides offer some tips and tricks to author documentation | ||
with the tools supported on Read the Docs. | ||
Only reStructuredText or Markdown knowledge | ||
and minimal configuration tweaking are needed. | ||
|
||
For an introduction to Sphinx and Mkdocs, | ||
have a look at our :doc:`/intro/getting-started-with-sphinx` | ||
and :doc:`/intro/getting-started-with-mkdocs`. | ||
|
||
.. toctree:: | ||
:maxdepth: 1 | ||
|
||
cross-referencing-with-sphinx | ||
intersphinx | ||
jupyter |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
Guides for developers and designers | ||
----------------------------------- | ||
|
||
These guides are helpful for developers and designers | ||
seeking to extend the authoring tools | ||
or customize the documentation appearance. | ||
|
||
.. toctree:: | ||
:maxdepth: 1 | ||
|
||
private-python-packages | ||
private-submodules | ||
adding-custom-css | ||
reproducible-builds | ||
embedding-content | ||
conda | ||
remove-edit-buttons | ||
build-using-too-many-resources | ||
vcs |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍 Matching the UI is a good place to start. I could see moving to something like:
In the future, but we'd need to change up how we're linking to them. Perhaps adding a subhead of some kind would be another way to handle this.