Skip to content

Commit ec04074

Browse files
committed
Update docs
1 parent 81f1940 commit ec04074

File tree

1 file changed

+10
-22
lines changed

1 file changed

+10
-22
lines changed

docs/development/getting-started.rst

Lines changed: 10 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -58,20 +58,20 @@ Configure the development environment
5858
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
5959

6060
.. note::
61-
In case you are used to using a venv/virtualenv or virtual environment for Python development:
62-
don't use one for warehouse development. Our Makefile scripts and Docker container development flow
63-
creates and removes virtualenvs as needed while you are building and testing your work locally.
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.
6464

6565
Why Docker?
6666
~~~~~~~~~~~
6767

6868
Docker simplifies development environment set up.
6969

7070
Warehouse uses Docker and `Docker Compose <https://docs.docker.com/compose/>`_
71-
to automate setting up a "batteries included" development environment.
72-
The Dockerfile and :file:`docker-compose.yml` files include all the required steps
73-
for installing and configuring all the required external services of the
74-
development environment.
71+
to automate setting up a "batteries included" development environment. The
72+
:file:`Dockerfile` and :file:`docker-compose.yml` files include all the
73+
required steps for installing and configuring all the required external
74+
services of the development environment.
7575

7676

7777
Installing Docker
@@ -327,21 +327,6 @@ Errors when executing ``make build``
327327
328328
snap install docker
329329
330-
* If you receive the error: ``python3.8: command not found``, ensure you have
331-
Python 3.8 installed on your system.
332-
This is the "base" Python version that Warehouse uses to create the rest of
333-
the development environment.
334-
335-
* If you are using macOS and you see an
336-
``Error: pg_config executable not found.`` message while building ``psycopg``,
337-
you can fix it by installing ``libpq`` via ``brew`` and adding it to your
338-
``PATH``:
339-
340-
.. code-block:: console
341-
342-
brew install libpq
343-
export PATH="/usr/local/opt/libpq/bin:$PATH"
344-
345330
Errors when executing ``make serve``
346331
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
347332

@@ -409,6 +394,9 @@ This typically occur when Docker is not allocated enough memory to perform the
409394
migrations. Try modifying your Docker configuration to allow more RAM for each
410395
container, temporarily stop ``make_serve`` and run ``make initdb`` again.
411396

397+
This may also be due to enabling Compose V2 (see
398+
https://github.com/pypa/warehouse/issues/10772 for more details).
399+
412400

413401
``make initdb`` complains about PostgreSQL Version
414402
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

0 commit comments

Comments
 (0)