Skip to content

Commit 7c10be0

Browse files
docs: fix ~58 typos, grammar errors, and inconsistencies across 30 files (#258)
* Initial plan * Fix comprehensive typos, spelling mistakes and grammar issues across documentation Co-authored-by: SamuelHassine <1334279+SamuelHassine@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: SamuelHassine <1334279+SamuelHassine@users.noreply.github.com>
1 parent c3d4906 commit 7c10be0

30 files changed

Lines changed: 51 additions & 52 deletions

docs/administration/enterprise.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ specified in the GitHub license file:
1010

1111
- The OpenAEV Community Edition is licensed under the Apache License, Version 2.0 (the “Apache License”).
1212
- The OpenAEV Enterprise Edition is licensed under the OpenAEV Enterprise Edition License (the “Enterprise Edition
13-
Licensee”).
13+
License”).
1414

1515
The source files in this repository have a header indicating which license they are under. If no such header is
1616
provided, this means that the file belongs to the Community Edition under the Apache License, Version 2.0.
@@ -30,7 +30,7 @@ can [generate a trial license](https://filigran.io/enterprise-editions-trial/).
3030
As a reminder:
3131

3232
- Filigran is the only company producing and providing OpenAEV Enterprise Edition license keys.
33-
- Filigran can provide free-to-use OpenAEV Enterprise Edition licenses for development and research purposes (e.g. connector development purposes, integrations with technical partners, etc...) as well as for non-governmental charity organizations.
33+
- Filigran can provide free-to-use OpenAEV Enterprise Edition licenses for development and research purposes (e.g. connector development, integrations with technical partners, etc...) as well as for non-governmental charity organizations.
3434
- OpenAEV Enterprise Edition licenses are automatically provided to all Filigran SaaS customers.
3535
- **For all other usages including On-Premise deployments, OpenAEV Enterprise Edition is reserved to organizations that have signed a Filigran Enterprise agreement.**
3636

docs/administration/taxonomies.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ and responding to threats.
1919

2020
OpenAEV supports the following kill chain models:
2121

22-
- **MITRE ATT&CK Framework (Entreprise, PRE, Mobile and ICS)**
22+
- **MITRE ATT&CK Framework (Enterprise, PRE, Mobile and ICS)**
2323

2424
You can add, edit, or delete kill chain phases in the settings page, and assign them to attack patterns in the platform.
2525
Additionally, you can filter data by kill chains phases, visualize relationships between kill chain phases and

docs/deployment/authentication.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,15 @@ This documentation provides details on setting up and utilizing the authenticati
1212

1313
### Local users
1414

15-
OpenAEV use this strategy as the default, but it's not the one we recommend for security reasons.
15+
OpenAEV uses this strategy as the default, but it's not the one we recommend for security reasons.
1616

1717
| Parameter | Environment variable | Default value | Description |
1818
|:--------------------------|:--------------------------|:----------------------|:--------------------------------------------------------------|
1919
| openaev.auth-local-enable | OPENAEV_AUTH-LOCAL-ENABLE | true | Set this to `true` to enable username/password authentication. |
2020

2121
### OpenID
2222

23-
This method allows to use the [OpenID Connect Protocol](https://openid.net/connect) to handle the authentication.
23+
This method allows using the [OpenID Connect Protocol](https://openid.net/connect) to handle the authentication.
2424

2525
| Parameter | Environment variable | Default value | Description |
2626
|:-------------------------------|:---------------------------|:----------------------|:--------------------------------------------------------------|

docs/deployment/configuration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ certificates in the folder are public PEM-armoured (*.pem), DER-encoded X509 cer
7777
|:------------------------------------|:------------------------------------|:--------------|:--------------------------------------------------------------------------------------------------------------------------------------|
7878
| openaev.xtm.opencti.enable | OPENAEV_XTM_OPENCTI_ENABLE | false | Enable integration with OpenCTI |
7979
| openaev.xtm.opencti.url | OPENAEV_XTM_OPENCTI_URL | | OpenCTI URL |
80-
| openaev.xtm.opencti.api_url | OPENAEV_XTM_OPENCTI_API_URL | | OpenCTI API URL, it will completly override the OpenCTI URL, otherwise the default url will be `openaev.xtm.opencti.url` + '/graphql' |
80+
| openaev.xtm.opencti.api_url | OPENAEV_XTM_OPENCTI_API_URL | | OpenCTI API URL, it will completely override the OpenCTI URL, otherwise the default url will be `openaev.xtm.opencti.url` + '/graphql' |
8181
| openaev.xtm.opencti.token | OPENAEV_XTM_OPENCTI_TOKEN | | OpenCTI token |
8282
| openaev.xtm.opencti.disable-display | OPENAEV_XTM_OPENCTI_DISABLE-DISPLAY | `false` | Disable OpenCTI in the UI |
8383

@@ -108,7 +108,7 @@ certificates in the folder are public PEM-armoured (*.pem), DER-encoded X509 cer
108108
| engine.engine-selector | ENGINE_ENGINE_SELECTOR | elk | Engine to use for storage and search (`elk` for ElasticSearch and `opensearch` for OpenSearch) |
109109
| engine.url | ENGINE_URL | http://localhost:9200 | URL of the ElasticSearch database |
110110
| engine.username | ENGINE_USERNAME | | This parameter is optional. Login for the database |
111-
| engine.password | ENGINE_PASSWORD | | This parameter is optional. Password for the dat |
111+
| engine.password | ENGINE_PASSWORD | | This parameter is optional. Password for the database |
112112

113113
If you switch your engine selector, you’ll need to delete the `indexing_status` table in PostgreSQL to trigger a full
114114
reindex.

docs/deployment/ecosystem/collectors.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ $ docker compose up
6262
```
6363

6464
### Manual deployment
65-
If you want to manually launch collector without docker, you just have to install Python 3 and pip3 for dependencies:
65+
If you want to manually launch a collector without docker, you just have to install Python 3 and pip3 for dependencies:
6666

6767
```
6868
$ apt install python3 python3-pip

docs/deployment/ecosystem/executors.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -395,7 +395,7 @@ Endpoint on the OpenAEV endpoint page.
395395
---
396396
## Caldera Agent
397397

398-
The Caldera agent can be leveraged to execute implants as detached processes that will the execute payloads according to
398+
The Caldera agent can be leveraged to execute implants as detached processes that will then execute payloads according to
399399
the [OpenAEV architecture](https://docs.openaev.io/latest/deployment/overview/#architecture).
400400

401401
!!! note "Caldera already installed"

docs/deployment/ecosystem/injectors.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ For instance, to enable the HTTP query injector, you can add a new service to yo
5353
Note: Injector images and available versions can be found on Docker Hub.
5454

5555
##### Launch a standalone collector
56-
To launch standalone injector, you can use the `docker-compose.yml` file of the injector itself. Just download the latest [release](https://github.com/OpenAEV-Platform/injectors/releases) and start the injector:
56+
To launch a standalone injector, you can use the `docker-compose.yml` file of the injector itself. Just download the latest [release](https://github.com/OpenAEV-Platform/injectors/releases) and start the injector:
5757

5858
```
5959
$ wget https://github.com/OpenAEV-Platform/injectors/archive/{RELEASE_VERSION}.zip
@@ -111,7 +111,7 @@ $ python3 openaev_http.py
111111

112112
#### Configuration
113113

114-
All external injectors have to be able to access the OpenAEV API. To allow this connection, they have 2 mandatory configuration parameters, the `OPENAEV_URL` and the `OPENAEV_TOKEN`. In addition to these 2 parameters, injectors have other mandatory parameters that need to be set in order to get them work.
114+
All external injectors have to be able to access the OpenAEV API. To allow this connection, they have 2 mandatory configuration parameters, the `OPENAEV_URL` and the `OPENAEV_TOKEN`. In addition to these 2 parameters, injectors have other mandatory parameters that need to be set in order to make them work.
115115

116116
!!! info "Injector tokens"
117117

docs/deployment/ecosystem/integration-manager/overview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ To learn more about Xtm Composer architecture, refer to the [dedicated documenta
3535

3636
- **Built-in connectors**: Connectors which are internally implemented.
3737
This category includes:
38-
- **Auto-start connectors**, which are natively integrated into the core platform no additional deployment required. These connectors are automatically started and cannot be managed on the UI, even though they are still visible in the dedicated pages.
38+
- **Auto-start connectors**, which are natively integrated into the core platform no additional deployment required. These connectors are automatically started and cannot be managed on the UI, even though they are still visible in the dedicated pages.
3939
- **Standard built-in connectors**, which are also automatically started but can be started and stopped by the user through the UI.
4040
- **External connectors**: These are deployed and configured by the user.
4141
In the catalog, only external connectors can be retrieved. The following sections focus on how to deploy, configure, and manage these **external** connectors.
@@ -74,7 +74,7 @@ To learn more about Xtm Composer architecture, refer to the [dedicated documenta
7474

7575
- Different injector, collector or executor types are identified in the catalog:
7676
- External : Injector, collector or executor managed by the integration manager
77-
- built-in : Injector, collector or executor natively integrated into the core platform no additional deployment required
77+
- built-in : Injector, collector or executor natively integrated into the core platform no additional deployment required
7878
- Instances statuses:
7979
- Managed instances: *Started* or *Stopped*.
8080
- Only **managed instances** can be started/stopped from the UI. They are also the only ones that provide logs in the interface.

docs/deployment/ecosystem/integration-manager/troubleshooting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -331,6 +331,6 @@ If you continue to experience issues:
331331
1. **Check the logs** with debug level enabled
332332
2. **Review the configuration** for any misconfigurations
333333
3. **Verify network connectivity** between all components
334-
4. **Consult the openAEV community** for additional support
334+
4. **Consult the OpenAEV community** for additional support
335335

336336
For bug reports and feature requests, visit the [GitHub repository](https://github.com/FiligranHQ/xtm-composer.git).

docs/deployment/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ manual [installation packages](https://github.com/OpenAEV-Platform/openaev/relea
1414
---
1515

1616
Deploy OpenAEV using Docker and the default `docker-compose.yml` provided
17-
in the [docker](https://github.com/OpenAEV-Platform/docker).
17+
in the [docker repository](https://github.com/OpenAEV-Platform/docker).
1818

1919
[:octicons-arrow-right-24:{ .middle } Setup](#using-docker)
2020

0 commit comments

Comments
 (0)