Merge pull request Uninett#2978 from hmpf/improve-dev-with-docker-docs

Improve docs for developing with docker
johannaengland · Sep 17, 2024 · 2d9827d · 2d9827d
2 parents 08741f4 + 7e83964
commit 2d9827d
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 0 deletions.
diff --git a/README.rst b/README.rst
@@ -53,6 +53,10 @@ For detailed instructions on how to install NAV, see
 `<doc/intro/install.rst>`_. See the file `<NOTES.rst>`_ for release notes and
 upgrade instructions.
 
+Take it for a quick spin
+------------------------
+For instruction on how to use docker to run code straight from the repo, see
+`<doc/hacking/using-docker.rst>`_.  Please be aware, though, that this is a highly developer-oriented environment, and is not suitable for production use. 
 
 Contributing
 ------------

diff --git a/changelog.d/2978.changed.md b/changelog.d/2978.changed.md
@@ -0,0 +1,2 @@
+Link to the doc for using docker for development from the readme and
+mention what ports are used when using docker for dev.
diff --git a/doc/hacking/using-docker.rst b/doc/hacking/using-docker.rst
@@ -41,6 +41,10 @@ the first time is by running these commands::
          coffee (and maybe redecorate your living room), as the initial build
          may take a while.
 
+.. warning:: Running ``docker compose up`` will take over the local ports 80
+             (for the website) and 8000 (for graphite). You can override this
+             with a ``docker-compose.override.yml`` file.
+
 Troubleshooting
 ~~~~~~~~~~~~~~~