Skip to content

Commit

Permalink
chores & docs: clean up some inaccuracies in getting started (#2600)
Browse files Browse the repository at this point in the history
* chore: remove obsolete version entry from compose

Currently raises a warning:

   the attribute `version` is obsolete, it will be ignored,
   please remove it to avoid potential confusion

Signed-off-by: Mike Fiedler <[email protected]>

* docs: staging site does not exist

Signed-off-by: Mike Fiedler <[email protected]>

* docs: format the link to be clickable

Signed-off-by: Mike Fiedler <[email protected]>

* docs: use what's currently in docker-compose.yml

Signed-off-by: Mike Fiedler <[email protected]>

* docs: remove version specificity

Signed-off-by: Mike Fiedler <[email protected]>

---------

Signed-off-by: Mike Fiedler <[email protected]>
  • Loading branch information
miketheman authored Sep 24, 2024
1 parent a84a53a commit 70a7ef6
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 6 deletions.
2 changes: 0 additions & 2 deletions docker-compose.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
version: "3.9"

services:
postgres:
image: postgres:15.3-bullseye
Expand Down
1 change: 0 additions & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ General information
:Issue tracker: https://github.com/python/pythondotorg/issues
:Mailing list: pydotorg-www_
:IRC: ``#pydotorg`` on Freenode
:Staging site: https://staging.python.org/ (``main`` branch)
:Production configuration: https://github.com/python/psf-salt
:GitHub Actions:
.. image:: https://github.com/python/pythondotorg/actions/workflows/ci.yml/badge.svg
Expand Down
6 changes: 3 additions & 3 deletions docs/source/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ web_1 | Starting development server at http://0.0.0.0:8000/
web_1 | Quit the server with CONTROL-C.
```

You can view these results in your local web browser at: `http://localhost:8000`
You can view these results in your local web browser at: <http://localhost:8000>

To reset your local environment, run:

Expand Down Expand Up @@ -88,7 +88,7 @@ This is a simple wrapper around running `python manage.py` in the container, all
Manual setup
------------

First, install [PostgreSQL](https://www.postgresql.org/download/) on your machine and run it. *pythondotorg* currently uses Postgres 10.21.
First, install [PostgreSQL](https://www.postgresql.org/download/) on your machine and run it. *pythondotorg* currently uses Postgres 15.x.

Then clone the repository:

Expand All @@ -99,7 +99,7 @@ $ git clone git://github.com/python/pythondotorg.git
Then create a virtual environment:

```
$ python3.9 -m venv venv
$ python3 -m venv venv
```

And then you'll need to install dependencies. You don't need to use `pip3` inside a Python 3 virtual environment:
Expand Down

0 comments on commit 70a7ef6

Please sign in to comment.