Skip to content

Commit 68376b6

Browse files
markdown docs: fix dead links (#11878)
* DOCKER.md: fix dead links * CONTRIBUTING.md: fix dead links * RELEASING.md: Fix broken links * README.md: update link to feature freeze latest news * Update readme-docs/DOCKER.md Co-authored-by: Harold Blankenship <36673698+hblankenship@users.noreply.github.com> --------- Co-authored-by: Harold Blankenship <36673698+hblankenship@users.noreply.github.com>
1 parent cd18539 commit 68376b6

File tree

4 files changed

+11
-7
lines changed

4 files changed

+11
-7
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ our channel there, [#defectdojo](https://owasp.slack.com/channels/defectdojo). F
109109

110110
:warning: We have instituted a [feature freeze](https://github.com/DefectDojo/django-DefectDojo/discussions/8002) on v2
111111
of DefectDojo as we begin work on v3. Please see our [contributing guidelines](readme-docs/CONTRIBUTING.md) for more
112-
information. Check out our latest update on v3 [here](https://github.com/DefectDojo/django-DefectDojo/discussions/8974).
112+
information. Check out our latest update on v3 [here](https://github.com/DefectDojo/django-DefectDojo/discussions/11199).
113113

114114
## Pro Edition
115115
[Upgrade to DefectDojo Pro](https://www.defectdojo.com/) today to take your DevSecOps to 11. DefectDojo Pro is

readme-docs/CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ for approval, please file an issue to get pre-approval before beginning work on
3131
`enhancement-approved` label to your issue and you can begin building it out.
3232

3333
Below are some representative examples of what we will and won't support going forward. If you have suggestions or other
34-
feedback, please let us know in the `#defectdojo` channel in [OWASP's Slack](https://owasp-slack.herokuapp.com/).
34+
feedback, please let us know in the `#defectdojo` channel in [OWASP's Slack](https://owasp.org/slack/invite).
3535

3636
**Acceptable examples:**
3737

@@ -54,7 +54,7 @@ feedback, please let us know in the `#defectdojo` channel in [OWASP's Slack](htt
5454

5555
## Writing a New Parser
5656

57-
Please see [the parser guide](https://documentation.defectdojo.com/en/open_source/contributing/how-to-write-a-parser/) for guidance on how to write a parser.
57+
Please see [the parser guide](https://docs.defectdojo.com/en/open_source/contributing/how-to-write-a-parser/) for guidance on how to write a parser.
5858

5959
## Modifying DefectDojo and Testing
6060

@@ -102,4 +102,4 @@ During the review process, one or more reviewers may provide feedback on your ch
102102
Requested changes from reviewers should stay within the scope of the PR.
103103
Please do not resolve comments without any discussion. If you decide not to make a suggested change,
104104
make sure to leave a brief reply as a response so that everyone
105-
is on the same page. The reviewer can then resolve the comment if the reasoning is acceptable.
105+
is on the same page. The reviewer can then resolve the comment if the reasoning is acceptable.

readme-docs/DOCKER.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,11 @@
22

33
The docker-compose.yml file in this repository is fully functional to evaluate DefectDojo in your local environment.
44

5-
Although Docker Compose is one of the supported installation methods to deploy a containerized DefectDojo in a production environment, the docker-compose.yml file is not intended for production use without first customizing it to your particular situation. [Running in Production](https://documentation.defectdojo.com/getting_started/running-in-production/) gives advice on which adjustments are useful for performance and operational reliability.
5+
Although Docker Compose is one of the supported installation methods to deploy a containerized DefectDojo in a production environment, the docker-compose.yml file is not intended for production use without first customizing it to your particular situation.
6+
7+
[Running in Production](https://docs.defectdojo.com/en/open_source/installation/running-in-production/) gives advice on which adjustments are useful for performance and operational reliability.
8+
9+
[Configuration](https://docs.defectdojo.com/en/open_source/installation/configuration/) explains the different ways to adjust settings and environment variables.
610

711

812
# Prerequisites
@@ -147,7 +151,7 @@ docker exec -it django-defectdojo-uwsgi-1 ./manage.py changepassword admin
147151
```
148152

149153
# Logging
150-
For docker compose release mode the log level is INFO. In the other modes the log level is DEBUG. Logging is configured in `settings.dist.py` and can be tuned using a `local_settings.py`, see [template for local_settings.py](dojo/settings/template-local_settings). For example the deduplication logger can be set to DEBUG in a local_settings.py file:
154+
For docker compose release mode the log level is INFO. In the other modes the log level is DEBUG. Logging is configured in `settings.dist.py` and can be tuned using a `local_settings.py`, see [template for local_settings.py](../dojo/settings/template-local_settings)). For example the deduplication logger can be set to DEBUG in a local_settings.py file:
151155

152156

153157
```

readme-docs/RELEASING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ The steps are identical for both release types, unless specified otherwise below
3232
- Merge the PRs
3333

3434
### Always
35-
- Make sure there's a section in [upgrading.md](https://documentation.defectdojo.com/dev/getting_started/upgrading/) about any specific instructions when upgrading to this new release.
35+
- Make sure there's a section in [upgrading.md](../docs/content/en/open_source/upgrading) about any specific instructions when upgrading to this new release.
3636

3737
- Remove existing draft releases with the same version number
3838
Due to the release drafter being a non-perfect match for our git flow based release process, we have to delete any draft that has already been created by the release drafter if it has the same versio number. This is probably not needed if you're doing a bugfix release.

0 commit comments

Comments
 (0)