Skip to content

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
merged 15 commits into from
May 25, 2023

Conversation

benjaoming
Copy link
Contributor

@benjaoming benjaoming commented Apr 17, 2023

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".

  • Relabel guides
  • Move files
  • Fix up references that were initially wrong (but more evident now that filenames are fixed)
  • Added some new content for "How to automatically configure a Git repository" which had gone a bit stray
  • Create redirects for 2 moved pages

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.

  • Are these good tweaks?
  • I added new text to "How to automatically configure a Git repository". I think it fits as a howto guide since it aligns with information that I imagine users would look for.. even though there is nothing actionable, the guide now takes a practical approach.
  • While doing the above, I uncovered some content for a feature reference :)
  • Other small things to fix here while we're at it?

Refs: #9747


📚 Documentation previews 📚

@benjaoming benjaoming added Improvement Minor improvement to code Needed: documentation Documentation is required labels Apr 17, 2023
@benjaoming benjaoming marked this pull request as ready for review April 17, 2023 20:10
@benjaoming benjaoming requested a review from a team as a code owner April 17, 2023 20:10
@benjaoming benjaoming requested a review from ericholscher April 17, 2023 20:10
benjaoming added a commit that referenced this pull request Apr 18, 2023
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.

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'
@benjaoming benjaoming merged commit 37b8e43 into main May 25, 2023
@benjaoming benjaoming deleted the diataxis/relabel-howto-git-guide branch May 25, 2023 15:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Improvement Minor improvement to code Needed: documentation Documentation is required
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants