Skip to content
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

Docs: simplify "Add project" page #11559

Merged
merged 6 commits into from
Sep 12, 2024
Merged
Show file tree
Hide file tree
Changes from 4 commits
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
Binary file not shown.
Binary file not shown.
21 changes: 18 additions & 3 deletions docs/user/glossary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,21 @@ so that you have a reference for how we're using them.
In some scenarios, they exist as two separate platforms.
Read the Docs is a combined CI/CD platform made for documentation.

configuration file
YAML configuration file (e.g. ``.readthedocs.yaml``) to configure the build process of your project on Read the Docs.
humitos marked this conversation as resolved.
Show resolved Hide resolved

.. seealso::

:doc:`/config-file/index`
Practical steps to add a configuration file to your documentation project.


dashboard
The "admin" site where Read the Docs projects are managed and configured.
This varies for our two properties:

* |com_brand|: https://readthedocs.com/dashboard/.
* |org_brand|: https://readthedocs.org/dashboard/.
* |com_brand|: https://app.readthedocs.com/dashboard/
* |org_brand|: https://app.readthedocs.org/dashboard/

default version
Projects have a *default version*, usually the latest stable version of a project.
Expand Down Expand Up @@ -145,4 +154,10 @@ so that you have a reference for how we're using them.
* Git providers have webhooks which are special URLs that Read the Docs can call in order to notify about documentation builds.
* Read the Docs has a unique webhook for each project that the Git provider calls when changes happen in Git.

See also: :doc:`/guides/setup/git-repo-manual` and :doc:`/build-notifications`
.. seealso::

:doc:`/guides/setup/git-repo-manual`
Manually configuration for Git repositories.

:doc:`/build-notifications`
Receive notifications when your documentation builds fail.
2 changes: 1 addition & 1 deletion docs/user/guides/importing-private-repositories.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Here is how you set it up.

✅️ Logged in with |git_providers_or|?
If you signed up or logged in to Read the Docs with your |git_providers_or| credentials,
*all you have to do* is to use the normal :doc:`project import </intro/import-guide>`.
*all you have to do* is to use the normal :doc:`project import </intro/add-project>`.
Your Read the Docs account is connected to your Git provider and
will let you choose from private Git repositories and configure them for you.

Expand Down
6 changes: 3 additions & 3 deletions docs/user/guides/setup/git-repo-automatic.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ the integration will automatically be configured on the Read the Docs project an
Here is an outline of what happens:

#. A list of repositories that you have access to are automatically listed on Read the Docs' project import.
#. You choose a Git repository from the list (see :doc:`/intro/import-guide`).
#. You choose a Git repository from the list (see :doc:`/intro/add-project`).
#. Data about the repository is now fetched using the account connection and you are asked to confirm the setup.
#. When Read the Docs creates your project,
it automatically sets up an integration with the Git provider,
Expand Down Expand Up @@ -55,7 +55,7 @@ including the ones that were automatically created.

.. seealso::

:ref:`intro/import-guide:Manually import your docs`
:ref:`intro/add-project:Manually your project`
humitos marked this conversation as resolved.
Show resolved Hide resolved
Using a different provider?
Read the Docs still supports other providers such as Gitea or GitHub Enterprise.
In fact, any Git repository URL can be configured manually.
Expand All @@ -80,7 +80,7 @@ By granting Read the Docs the requested permissions,
we are issued a secret OAuth token from your Git provider.

Using the secret token,
we can automatically configure the repository that you select in the :doc:`project import </intro/import-guide>`.
we can automatically configure the repository that you select in the :doc:`project import </intro/add-project>`.
humitos marked this conversation as resolved.
Show resolved Hide resolved
We also use the token to send back build statuses and preview URLs for :doc:`pull requests </pull-requests>`.

.. _OAuth: https://en.wikipedia.org/wiki/OAuth
Expand Down
4 changes: 2 additions & 2 deletions docs/user/guides/setup/monorepo.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,10 @@ A custom build configuration file path is applied to all versions of your docume
Adding an additional project from the same repository
-----------------------------------------------------

Once you have added the first project from the :ref:`Import Wizard <intro/import-guide:Automatically import your docs>`,
Once you have added the first project from the :ref:`Import Wizard <intro/add-project:Automatically add your project>`,
it will show as if it has already been imported and cannot be imported again.
In order to add another project with the same repository,
you will need to use the :ref:`Manual Import <intro/import-guide:Manually import your docs>`.
you will need to use the :ref:`Manual Import <intro/add-project:Manually add your project>`.
Copy link
Contributor

Choose a reason for hiding this comment

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

I would update both of these to use "create"/"add"/etc instead of import, the docs they are pointing to don't use import.

Copy link
Member Author

Choose a reason for hiding this comment

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

Actually, this sentence needs to be updated since this limitation is removed.


Setting the custom build configuration file
-------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion docs/user/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Read the Docs: documentation simplified
/tutorial/index
/intro/getting-started-with-sphinx
/intro/getting-started-with-mkdocs
/intro/import-guide
/intro/add-project
/examples

.. toctree::
Expand Down
62 changes: 62 additions & 0 deletions docs/user/intro/add-project.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
Adding a documentation project
==============================

