Skip to content

Commit c765102

Browse files
committed
Update docs
1 parent 9fbba4f commit c765102

File tree

1 file changed

+10
-28
lines changed

1 file changed

+10
-28
lines changed

docs/development/getting-started.rst

+10-28
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
@@ -148,12 +148,6 @@ run all of the needed services. The Warehouse repository will be mounted inside
148148
the Docker container at :file:`/opt/warehouse/src/`. After the initial build,
149149
you should not have to run this command again.
150150

151-
.. note::
152-
153-
On some systems ``make build`` may require the prior installation of libpq
154-
and its headers so that psycopg2 can be compiled and installed.
155-
156-
157151
.. _running-warehouse-containers:
158152

159153
Running the Warehouse container and services
@@ -332,21 +326,6 @@ Errors when executing ``make build``
332326
333327
snap install docker
334328
335-
* If you receive the error: ``python3.8: command not found``, ensure you have
336-
Python 3.8 installed on your system.
337-
This is the "base" Python version that Warehouse uses to create the rest of
338-
the development environment.
339-
340-
* If you are using macOS and you see an
341-
``Error: pg_config executable not found.`` message while building ``psycopg``,
342-
you can fix it by installing ``libpq`` via ``brew`` and adding it to your
343-
``PATH``:
344-
345-
.. code-block:: console
346-
347-
brew install libpq
348-
export PATH="/usr/local/opt/libpq/bin:$PATH"
349-
350329
Errors when executing ``make serve``
351330
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
352331

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

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

418400
``make initdb`` complains about PostgreSQL Version
419401
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

0 commit comments

Comments
 (0)