diff --git a/.github/workflows/spellcheck.yml b/.github/workflows/spellcheck.yml index d934ed9..f992695 100644 --- a/.github/workflows/spellcheck.yml +++ b/.github/workflows/spellcheck.yml @@ -43,4 +43,4 @@ jobs: pattern: "**.md" exclude: | ./.git/* - ./.cache/* \ No newline at end of file + ./.cache/* diff --git a/.github/workflows/website.yml b/.github/workflows/website.yml index ea2dad4..1235b4f 100644 --- a/.github/workflows/website.yml +++ b/.github/workflows/website.yml @@ -5,12 +5,12 @@ on: branches: - main paths: - - 'docs' + - 'docs/**' pull_request: branches: - main paths: - - 'docs' + - 'docs/**' schedule: - cron: '36 8 * * 0' @@ -36,7 +36,7 @@ jobs: uses: cloudflare/pages-action@v1 with: apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }} - projectName: matrix.saferplace-web + projectName: saferplace-web accountId: 77fe99c5bfc86a6c12a8092954daec44 directory: docs/public gitHubToken: ${{ github.token }} diff --git a/.markdownlint.yaml b/.markdownlint.yaml new file mode 100644 index 0000000..cd7ba48 --- /dev/null +++ b/.markdownlint.yaml @@ -0,0 +1,11 @@ +default: true + +MD013: + line_length: 80 + heading_line_length: 80 + code_block_line_length: 80 + code_blocks: true + tables: false + headings: true + strict: false + stern: false diff --git a/docs/content/architecture.md b/docs/content/architecture.md index 6daa7ed..9fd152c 100644 --- a/docs/content/architecture.md +++ b/docs/content/architecture.md @@ -101,12 +101,12 @@ the review UI. The reviewer uses the review UI to see the incident details. They judge the incident based on review criteria, and can add the following resolution: -- Reject - The incident report is not up to our standards -- Ignore - Keep the incident up for review, but comment on the incident, useful - for having a second opinion. -- Accept - Incident is accepted, and will show up for users. -- Alert - Incident has implications right now to people in the area, and if they - can, they should take caution. +| Action | Description | +|--------|-------------| +| Reject | The incident report is not up to our standards | +| Ignore | Keep the incident up for review, but comment on the incident for having a second opinion. | +| Accept | Incident is accepted, and will show up for users. | +| Alert | Incident has implications right now to people in the area, and if they can, they should take caution. | The reviewer can also add further comments to each incident.