Skip to content

Commit dbdf6e1

Browse files
authored
Add linter (#376)
* chore: add prettier * format # Conflicts: # docs/dev/web/embed-mode.md # docs/dev/web/extension-system/extension-types/action-extensions.md # docs/dev/web/extension-system/extension-types/app-menu-item-extensions.md # docs/dev/web/extension-system/extension-types/custom-component-extensions.md # docs/dev/web/extension-system/extension-types/folder-view-extensions.md # docs/dev/web/extension-system/extension-types/right-sidebar-panel-extensions.md # docs/dev/web/extension-system/extension-types/search-extensions.md # docs/dev/web/extension-system/viewer-editor-apps.md # docs/dev/web/testing/e2e-testing-standards.md # prettier.config.js * use ; * use single quotes as its as well docusaurus default * chore: add linter # Conflicts: # package.json # pnpm-lock.yaml * ignore some rules * add to ci * ignore md003 * ignore .git * use ordere lists * run linter * fix links * update lockfile * run formatter * remove from woodpecker
1 parent b37384a commit dbdf6e1

67 files changed

Lines changed: 395 additions & 200 deletions

Some content is hidden

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

.markdownlint-cli2.jsonc

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
{
2+
"$schema": "https://raw.githubusercontent.com/DavidAnson/markdownlint-cli2/main/schema/markdownlint-cli2-config-schema.json",
3+
"config": ".markdownlint.json",
4+
"ignores": [
5+
".git",
6+
"node_modules",
7+
"static",
8+
"assets",
9+
"CHANGELOG.md",
10+
"CONTRIBUTING.md",
11+
"README.md"
12+
]
13+
}

.markdownlint.json

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"default": true,
3+
"MD003": false, // Disable MD003 to allow different heading styles
4+
"MD013": false, // Disable MD013 to allow long lines
5+
"MD033": false, // Disable MD033 to allow inline HTML
6+
"MD029": { "style": "ordered" } // Ensure ordered lists are used
7+
}

docs/admin/configuration/logging.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Logging helps monitor OpenCloud’s health and diagnose issues. Log output varie
1818

1919
Set the global log level using the `OPEN_CLOUD_LOG_LEVEL` environment variable. You can also override it per service using service-specific variables. Default is `error`.
2020

21-
## The log levels are:
21+
## The log levels are
2222

2323
### FATAL
2424

docs/admin/configuration/mail-notifications.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: 'How to activate mail notifications in OpenCloud.'
77

88
# Mail notifications in OpenCloud
99

10-
## This guide shows how to configure your OpenCloud instance to send notification E-Mails by modifying the `.env` file in your OpenCloud setup.
10+
## This guide shows how to configure your OpenCloud instance to send notification E-Mails by modifying the `.env` file in your OpenCloud setup
1111

1212
---
1313

docs/admin/getting-started/container/docker-compose-local.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,21 +29,21 @@ git clone https://github.com/opencloud-eu/opencloud-compose.git
2929

3030
## 2. Start
3131

32-
### cd into the Docker Compose configuration folder:
32+
### cd into the Docker Compose configuration folder
3333

3434
```Shell
3535
cd opencloud-compose
3636
```
3737

38-
### Create environment file:
38+
### Create environment file
3939

4040
```Shell
4141
cp .env.example .env
4242
```
4343

4444
> **Note:** The repository includes .env.example as a template with default settings and documentation. Your actual .env file is excluded from version control (via .gitignore) to prevent accidentally committing sensitive information like passwords and domain-specific settings.
4545
46-
### Configure deployment options:
46+
### Configure deployment options
4747

4848
You can deploy using explicit -f flags:
4949

docs/admin/getting-started/container/docker-compose/docker-compose.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@ Example with Chrome browser:
193193

194194
Once the staging certificate works, switch to a production certificate.
195195

196-
### Steps:
196+
### Steps
197197

198198
#### 1️⃣ Stop Docker Compose
199199