.. meta::
:description lang=en: Add your existing technical documentation from version control system into Read the Docs.
humitos marked this conversation as resolved.
Show resolved Hide resolved

This page drives you through the process to add a documentation project to Read the Docs.
humitos marked this conversation as resolved.
Show resolved Hide resolved
If you have :doc:`connected your Read the Docs account </guides/connecting-git-account>` to GitHub, Bitbucket or GitLab you will be able to add your project automatically.
Otherwise, you will need to add it manually and perform some extra steps.

Automatically add your project
------------------------------

#. Go to your :term:`dashboard`.
#. Click on :guilabel:`Add project`.
#. Type the name of the respository you want to add and click on it.
#. Click on :guilabel:`Continue`.
#. Edit any of the pre-filled fields with information of the repository.
#. Click on :guilabel:`Next`.
#. Add a :term:`configuration file` to your repository if it's doesn't exist yet.
#. Click on :guilabel:`This file exists`.

Manually add your project
-------------------------

#. Go to your :term:`dashboard`.
#. Click on :guilabel:`Add project`.
#. Click on :guilabel:`Configure manually`.
#. Click on :guilabel:`Continue`.
#. Fill all the fields of the form.
#. Click on :guilabel:`Next`.
#. Add a :term:`configuration file` to your repository if it's doesn't exist yet.
#. Click on :guilabel:`This file exists`.

Once your project is created, you'll need to manually configure the repository webhook if you would like to have new changes trigger builds for your project on Read the Docs.

.. seealso::

:doc:`/guides/setup/git-repo-manual`
Once you have imported your Git project, use this guide to manually set up basic and additional *webhook* integration.
humitos marked this conversation as resolved.
Show resolved Hide resolved


What's next
-----------

Once your documentation project was created, a build is triggered.
humitos marked this conversation as resolved.
Show resolved Hide resolved
It will automatically fetch the code from your repository and build the documentation.
You can see the logs for the build process from your :term:`dashboard`.

.. seealso::

:doc:`/builds`
Explanation about the build process.

:doc:`/config-file/index`
Practical steps to add a configuration file to your documentation project.

:doc:`/versions`
Manage multiple versions of your documentation project.

If you have any trouble, don't hesitate to reach out to us.
The :doc:`support </support>` page has more information on getting in touch.
4 changes: 2 additions & 2 deletions docs/user/intro/getting-started-with-mkdocs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ It has many great features including:
Quick start
-----------

.. seealso:: If you already have a Mkdocs project, check out our :doc:`/intro/import-guide` guide.
.. seealso:: If you already have a Mkdocs project, check out our :doc:`/intro/add-project` guide.

Assuming you have Python already, `install MkDocs`_:

Expand Down Expand Up @@ -59,7 +59,7 @@ You can make changes to your Markdown files and your docs will automatically reb
Your MkDocs project is built

Once you have your documentation in a public repository such as GitHub, Bitbucket, or GitLab,
you can start using Read the Docs by :doc:`importing your docs </intro/import-guide>`.
you can start using Read the Docs by :doc:`importing your docs </intro/add-project>`.
humitos marked this conversation as resolved.
Show resolved Hide resolved

.. _install MkDocs: https://www.mkdocs.org/user-guide/installation/

Expand Down
4 changes: 2 additions & 2 deletions docs/user/intro/getting-started-with-sphinx.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ check out :doc:`/tutorial/index`.
Quick start
-----------

.. seealso:: If you already have a Sphinx project, check out our :doc:`/intro/import-guide` guide.
.. seealso:: If you already have a Sphinx project, check out our :doc:`/intro/add-project` guide.

Assuming you have Python already, :doc:`install Sphinx <sphinx:usage/installation>`:

Expand Down Expand Up @@ -68,7 +68,7 @@ Open this file in your web browser to see your docs.

Edit your files and rebuild until you like what you see, then commit your changes and push to your public repository.
Once you have Sphinx documentation in a public repository, you can start using Read the Docs
by :doc:`importing your docs </intro/import-guide>`.
by :doc:`importing your docs </intro/add-project>`.
humitos marked this conversation as resolved.
Show resolved Hide resolved

.. warning::

Expand Down
93 changes: 0 additions & 93 deletions docs/user/intro/import-guide.rst

This file was deleted.

2 changes: 1 addition & 1 deletion docs/user/reference/git-integration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Connecting your account provides the following features:

🔁️ List your projects
Select a project to automatically import from all your Git repositories and organizations.
See: :doc:`/intro/import-guide`.
See: :doc:`/intro/add-project`.

⚙️ Automatic configuration
Have your Git repository automatically configured with your Read the Docs :term:`webhook`,
Expand Down
4 changes: 2 additions & 2 deletions docs/user/tutorials/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Tutorials
This is especially popular because of its default of using Markdown.
This tool is well-supported on our platform and that's why we have a tutorial.

⏩️ :doc:`/intro/import-guide`
⏩️ :doc:`/intro/add-project`
If you already wrote your documentation,
this guide will help you get started at the most natural point:
importing an existing documentation project.
Expand All @@ -39,6 +39,6 @@ Tutorials
/tutorial/index
/intro/getting-started-with-sphinx
/intro/getting-started-with-mkdocs
/intro/import-guide
/intro/add-project
/config-file/index
/examples