chores & docs: clean up some inaccuracies in getting started (#2600)

miketheman · web-flow · commit 70a7ef6b363f · 2024-09-24T09:32:57.000-05:00
* 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 &lt;miketheman@gmail.com&gt;

* docs: staging site does not exist

Signed-off-by: Mike Fiedler &lt;miketheman@gmail.com&gt;

* docs: format the link to be clickable

Signed-off-by: Mike Fiedler &lt;miketheman@gmail.com&gt;

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

Signed-off-by: Mike Fiedler &lt;miketheman@gmail.com&gt;

* docs: remove version specificity

Signed-off-by: Mike Fiedler &lt;miketheman@gmail.com&gt;

---------

Signed-off-by: Mike Fiedler &lt;miketheman@gmail.com&gt;
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -1,5 +1,3 @@
-version: "3.9"
-
 services:
   postgres:
     image: postgres:15.3-bullseye
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -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
diff --git a/docs/source/install.md b/docs/source/install.md
@@ -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:
 
@@ -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:
 
@@ -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:

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,3 @@`
`1`		`-version: "3.9"`
`2`		`-`
`3`	`1`	`services:`
`4`	`2`	`postgres:`
`5`	`3`	`image: postgres:15.3-bullseye`