1.10: settings.py refactor (#148)

* 1.10: settings.py refactor * Update getting-started.rst * Update getting-started.rst * Update api-docs.rst * Update api-docs.rst * Update settings-docs.rst * Update getting-started.rst * Update api-docs.rst * Update api-docs.rst * Update getting-started.rst * Update api-docs.rst * Update upgrading.rst * Update upgrading.rst add breaking change section Co-authored-by: Fred Blaise <madchap@users.noreply.github.com>
DefectDojo · Nov 24, 2020 · fd7d623 · fd7d623
1 parent 7931ca5
commit fd7d623
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 7 deletions.
diff --git a/docs/api-docs.rst b/docs/api-docs.rst
@@ -2,8 +2,8 @@ DefectDojo API Documentation
 ============================
 
 .. warning::
-   API v1 is deprecated and EOS is on 12-31-2020.
-   EOL is on 06-30-2021.
+   API v1 is deprecated and will be no longer maintained after 12-31-2020.
+   API v1 will be removed on 06-30-2021.
    Please move to API v2 and raise issues for any unsupported operations.
 
 

diff --git a/docs/getting-started.rst b/docs/getting-started.rst
@@ -5,20 +5,24 @@ Docker Compose Install (recommended)
 ************************************
 * Go to https://github.com/DefectDojo/django-DefectDojo
 * Select the appropriate branch you're working on
-* Instructions in the `DOCKER.md` file at the root of the repository.
+* Instructions in the [`DOCKER.md`](https://github.com/DefectDojo/django-DefectDojo/blob/master/DOCKER.md) file at the root of the repository.
 
 Kubernetes
 **********
 * Go to https://github.com/DefectDojo/django-DefectDojo
 * Select the appropriate branch you're working on
-* Instructions in the `KUBERNETES.md` file at the root of the repository.
+* Instructions in the [`KUBERNETES.md`](https://github.com/DefectDojo/django-DefectDojo/blob/master/KUBERNETES.md) file at the root of the repository.
 
-Setup.bash Install 
-******************
+Setup.bash Install (no longer maintained)
+*****************************************
 .. warning::
-   This installation method will be EOL on 2020-12-31
+   This installation method will is EOL and will be removed on 2020-12-31
 
 * Go to https://github.com/DefectDojo/django-DefectDojo
 * Select the appropriate branch you're working on
 * Under "Installation Options" click "Setup.bash"
 * Follow the instructions
+
+Customizing settings
+********************
+See [Settings](settings-docs.rst)
diff --git a/docs/settings-docs.rst b/docs/settings-docs.rst
@@ -1,6 +1,8 @@
 DefectDojo settings.py variables
 ================================
 
+For more info on custom settings and use of custom settings during development, please see: [settings.py documentation](https://github.com/DefectDojo/django-DefectDojo/blob/master/dojo/settings/settings.py) and [extra settings](https://github.com/DefectDojo/django-DefectDojo/blob/master/docker/extra_settings/README.md)
+
 .. note::
    To complete
 

diff --git a/docs/upgrading.rst b/docs/upgrading.rst
@@ -41,7 +41,18 @@ Upgrade Celery to the latest version:
 
     ``pip install --upgrade celery``
 
+Upgrading to DefectDojo Version 1.10.0
+--------------------------------------
+**What's New:**
+
+- See release notes: https://github.com/DefectDojo/django-DefectDojo/releases
+- Defect Dojo now provides a `settings.py` file out-of-the-box. Custom settings need to go into `local_settings.py`. See https://github.com/DefectDojo/django-DefectDojo/blob/master/dojo/settings/settings.py and https://github.com/DefectDojo/django-DefectDojo/blob/master/docker/extra_settings/README.md
+- A quickfix is to rename your own / customized `settings.py` or `settings.dist.py` to `local_settings.py`. 
+- Details of that PR: https://github.com/DefectDojo/django-DefectDojo/pull/3136
+
+**Breaking changes**
 
+Kubernetes/Helm users: we have moved away from the "stable" repository to "bitnami" in this release. The bitnami postgresql chart required us to add a new key to the postgresql secret, which will give you the error ``postgresql-postgres-password is missing`` if you have ``createPostgresqlSecret: false``. Other cases should work fine.
 
 Upgrading to DefectDojo Version 1.9.3
 -------------------------------------