Skip to content

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
merged 7 commits into from
Oct 5, 2018
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
15 changes: 15 additions & 0 deletions docs/connected-accounts.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
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`
* Log into Read the Docs with your GitHub, Bitbucket, or GitLab credentials

To connect your account, go to your *Settings* dashboard and select *Connected
Services*. From here, you'll be able to connect to your GitHub, Bitbucket or GitLab
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe you can also just "login" with the accounts and it will connect them. This is probably the most explicit way of documenting doing it though 👍

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Signing up will connect them. I'll make that a bit more clear.

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.
151 changes: 0 additions & 151 deletions docs/getting_started.rst

This file was deleted.

Binary file added docs/img/first-steps/import-a-repository.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
113 changes: 62 additions & 51 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,69 +1,71 @@
Welcome to Read The Docs
========================
Read the Docs: Documentation Simplified
=======================================

`Read the Docs`_ hosts documentation for the open source community.
We support Sphinx_ docs written with reStructuredText_ and `CommonMark`_.
We pull your code from your Subversion_, Bazaar_, Git_, and Mercurial_ repositories.
Then we build documentation and host it for you.
`Read the Docs`_ simplifies software documentation
by automating building, versioning, and hosting of your docs for you.
Think of it as *Continuous Documentation*.

The code is open source, and `available on GitHub`_.
Never out of sync
Whenever you push code to your favorite version control system,
whether that is Git, Mercurial, Bazaar, or Subversion,
Read the Docs will automatically build your docs
so your code and documentation are always up-to-date.

Multiple versions
Read the Docs can host and build multiple versions of your docs
so having a 1.0 version of your docs and a 2.0 version
of your docs is as easy as having a separate branch or tag in your version control system.

Free and open source
Read the Docs is free and open source and hosts documentation
for nearly 100,000 large and small open source projects
in almost every human and computer language.

.. _Read the docs: http://readthedocs.org/
.. _Sphinx: http://sphinx.pocoo.org/
.. _reStructuredText: http://sphinx.pocoo.org/rest.html
.. _CommonMark: http://commonmark.org/
.. _Subversion: http://subversion.tigris.org/
.. _Bazaar: http://bazaar.canonical.com/
.. _Git: http://git-scm.com/
.. _Mercurial: https://www.mercurial-scm.org/
.. _available on GitHub: http://github.com/rtfd/readthedocs.org

The main documentation for the site is organized into a couple sections:

* :ref:`user-docs`
* :ref:`feature-docs`
* :ref:`about-docs`
First steps
-----------

Are you new to software documentation
or are you looking to use your existing docs with Read the Docs?
Learn about documentation authoring tools such as Sphinx and MkDocs
to help you create fantastic documentation for your project.

* **Getting started**:
:doc:`With Sphinx <intro/getting-started-with-sphinx>` |
:doc:`With MkDocs <intro/getting-started-with-mkdocs>`

Information about development is also available:
* **Importing your existing documentation**:
:doc:`Import guide <intro/import-guide>`

.. toctree::
:maxdepth: 2
:hidden:
:caption: First Steps

intro/getting-started-with-sphinx
intro/getting-started-with-mkdocs
intro/import-guide

* :ref:`dev-docs`
* :ref:`design-docs`

.. _user-docs:

.. toctree::
:maxdepth: 2
:caption: User Documentation

getting_started
versions
builds
features
connected-accounts
support
faq
yaml-config
guides/index
api/index
embed

.. _about-docs:

.. toctree::
:maxdepth: 2
:caption: About Read the Docs

contribute
team
gsoc
code-of-conduct
privacy-policy
advertising/index
sponsors
open-source-philosophy
story
abandoned-projects
dmca/index

.. _feature-docs:

Expand All @@ -86,11 +88,28 @@ Information about development is also available:
automatic-redirects
features/*

.. _about-docs:

.. toctree::
:maxdepth: 1
:caption: About Read the Docs

contribute
team
gsoc
code-of-conduct
privacy-policy
advertising/index
sponsors
open-source-philosophy
story
abandoned-projects
dmca/index

.. _dev-docs:

.. toctree::
:maxdepth: 2
:maxdepth: 1
:caption: Developer Documentation

changelog
Expand All @@ -105,6 +124,8 @@ Information about development is also available:
i18n
issue-labels
security
design
RTD Theme <https://sphinx-rtd-theme.readthedocs.io/en/latest/>
Copy link
Member

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.

Copy link
Contributor Author

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?

Copy link
Member

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.

Copy link
Contributor

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


.. _business-docs:

Expand All @@ -121,13 +142,3 @@ Information about development is also available:
:caption: Custom Install Documentation

custom_installs/index

.. _design-docs:

.. toctree::
:maxdepth: 2
:caption: Designer Documentation

design
Theme <https://sphinx-rtd-theme.readthedocs.io/en/latest/>

2 changes: 1 addition & 1 deletion docs/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -151,4 +151,4 @@ Importing your docs
One of the goals of readthedocs.org is to make it easy for any open source developer to get high quality hosted docs with great visibility!
Simply provide us with the clone URL to your repo, we'll pull your code, extract your docs, and build them!
We make available a post-commit webhook that can be configured to update the docs whenever you commit to your repo.
See our :doc:`getting_started` page to learn more.
See :doc:`/intro/import-guide` to learn more.
Loading