Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions .github/workflows/check-mkdocs-uris.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
name: Check MkDocs URIs

on:
pull_request:
push:
branches:
- main

jobs:
check-mkdocs-uris:
name: Validate MkDocs URIs
runs-on: ubuntu-latest

steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r requirements.txt

- name: Disable git-committers plugin in CI
# The git-committers plugin is not CI-safe:
# it performs GitHub API calls even without an explicit token,
# which causes 403 rate-limit errors in GitHub Actions.
# We remove the plugin block entirely for CI builds.
run: |
sed -i '/- git-committers:/,/^[[:space:]]*-[[:space:]]/d' mkdocs.yml

- name: Check for underscores in MkDocs URIs
run: |
echo "Checking mkdocs.yml for URIs (use '-' instead of '_')"

INVALID_PATHS=$(grep '.md' mkdocs.yml | grep '_' | grep -Ev 'pymdownx\.superfences|md_in_html' || true)

if [ -n "$INVALID_PATHS" ]; then
echo "❌ Invalid MkDocs URIs detected (use '-' instead of '_'):"
echo "$INVALID_PATHS" | sed 's/^/ - /'
echo "Required format:"
echo "usage/scenarios_and_simulations.md -> usage/scenarios-and-simulations.md"
exit 1
else
echo "✅ All MkDocs URIs are clean (no underscores)."
fi
2 changes: 1 addition & 1 deletion docs/deployment/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ docker compose up -d

This section provides instructions to install and run a pre-built OpenAEV server with its dependencies. Note that this
does not cover building from source,
which you will find in the [Development section](../development/build_from_source.md) instead.
which you will find in the [Development section](../development/build-from-source.md) instead.

### Prepare the installation

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
Ensure you have followed the steps for installing prerequisites according to your development
platform of choice:

* [Linux (Ubuntu used as example)](environment_ubuntu.md)
* [Windows](environment_windows.md)
* [Linux (Ubuntu used as example)](environment-ubuntu.md)
* [Windows](environment-windows.md)
* MacOS (TBD)

# Building and running from source
Expand Down
4 changes: 2 additions & 2 deletions docs/usage/components/channels.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Channels

In OpenAEV, Channels represent communication medias with a particular look. They are used to present [web articles or other media contents](media_pressure.md) to Players in a specific way.
In OpenAEV, Channels represent communication medias with a particular look. They are used to present [web articles or other media contents](media-pressure.md) to Players in a specific way.

It helps give shape to your Scenario context and events.

Expand All @@ -20,6 +20,6 @@ On the right, a mock up of the overview is displayed to give you the look and fi

A Channel will then be used in Scenario and in Simulation definition. When you create an Article, you have to choose the Channel that will give it an adequate shape.

See [Media pressure](media_pressure.md) page to know how to create and add Articles to your Scenarios.
See [Media pressure](media-pressure.md) page to know how to create and add Articles to your Scenarios.

![Channel selection during Article creation](../assets/channel_selection_during_creation.png)
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/usage/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ You can:
Once defined, a scenario can be turned into a [simulation](simulation.md): a live execution in your environment, either
one-shot or scheduled regularly.

During simulations, [expectations](injects_and_expectations.md) are validated:
During simulations, [expectations](injects-and-expectations.md) are validated:

- **Automatically**, via integrations with your stack
- **Manually**, by observers validating human reactions
Expand Down
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/usage/scenario.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ In the "Definition" tab, you can add various elements to construct events:

- [Teams and Players](people.md) involved in the scenario,
- [Custom variables](components/variables.md) for simplifying injects' customization,
- Articles that you might use to simulate [media pressure](components/media_pressure.md),
- Articles that you might use to simulate [media pressure](components/media-pressure.md),
- [Challenges](components/challenges.md) designed for including Capture The Flag elements in your scenario.

<!-- screenshot of the Definition screen with elements inside -->
Expand Down
2 changes: 1 addition & 1 deletion docs/usage/scenario/security-coverage.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ After injects are generated:
- Review and customize the **Scenario** to match your organization’s needs.
- Assign appropriate **Asset groups** to each inject.
- Optionally, configure default **Asset Groups** for scenarios created from OpenCTI using
the [Default Asset Groups](../default_asset_rules.md) page.
the [Default Asset Groups](../default-asset-rules.md) page.

![Inject Asset Groups](assets/inject-asset-group.png)

Expand Down
File renamed without changes.
22 changes: 11 additions & 11 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -140,8 +140,8 @@ nav:
- User Guide:
- Getting started: usage/getting-started.md
- Foundations:
- Scenario and Simulations: usage/scenarios_and_simulations.md
- Injects and Expectations: usage/injects_and_expectations.md
- Scenario and Simulations: usage/scenarios-and-simulations.md
- Injects and Expectations: usage/injects-and-expectations.md
- Evaluate your Security posture:
- Overview: usage/evaluate/overview.md
- Simulation: usage/simulation.md
Expand All @@ -163,25 +163,25 @@ nav:
- Build your own Threat Scenario:
- Scenario: usage/scenario.md
- Scenario Generation from OpenCTI Security Coverage: usage/scenario/security-coverage.md
- Default Asset Rules: usage/default_asset_rules.md
- Importing injects into a Scenario: usage/scenario_import.md
- Default Asset Rules: usage/default-asset-rules.md
- Importing injects into a Scenario: usage/scenario-import.md
- Assets: usage/assets.md
- People: usage/people.md
- Components:
- Documents: usage/components/documents.md
- Custom variables: usage/components/variables.md
- Channels: usage/components/channels.md
- Media pressure: usage/components/media_pressure.md
- Media pressure: usage/components/media-pressure.md
- Challenges: usage/components/challenges.md
- Lessons: usage/components/lessons.md
- Payloads: usage/payloads/payloads.md
- Share and export:
- Simulations: usage/simulation_reports.md
- Simulations: usage/simulation-reports.md
- Notifications: usage/notifications.md
- Interact with your environment:
- Injectors:
- Overview: usage/injectors.md
- Built-In Injector: usage/injects_builtin.md
- Built-In Injector: usage/injects-builtin.md
- Caldera Injector: usage/inject-caldera.md
- Collectors:
- Overview: usage/collectors.md
Expand All @@ -194,7 +194,7 @@ nav:
- Parameters: administration/parameters.md
- Security:
- Policies: administration/policies.md
- Users and RBAC: administration/users_and_rbac.md
- Users and RBAC: administration/users-and-rbac.md
- Taxonomies: administration/taxonomies.md
- XTM Hub: administration/hub.md # Warning: page is linked in XTM Hub documentation
- Reference:
Expand All @@ -204,9 +204,9 @@ nav:
- Telemetry: reference/deployment/telemetry.md
- Development:
- Prerequisites:
- Ubuntu: development/environment_ubuntu.md
- Windows: development/environment_windows.md
- Building and running from source: development/build_from_source.md
- Ubuntu: development/environment-ubuntu.md
- Windows: development/environment-windows.md
- Building and running from source: development/build-from-source.md
- Platform: development/platform.md
- Collectors: development/collectors.md
- Injectors: development/injectors.md
Expand Down