@@ -257,7 +257,7 @@ If you encounter any issues, check the [Common Issues & Help](./../../../resourc
257257

258258
<br/>
259259

260-
#### To enable Keycloak for identity and access management, **uncomment** the following lines in your `.env` file:
260+
#### To enable Keycloak for identity and access management, **uncomment** the following lines in your `.env` file
261261

262262
```env
263263
LDAP=:ldap.yml
@@ -271,15 +271,15 @@ KEYCLOAK_ADMIN_PASSWORD="your.save.password"
271271

272272
This will include the LDAP and Keycloak service definitions in the Docker Compose setup.
273273

274-
#### After starting OpenCloud, Keycloak will be available at:
274+
#### After starting OpenCloud, Keycloak will be available at
275275

276276
```bash
277277
https://keycloak.your.domain
278278
```
279279

280280
## 👤 Initial User Setup in Keycloak
281281

282-
### Once Keycloak is running:
282+
### Once Keycloak is running
283283

284284
**1. Open your browser and go to**
285285

docs/admin/getting-started/container/docker.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: 'Classic docker setup.'
77

88
# Docker
99

10-
## Spin up a temporary local instance of OpenCloud using **Docker**.
10+
## Spin up a temporary local instance of OpenCloud using **Docker**
1111

1212
---
1313

docs/admin/getting-started/other/bare-metal.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,11 @@ Bare-metal deployments are not officially supported by OpenCloud. They are great
2121
- Open a terminal.
2222

2323
- Update your package list:
24+
2425
```bash
2526
sudo apt update && apt upgrade
2627
```
28+
2729
- Install Git using the following command:
2830

2931
```bash
@@ -33,9 +35,11 @@ Bare-metal deployments are not officially supported by OpenCloud. They are great
3335
<img src={require("./../img/bare-metal/install-git.png").default} alt="install git" width="1920"/>
3436

3537
- Clone the OpenCloud repository:
38+
3639
```bash
3740
git clone https://github.com/opencloud-eu/opencloud.git
3841
```
42+
3943
<img src={require("./../img/bare-metal/git-clone.png").default} alt="git clone" width="1920"/>
4044

4145
---
@@ -61,20 +65,25 @@ Bare-metal deployments are not officially supported by OpenCloud. They are great
6165
<img src={require("./../img/bare-metal/install-corepack.png").default} alt="install corepack" width="1920"/>
6266

6367
- Enable `pnpm` using corepack:
68+
6469
```bash
6570
corepack enable pnpm
6671
```
72+
6773
<img src={require("./../img/bare-metal/corepack-enable.png").default} alt="corepack enable" width="1920"/>
6874

6975
---
7076

7177
### 3. Build process and OpenCloud initialization
7278

7379
- Navigate to the OpenCloud directory:
80+
7481
```bash
7582
cd opencloud
7683
```
84+
7785
<img src={require("./../img/bare-metal/cd-opencloud.png").default} alt="cd opencloud" width="1920"/>
86+
7887
- Run the build generate process:
7988

8089
```bash
@@ -91,9 +100,11 @@ Bare-metal deployments are not officially supported by OpenCloud. They are great
91100
<img src={require("./../img/bare-metal/opencloud-init.png").default} alt="opencloud init" width="1920"/>
92101

93102
- Start the OpenCloud server:
103+
94104
```bash
95105
./bin/opencloud server
96106
```
107+
97108
<img src={require("./../img/bare-metal/opencloud-server.png").default} alt="opencloud server" width="1920"/>
98109

99110
---
@@ -116,6 +127,6 @@ Your OpenCloud server is now running and ready to use 🚀
116127

117128
---
118129

119-
### If you encounter any issues or errors, try finding a solution here:
130+
### If you encounter any issues or errors, try finding a solution here
120131

121132
- [Common Issues & Help](./../../resources/common-issues.md)

docs/admin/getting-started/other/raspberry-pi.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ The IP for this can be viewed in your router.
3434

3535
<img src={require("./../img/raspberrypi/ip-router.png").default} alt="find ip from raspberry-pi in router" width="500"/>
3636

37-
#### Establish connection via SSH:
37+
#### Establish connection via SSH
3838

3939
```sh
4040
ssh pi@YOUR-IP

docs/admin/maintenance/backup.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@ id: backup
44
title: 'Backup'
55
---
66

7-
## Regular backups are essential to ensure that your OpenCloud instance can be restored in case of issues.
7+
## Regular backups are essential to ensure that your OpenCloud instance can be restored in case of issues
88

99
---
1010

1111
### General considerations
1212

13-
#### OpenCloud supports two different storage setups:
13+
#### OpenCloud supports two different storage setups
1414

1515
- Pure POSIX Setup: All data (configuration, blobs, and metadata) is stored on a POSIX-compliant filesystem.
1616

@@ -22,7 +22,7 @@ To determine which filesystems are supported, see: Filesystems and Shared Storag
2222

2323
### Backup strategies
2424

25-
#### To create a consistent backup, the OpenCloud instance must be stopped before starting the backup process. After the backup is complete, the instance can be restarted.
25+
#### To create a consistent backup, the OpenCloud instance must be stopped before starting the backup process. After the backup is complete, the instance can be restarted
2626

2727
**There are two recommended approaches:**
2828

@@ -41,7 +41,7 @@ To determine which filesystems are supported, see: Filesystems and Shared Storag
4141

4242
### Required backup components
4343

44-
#### A complete backup must include:
44+
#### A complete backup must include
4545

4646
- Configuration data
4747

@@ -65,7 +65,7 @@ To determine which filesystems are supported, see: Filesystems and Shared Storag
6565

6666
### Pure POSIX setup
6767

68-
#### If all data (configuration, blobs, and metadata) is stored on a POSIX-compliant filesystem:
68+
#### If all data (configuration, blobs, and metadata) is stored on a POSIX-compliant filesystem
6969

7070
- Stop the OpenCloud instance
7171

@@ -81,7 +81,7 @@ To determine which filesystems are supported, see: Filesystems and Shared Storag
8181

8282
### Distributed setup
8383

84-
#### If blobs are stored on S3, while configuration and metadata remain on a POSIX-compliant filesystem:
84+
#### If blobs are stored on S3, while configuration and metadata remain on a POSIX-compliant filesystem
8585

8686
- Stop the OpenCloud instance
8787

@@ -93,4 +93,4 @@ To determine which filesystems are supported, see: Filesystems and Shared Storag
9393

9494
---
9595

96-
#### With these backup strategies, you can ensure that your OpenCloud instance remains secure and restorable in case of issues!
96+
#### With these backup strategies, you can ensure that your OpenCloud instance remains secure and restorable in case of issues

0 commit comments

Comments
 (0)