Skip to content

Add basic quick start docs#2085

Merged
nscuro merged 1 commit intomainfrom
quickstart-docs
Mar 15, 2026
Merged

Add basic quick start docs#2085
nscuro merged 1 commit intomainfrom
quickstart-docs

Conversation

@nscuro
Copy link
Member

@nscuro nscuro commented Mar 15, 2026

Description

Adds basic quick start docs.

Addressed Issue

N/A

Additional Details

N/A

Checklist

  • I have read and understand the contributing guidelines
  • This PR fixes a defect, and I have provided tests to verify that the fix is effective
  • This PR implements an enhancement, and I have provided tests to verify that it works as intended
  • This PR introduces changes to the database model, and I have updated the migration changelog accordingly
  • This PR introduces new or alters existing behavior, and I have updated the documentation accordingly

Signed-off-by: nscuro <nscuro@protonmail.com>
@nscuro nscuro added this to the 0.7.0 milestone Mar 15, 2026
@nscuro nscuro added the documentation Improvements or additions to documentation label Mar 15, 2026
Copilot AI review requested due to automatic review settings March 15, 2026 21:29
@owasp-dt-bot
Copy link

Snyk checks have passed. No issues have been found so far.

Status Scan Engine Critical High Medium Low Total (0)
Open Source Security 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a quick start guide with Docker Compose for getting Dependency-Track running locally, including a compose file and MkDocs configuration updates.

Changes:

  • New quick start documentation page with setup instructions for Linux/macOS and Windows
  • Docker Compose file defining apiserver, frontend, and PostgreSQL services
  • MkDocs config updated to add tabbed content support and the new nav entry

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.

File Description
mkdocs.yml Adds pymdownx.tabbed extension and quick start nav entry
docs/getting-started/quickstart.md New quick start guide with prerequisites, setup, and access instructions
docs/getting-started/docker-compose.quickstart.yml Docker Compose file for local deployment

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@nscuro nscuro merged commit d1b0644 into main Mar 15, 2026
9 checks passed
@nscuro nscuro deleted the quickstart-docs branch March 15, 2026 21:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants