Skip to content

Commit 5fd864f

Browse files
nscuronscuro
committed
Create foundation
Adds a foundation for the new documentation page, based on Material for MkDocs. Includes linters for YAML, Markdown, and prose to ensure consistency across multiple contributors, and to help guide agents for AI-assisted contributions. Signed-off-by: nscuro <nscuro@protonmail.com>
1 parent da8fe5d commit 5fd864f

48 files changed

Lines changed: 1747 additions & 2 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.dockerignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
*
2+
!Dockerfile
3+
!requirements.txt

‎.github/dependabot.yml‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# This file is part of Dependency-Track.
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
#
15+
# SPDX-License-Identifier: Apache-2.0
16+
# Copyright (c) OWASP Foundation. All Rights Reserved.
17+
version: 2
18+
updates:
19+
- package-ecosystem: pip
20+
directory: /
21+
schedule:
22+
interval: weekly
23+
cooldown:
24+
default-days: 7
25+
- package-ecosystem: docker
26+
directory: /
27+
schedule:
28+
interval: weekly
29+
cooldown:
30+
default-days: 7
31+
- package-ecosystem: github-actions
32+
directory: /
33+
schedule:
34+
interval: weekly
35+
cooldown:
36+
default-days: 7

‎.github/workflows/docs.yml‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
# This file is part of Dependency-Track.
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
#
15+
# SPDX-License-Identifier: Apache-2.0
16+
# Copyright (c) OWASP Foundation. All Rights Reserved.
17+
name: docs
18+
19+
on:
20+
push:
21+
branches: [main]
22+
tags: ["v[0-9]+.[0-9]+.[0-9]+"]
23+
pull_request:
24+
branches: [main]
25+
26+
permissions: {}
27+
28+
jobs:
29+
lint:
30+
runs-on: ubuntu-latest
31+
if: github.event_name == 'pull_request'
32+
steps:
33+
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
34+
with:
35+
persist-credentials: false
36+
- name: Lint Markdown
37+
run: make lint-markdown
38+
- name: Lint YAML
39+
run: make lint-yaml
40+
- name: Lint prose
41+
run: make lint-prose
42+
- name: Build
43+
run: make build
44+
45+
deploy:
46+
runs-on: ubuntu-latest
47+
if: github.event_name == 'push'
48+
permissions:
49+
contents: write
50+
steps:
51+
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
52+
with:
53+
fetch-depth: 0
54+
persist-credentials: false
55+
- name: Configure git
56+
run: |
57+
git config user.name "github-actions[bot]"
58+
git config user.email "github-actions[bot]@users.noreply.github.com"
59+
git remote set-url origin "https://x-access-token:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git"
60+
env:
61+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
62+
- name: Set up Python
63+
uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405 # v6.2.0
64+
with:
65+
python-version: "3.14"
66+
- name: Install dependencies
67+
run: pip install mike "mkdocs-material[imaging]==9.6.*" -r requirements.txt
68+
- name: Deploy next
69+
if: github.ref == 'refs/heads/main'
70+
run: mike deploy --push next
71+
- name: Deploy release
72+
if: startsWith(github.ref, 'refs/tags/v')
73+
run: |
74+
TAG="${GITHUB_REF#refs/tags/v}"
75+
MINOR="${TAG%.*}"
76+
mike deploy --push --update-aliases "$MINOR" latest
77+
mike set-default --push latest

‎.github/workflows/zizmor.yml‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# This file is part of Dependency-Track.
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
#
15+
# SPDX-License-Identifier: Apache-2.0
16+
# Copyright (c) OWASP Foundation. All Rights Reserved.
17+
name: zizmor
18+
19+
on:
20+
push:
21+
branches: [main]
22+
pull_request:
23+
branches: ["**"]
24+
25+
permissions: {}
26+
27+
jobs:
28+
zizmor:
29+
runs-on: ubuntu-latest
30+
permissions:
31+
security-events: write
32+
contents: read
33+
actions: read
34+
steps:
35+
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
36+
with:
37+
persist-credentials: false
38+
- name: Run zizmor
39+
uses: zizmorcore/zizmor-action@b1d7e1fb5de872772f31590499237e7cce841e8e # v0.5.3

