-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
Improve the getting started docs #4676
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
davidfischer
merged 7 commits into
master
from
davidfischer/docs-getting-started-improvements
Oct 5, 2018
Merged
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
4adc1f5
Improve the getting started docs
davidfischer 7a1beca
Fix a typo
davidfischer e0b7ef1
Link to the yaml config from the import guide
davidfischer ee7aa3c
Improve connected accounts docs
davidfischer b348c04
Add screenshots to getting started docs
davidfischer 176c3ca
Merge branch 'master' into davidfischer/docs-getting-started-improvem…
davidfischer 66ea0f3
Remove link to MkDocs from Sphinx getting started guide
davidfischer 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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
Connecting Your Account | ||
----------------------- | ||
|
||
If you are going to import repositories from GitHub, Bitbucket, or GitLab, | ||
you should connect your Read the Docs account to your repository host first. | ||
Connecting your account allows for: | ||
|
||
* Easier importing of your repositories | ||
* Automatically configure your repository :doc:`webhooks` | ||
which allow Read the Docs to build your docs on every change to your repository | ||
* Log into Read the Docs with your GitHub, Bitbucket, or GitLab credentials | ||
|
||
If you signed up or logged in to Read the Docs with your GitHub, Bitbucket, or GitLab | ||
credentials, you're all done. Your account is connected. | ||
|
||
To connect your unconnected account, go to your *Settings* dashboard | ||
and select `Connected Services <https://readthedocs.org/accounts/social/connections/>`_. | ||
From here, you'll be able to connect to your GitHub, Bitbucket or GitLab | ||
account. This process will ask you to authorize a connection to Read the Docs, | ||
that allows us to read information about and clone your repositories. |
This file was deleted.
Oops, something went wrong.
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
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
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.
We should really make this a subproject and have a nicer integration between the two sets of docs.
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.
Can you go into a little more detail about what you mean by this?
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.
We should make it a subproject and use some of our fancier features that we build for users on our own stuff.
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.
i started on this path to restructure all of our docs -- add all subprojects/translations and break up community user docs, community developer docs, and commercial docs. probably part of a larger thing that we should dog food on the .com