Migrate quickstart docs#17
Conversation
Migrates the quickstart docs from https://github.com/DependencyTrack/hyades/blob/0.7.0-alpha.3/docs/getting-started/quickstart.md Signed-off-by: nscuro <nscuro@protonmail.com>
There was a problem hiding this comment.
Pull request overview
This PR migrates a “Quick start” tutorial into this documentation site, including a Docker Compose example stack, and updates the site/tooling configuration to support the new tutorial’s formatting and linting needs.
Changes:
- Add a new Quick start tutorial page and accompanying Docker Compose file.
- Enable
pymdownx.emojiin MkDocs to render Material icon/emoji shortcodes used in the tutorial. - Adjust Vale configuration/vocabulary to accommodate tutorial writing style and new terminology.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
mkdocs.yml |
Enables pymdownx.emoji for Material icon/emoji shortcodes used in the tutorial tabs. |
docs/tutorials/quickstart.md |
Adds the new Quick start tutorial content and references the compose file via snippets. |
docs/tutorials/docker-compose.quickstart.yml |
Introduces a compose file used by the quickstart instructions. |
docs/index.md |
Adds a prominent link to the new quick start tutorial. |
.vale/styles/config/vocabularies/DependencyTrack/accept.txt |
Adds “Podman” to accepted vocabulary. |
.vale.ini |
Disables “We/Will” Vale rules for tutorials to match the tutorial voice. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| volumes: | ||
| - "postgres-data:/var/lib/postgresql/data" |
There was a problem hiding this comment.
YAML sequence indentation under volumes is incorrect (list items are not indented). This violates the repository’s yamllint rule (indent-sequences: false) and should be fixed by indenting the - ... entries under volumes.
| restart: unless-stopped | ||
|
|
||
| postgres: | ||
| image: postgres:18-alpine |
There was a problem hiding this comment.
The quickstart Compose file pins PostgreSQL to postgres:18-alpine, but the docs’ dev-services defaults currently reference postgres:14-alpine (see docs/reference/configuration/properties.md). Using a newer major here may be unsupported and could make the quickstart fail for users. Consider aligning this image tag with the documented/supported PostgreSQL version (or clearly documenting the required PostgreSQL version for this quickstart).
| image: postgres:18-alpine | |
| image: postgres:14-alpine |
| volumes: | ||
| - "apiserver-data:/data" | ||
| restart: unless-stopped |
There was a problem hiding this comment.
YAML sequence indentation under volumes is incorrect here (the - apiserver-data:/data entry is not indented). This violates the repository’s yamllint rule (indent-sequences: false) and should be fixed by indenting list items under volumes.
|
|
||
| ## What we need | ||
|
|
||
| - [Docker](https://docs.docker.com/get-docker/) or [Podman](https://podman.io/) |
There was a problem hiding this comment.
The prerequisites mention Podman, but the next requirement and the commands are explicitly Docker Compose v2 (docker compose) and link to Docker’s Compose installation docs. This is confusing for Podman users and may not work as written. Consider either removing Podman from the prerequisites or adding Podman-specific install/commands (e.g., podman compose/podman-compose) and links.
| - [Docker](https://docs.docker.com/get-docker/) or [Podman](https://podman.io/) | |
| - [Docker](https://docs.docker.com/get-docker/) |
| ports: | ||
| - "127.0.0.1:8080:8080" | ||
| volumes: | ||
| - "apiserver-data:/data" |
There was a problem hiding this comment.
YAML sequence indentation under ports is invalid for this repo’s yamllint config (indent-sequences: false) and may also break Compose parsing. Indent the list items under ports.
| ports: | ||
| - "127.0.0.1:8081:8080" | ||
| restart: unless-stopped |
There was a problem hiding this comment.
YAML sequence indentation under ports is incorrect (list items are not indented). This violates the repository’s yamllint rule (indent-sequences: false) and should be fixed by indenting the - ... entries under ports.
Migrates the quickstart docs from https://github.com/DependencyTrack/hyades/blob/0.7.0-alpha.3/docs/getting-started/quickstart.md