Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement spellcheck and fix existing typos #43

Merged
merged 10 commits into from
Jan 4, 2025
Merged
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
17 changes: 17 additions & 0 deletions .github/workflows/spellcheck.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: "Spell Check"

on:
- push
- pull_request

jobs:
check:
# run on all push events or on PR syncs not from the same repo
if: github.event_name != 'pull_request' || github.repository != github.event.pull_request.head.repo.full_name

runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Spell check
uses: crate-ci/[email protected]
2 changes: 1 addition & 1 deletion docs/features/commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ The `time` option can be any number of minutes, hours, days, or weeks - e.g. `5d

| Name | Description | Example |
| :--------------------------------------------------------------: | :--------------------------------------------------------------------------------------------: | :-----: |
| :material-comment-text:{ .tip title="Autocompleted" } `category` | Close all tickets in hte specified category (can be used with 'time') | N/A |
| :material-comment-text:{ .tip title="Autocompleted" } `category` | Close all tickets in the specified category (can be used with 'time') | N/A |
| `reason` | The reason why the ticket(s) should be closed | N/A |
| :material-comment-text:{ .tip title="Autocompleted" } `ticket` | The ticket to close | N/A |
| `time` | Close all tickets that have been inactive for the specified time (can be used with 'category') | `1w` |
Expand Down
4 changes: 2 additions & 2 deletions docs/features/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,10 +57,10 @@ This flowchart shows the different pathways that can be taken to create a ticket
flowchart TB
A1(["➡️ /new command"]) ----> B
A2(["➡️ Panel button/menu"]) ----> D
A3(["➡️ Messsage:Create command"]) ---> B
A3(["➡️ Message:Create command"]) ---> B
%% fa:fa-arrow-right-long
A4(["➡️ User:Create command (staff)"]) -...->|"Staff interaction"| B
A5(["➡️ DM (message is topic)"]) --> AA{Mulitple servers?}
A5(["➡️ DM (message is topic)"]) --> AA{Multiple servers?}
AA -->|Yes| AA1[/"❓ Select server with menu"/] ---> B
AA -->|No| B
B{Multiple categories?}
Expand Down
2 changes: 1 addition & 1 deletion docs/self-hosting/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ The installation guides also explain where to find most of the environment varia
DB_CONNECTION_URL="mysql://bots:VerySecurePassword123@localhost/tickets0"
DB_PROVIDER=mysql
DISCORD_SECRET=rUpDU2T8K4ZXie8kdpzYsMTLbUhvmBRd
DISCORD_TOKEN=ODcwOTg1TY0NjI0NODI2Mzc0.DNg0e0.UYVof7V1v0kRA0HHtGwXKA3UERxwANAZhQiA
DISCORD_TOKEN=ODcwOTg1TY0NjI0NODI2Mzc0.DNg0e0.UYVof7V1v0kRA0HHtGwXKA3URxwANAZhQiA
ENCRYPTION_KEY=445940dbed49eff55df56dd646fa1cb4b686df4cb9ac004a
HTTP_EXTERNAL=https://tickets.example.com
HTTP_HOST=0.0.0.0
Expand Down
2 changes: 1 addition & 1 deletion docs/self-hosting/installation/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,7 @@ docker run -itd \
-e DB_CONNECTION_URL="mysql://bots:VerySecurePassword123@localhost/tickets0" \
-e DB_PROVIDER="mysql" \
-e DISCORD_SECRET="rUpDU2T8K4ZXie8kdpzYsMTLbUhvmBRd" \
-e DISCORD_TOKEN="ODcwOTg1TY0NjI0NODI2Mzc0.DNg0e0.UYVof7V1v0kRA0HHtGwXKA3UERxwANAZhQiA" \
-e DISCORD_TOKEN="ODcwOTg1TY0NjI0NODI2Mzc0.DNg0e0.UYVof7V1v0kRA0HHtGwXKA3URxwANAZhQiA" \
-e ENCRYPTION_KEY="445940dbed49eff55df56dd646fa1cb4b686df4cb9ac004a" \
-e HTTP_EXTERNAL="https://tickets.example.com" \
-e HTTP_TRUST-PROXY="true" \
Expand Down
2 changes: 1 addition & 1 deletion docs/self-hosting/reverse-proxy.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ server {
This example shows the additions you may need to make to your `docker-compose.yml` file to configure Traefik.
After installing and configuring Traefik (referring to the documentation linked above), change the highlighted values to match your configuration.

This example shows the configuration you may need to add to the `bot` service & router in [:octicons-arrow-right-24: exemple docker-compose.yml](https://github.com/discord-tickets/bot/blob/main/docker-compose.yml) file.
This example shows the configuration you may need to add to the `bot` service & router in [:octicons-arrow-right-24: example docker-compose.yml](https://github.com/discord-tickets/bot/blob/main/docker-compose.yml) file.
Refer to the documentation linked above for more information.

<div class="annotate" markdown>
Expand Down
2 changes: 1 addition & 1 deletion docs/self-hosting/updating.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ This guide assumes you're using a Bot hosting plan from PebbleHost and not a ded

![4](https://github.com/discord-tickets/docs/assets/86845749/264cc0fa-a488-4b58-a664-26647921898e)

5) Select the databse you're using from the list
5) Select the database you're using from the list

![5](https://github.com/discord-tickets/docs/assets/86845749/88315de1-e3cc-43d7-95dc-54df945852b2)

Expand Down
34 changes: 34 additions & 0 deletions typos.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Used by the typos action

[default]
locale = "en-gb"
check-filename = true
extend-ignore-re = [

# Most usage of these words is in code where the american spelling is used or required
"Authorization",
"initialize",
"mustache",
"Mustache",
"color"

]

[files]
extend-exclude = [

# Code is primarily written in American English
"*.txt",
"*.toml",
"*.yaml",
"*.yml",
"*.js",
"*.html",
"*.css",
"overrides/",

# Written entirely in American English
"LICENSE",
"docs/terms.md"

]
Loading