Skip to content

Commit 7c2bf39

Browse files
lwassermikethemandi
authored
fix: minor edits to make dev docs a bit more clear (#17382)
Co-authored-by: Mike Fiedler <[email protected]> Co-authored-by: Dustin Ingram <[email protected]>
1 parent c477e43 commit 7c2bf39

File tree

1 file changed

+32
-14
lines changed

1 file changed

+32
-14
lines changed

docs/dev/development/getting-started.rst

Lines changed: 32 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,11 @@ improve the process:
3030
Detailed installation instructions
3131
----------------------------------
3232

33-
Getting the Warehouse source code
34-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
33+
Get the Warehouse source code
34+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
35+
36+
First, fork and clone the Warehouse source code to work on it locally.
37+
3538
`Fork <https://docs.github.com/en/get-started/quickstart/fork-a-repo>`_ the repository
3639
on `GitHub`_ and
3740
`clone <https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository>`_ it to
@@ -54,25 +57,36 @@ you stay up-to-date with our repository:
5457
git merge upstream/main
5558
5659
57-
Configure the development environment
58-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
60+
Create your development environment
61+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
5962

6063
.. note::
61-
In case you are used to using a virtual environment for Python development:
62-
it's unnecessary for Warehouse development. Our Makefile scripts execute all
63-
developer actions inside Docker containers.
64+
Warehouse development can be done using Makefile scripts which
65+
execute all developer actions inside Docker containers. You do
66+
not need to create a Python virtual environment.
6467

65-
Verifying Make Installation
66-
~~~~~~~~~~~~~~~~~~~~~~~~~~~
68+
Verify that you have Make installed
69+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
6770

68-
Verify that you have make installed in your environment
71+
We use Make to build the docs and the Warehouse site.
72+
Verify that you have Make installed in your environment.
6973

7074
.. code-block:: console
7175
7276
make --version
7377
74-
If you do not have it installed,
75-
consult your OS documentation on how to install ``make``.
78+
If you do not have ``Make`` installed,
79+
consult your operating system documentation on how to install ``make``.
80+
81+
82+
Do you want to build the docs or the Warehouse site?
83+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
84+
85+
If you wish to build the entire Warehouse site,
86+
use Docker and follow the instructions below. However, if you are only
87+
contributing to the user or development documentation, then you can skip
88+
setting up Docker below and use ``Make`` instead. To build the docs,
89+
follow the `instructions here <#build-docs>`_.
7690

7791

7892
Why Docker?
@@ -733,13 +747,17 @@ formatting and linting. You can reformat with:
733747
734748
make reformat
735749
750+
.. _build-docs:
736751

737752
Building documentation
738753
----------------------
739754

740755
The Warehouse documentation is stored in the :file:`docs/`
741-
directory. It is written in `reStructured Text`_ and rendered using
742-
`Sphinx`_.
756+
directory with three subdirectories: blog, dev and user.
757+
Development docs (in the dev directory) are written in
758+
`reStructured Text`_ and rendered using `Sphinx`_. User docs ``/user``
759+
are written in markdown and rendered using ``mkdocs``. The blog is
760+
also written in markdown.
743761

744762
Use :command:`make` to build the documentation. For example:
745763

0 commit comments

Comments
 (0)