-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
Docs: Relabel howto guides for Git repository configuration (Diátaxis) #10247
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
Conversation
This file contains hidden or 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
31 tasks
…ataxis/relabel-howto-git-guide
…docs/readthedocs.org into diataxis/relabel-howto-git-guide
benjaoming
added a commit
that referenced
this pull request
Apr 18, 2023
ericholscher
approved these changes
May 24, 2023
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.
This does a good job of clarifying the guide names. Should be mergable with a couple fixes.
benjaoming
added a commit
that referenced
this pull request
May 25, 2023
* Put included .rst files in the same directory * Replace old warning with standard message about RTD4B * Use tabbed interface * Remove ToC * Add more clarity about who the guide is for + screenshots * Fix what is also fixed in #10247 * Update references * What? Maybe absolute path? But relative should work... WARNING: unknown document: 'guides/importing-private-repositories'
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
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.
This tweaks the accuracy of two howto guides that can be hard to distinguish. Not least because of the existence of a third guide "How to connect your Read the Docs account to your Git provider".
Reviewing
I tried to keep this simple and only add clarity where the howto can perhaps create confusion about how Read the Docs works and which howto to use.
Refs: #9747
📚 Documentation previews 📚
docs
): https://docs--10247.org.readthedocs.build/en/10247/dev
): https://dev--10247.org.readthedocs.build/en/10247/