Clean up and extend documentation

* Fixes some broken hyperlinks * Removes the (outdated) "Home" page * Adds a "Getting Started" section with a general overview, and background of the project * Adds an overview of changes over DT v4 * Adds an initial guide for migrating from DT v4, or running both systems in parallel for evaluation Signed-off-by: nscuro <[email protected]>
DependencyTrack · Jul 1, 2024 · 6da3edd · 6da3edd
1 parent 67ec5b5
commit 6da3edd
Show file tree

Hide file tree

Showing 29 changed files with 545 additions and 735 deletions.
diff --git a/.github/images/demo_dtrack_configure-alert.png b/.github/images/demo_dtrack_configure-alert.png
diff --git a/.github/images/demo_dtrack_create-alert.png b/.github/images/demo_dtrack_create-alert.png
diff --git a/.github/images/demo_redpanda-console_consumer-groups_default-detailed.png b/.github/images/demo_redpanda-console_consumer-groups_default-detailed.png
diff --git a/.github/images/demo_redpanda-console_consumer-groups_default.png b/.github/images/demo_redpanda-console_consumer-groups_default.png
diff --git a/.github/images/demo_webhook_notifications.png b/.github/images/demo_webhook_notifications.png
diff --git a/.github/images/redpanda-console_messages.png b/.github/images/redpanda-console_messages.png
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -62,7 +62,8 @@ Please refer to our security policy in [`SECURITY.md`](./SECURITY.md) for how to
 Beside extending existing documentation or correcting any errors it may contain, another great way to contribute is to
 update the [FAQ](https://docs.dependencytrack.org/FAQ/) with questions and answers that benefit the community.
 
-Refer to the *Documentation* section of [`DEVELOPING.md`](./DEVELOPING.md) for a guide on how to build the documentation locally.
+Refer to the [*Documentation* development documentation](https://dependencytrack.github.io/hyades/latest/development/documentation/)
+for a guide on how to build the documentation locally.
 
 ## Testing Snapshot Versions
 
@@ -86,7 +87,8 @@ Before raising pull requests, please [file a defect](#reporting-defects) or [enh
 * Issues for which community contributions are explicitly requested are labeled with [`help wanted`](https://github.com/DependencyTrack/dependency-track/issues?q=is%3Aopen+label%3A%22help+wanted%22+).
 * Issues suitable for first-time contributors are labeled with [`good first issue`](https://github.com/DependencyTrack/dependency-track/issues?q=is%3Aopen+label%3A%22good+first+issue%22+).
 
-[`DEVELOPING.md`](./DEVELOPING.md) provides a detailed guide on how to get started with working on Dependency-Track.
+The [*Development* documentation](https://dependencytrack.github.io/hyades/latest/development/overview/)
+provides a detailed guide on how to get started with working on Dependency-Track.
 
 ### Pull Requests
 

diff --git a/DEVELOPING.md b/DEVELOPING.md
diff --git a/WTF.md b/WTF.md