‎.gitignore‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
site/
2+
.cache/
3+
__pycache__/
4+
*.pyc
5+
.DS_Store
6+
7+
# Vale downloaded styles (synced via `vale sync`)
8+
.vale/styles/*
9+
!.vale/styles/config/
10+
!.vale/styles/DependencyTrack/
11+
12+
# Source repos (for reference, not committed)
13+
source/*
14+
!source/.gitkeep
15+
!source/README.md
16+
existing-docs/*
17+
!existing-docs/.gitkeep
18+
!existing-docs/README.md
19+
20+
# IntelliJ
21+
.idea/*
22+
!.idea/icon.svg

‎.idea/icon.svg‎

Lines changed: 15 additions & 0 deletions
Loading

‎.markdownlint-cli2.yaml‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# This file is part of Dependency-Track.
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
#
15+
# SPDX-License-Identifier: Apache-2.0
16+
# Copyright (c) OWASP Foundation. All Rights Reserved.
17+
config:
18+
heading-style:
19+
style: atx
20+
line-length: false
21+
single-h1: false
22+
no-inline-html: false
23+
no-duplicate-heading:
24+
siblings_only: true
25+
26+
globs:
27+
- "docs/**/*.md"
28+
- "context/**/*.md"
29+
30+
ignores:
31+
- "docs/includes/**"
32+
- "existing-docs/**"
33+
- "site/**"
34+
- "node_modules/**"

‎.vale.ini‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# This file is part of Dependency-Track.
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
#
15+
# SPDX-License-Identifier: Apache-2.0
16+
# Copyright (c) OWASP Foundation. All Rights Reserved.
17+
18+
StylesPath = .vale/styles
19+
MinAlertLevel = warning
20+
Vocab = DependencyTrack
21+
22+
Packages = Google, write-good
23+
24+
[docs/*.md]
25+
BasedOnStyles = Vale, Google, write-good, DependencyTrack
26+
27+
[docs/**/*.md]
28+
BasedOnStyles = Vale, Google, write-good, DependencyTrack
29+
30+
# MkDocs abbreviation syntax (*[ABBR]: Definition) triggers false positives
31+
# for the colon capitalization rule, since `: ` is a syntax delimiter.
32+
[docs/includes/abbreviations.md]
33+
Google.Colons = NO

‎.vale/styles/DependencyTrack/AIBuzzwords.yml‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# This file is part of Dependency-Track.
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
#
15+
# SPDX-License-Identifier: Apache-2.0
16+
# Copyright (c) OWASP Foundation. All Rights Reserved.
17+
extends: existence
18+
message: "Avoid overused term '%s'. Use a more specific word."
19+
ignorecase: true
20+
level: warning
21+
tokens:
22+
- leverage
23+
- leveraging
24+
- leverages
25+
- leveraged
26+
- seamless
27+
- seamlessly
28+
- robust
29+
- comprehensive
30+
- streamline
31+
- streamlined
32+
- streamlining
33+
- empower
34+
- empowers
35+
- empowering
36+
- cutting-edge
37+
- holistic
38+
- synergy
39+
- harness
40+
- harnessing
41+
- harnesses
42+
- delve
43+
- delves
44+
- delving
45+
- landscape
46+
- tapestry
47+
- multifaceted
48+
- intricate
49+
- pivotal
50+
- paramount
51+
- underscores
52+
- underscore

‎.vale/styles/DependencyTrack/AIFillerPhrases.yml‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# This file is part of Dependency-Track.
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
#
15+
# SPDX-License-Identifier: Apache-2.0
16+
# Copyright (c) OWASP Foundation. All Rights Reserved.
17+
extends: existence
18+
message: "Avoid filler phrase '%s'. Be direct."
19+
ignorecase: true
20+
level: warning
21+
tokens:
22+
- it is important to note
23+
- it is worth noting
24+
- it's important to note
25+
- it's worth noting
26+
- it should be noted
27+
- it bears mentioning
28+
- this is because
29+
- this means that
30+
- this is due to the fact
31+
- as mentioned earlier
32+
- as noted above
33+
- as previously mentioned
34+
- as discussed
35+
- at the end of the day
36+
- in today's world
37+
- when it comes to
38+
- plays a crucial role
39+
- plays a vital role
40+
- plays an important role
41+
- plays a key role

0 commit comments

Comments
 (0)