Skip to content

Commit

Permalink
Fix spelling errors
Browse files Browse the repository at this point in the history
  • Loading branch information
Atlinx committed Jan 3, 2024
1 parent be758b9 commit fd4f806
Show file tree
Hide file tree
Showing 18 changed files with 59 additions and 59 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Built with [MkDocs Material](https://squidfunk.github.io/mkdocs-material/).

Available on:

- [Github Pages](https://rucogs.github.io/rucogs-docs)
- [GitHub Pages](https://rucogs.github.io/rucogs-docs)

## Contributing

Expand All @@ -17,8 +17,8 @@ Available on:

3. Running the documentation locally

```bash
> mkdocs serve
```
```bash
> mkdocs serve
```

4. The documentation automatically builds and deploys to Github Pages when you push to the main branch.
4. The documentation automatically builds and deploys to GitHub Pages when you push to the main branch.
2 changes: 1 addition & 1 deletion docs/backend/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ For debugging purposes you can use a free platform like [mailtrap](https://mailt
}
```

For the release config you can use Gmail transport settings, so the emails are sent using our noreply gmail account:
For the release config you can use Gmail transport settings, so the emails are sent using our no-reply Gmail account:

```yaml
"nodemailer":
Expand Down
6 changes: 3 additions & 3 deletions docs/backend/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@

## Overview

The backend is built on Node.JS, Typetta, and MongoDB using Typescript. This uses GraphQL for communication with our various frontends, like our website, discord bot, etc. Like all of our other projects, it's written in Typescript.
The backend is built on Node.JS, Typetta, and MongoDB using TypeScript. This uses GraphQL for communication with our various frontends, like our website, discord bot, etc. Like all of our other projects, it's written in TypeScript.

Tools:

- MongoDB - Our database.
- GraphQL - An alternative communication method to REST, that allows users of the API to query exactly the data they need.
- Apollo GraphQL - A GraphQL client/server library
- Typetta - A Typescript ORM. We use Typetta to connect and interact with our MongoDB database. Typetta automatically creates a GraphQL endpoint, and provides per-column security on queries sent to that endpoint.
- Node.JS - An asynchronous event-driven Javascript runtime that lets you build network applications.
- Typetta - A TypeScript ORM. We use Typetta to connect and interact with our MongoDB database. Typetta automatically creates a GraphQL endpoint, and provides per-column security on queries sent to that endpoint.
- Node.JS - An asynchronous event-driven JavaScript runtime that lets you build network applications.
- Express.JS - A web server framework for Node.JS

## Contents
Expand Down
12 changes: 6 additions & 6 deletions docs/backend/structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@
- `server.ts` - The entry point of the backend. It reads the command line arguments or environment variables to start a server in development or production mode.
- `config` - Stores config files that change how the backend runs. See the [Config section](#config) for more information
- `_tools` - Contains code used by Node.JS scripts defined in our `package.json`.
- `controllers` - Contains "controllers" which are scripts or folderes of scripts that perform certain functionality. This is a more structured version of `utils` and `misc` folders.
- `controllers` - Contains "controllers" which are scripts or folders of scripts that perform certain functionality. This is a more structured version of `utils` and `misc` folders.
- `generated` - Auto-generated code based on our GraphQL schema
- `graphql` - Contains the GraphQL schema defined in Typescript
- `graphql` - Contains the GraphQL schema defined in TypeScript
- `middlewares` - Middleware for Typetta
- `misc` - Contains miscellaneous helper code
- `routes` - Contains all the routes in the backend. Note that accessing data is done by Apollo server's GraphQL endpoint, rather than through manually configured routes.
Expand All @@ -17,7 +17,7 @@
- `dist` - Where the release version of the backend is stored once you build it.
- `gulpfile.js` - Script that automates copying assets over when you build the backend.
- `rucogs.service` - Service file for hosting backend. See [DevOps/Hosting](../devops/hosting.md) for more information.
- `tsconfig.json` - Configuration for Typescript
- `tsconfig.json` - Configuration for TypeScript
- `typetta.yml` - Configuration for Typetta

## NodeJS Scripts
Expand All @@ -28,17 +28,17 @@
- `mock` - Runs a mock server with dummy data from the `dist/_tools` folder
- `mock:recompile` - Recompiles the backend and runs it with dummy data.
- `tools` - Runs the server in tool mode
- Tool mode is used at the moment to automatically generate a GraphQL Typescript typings from the running Apollo server. The generated files are placed under the `src/generated` folder.
- Tool mode is used at the moment to automatically generate a GraphQL TypeScript typings from the running Apollo server. The generated files are placed under the `src/generated` folder.
- `tools:recompile` - Recompiles the backend and runs it in tool mode
- `generate` - Generates Typetta and GraphQL typings.
- `generate:typetta` - Generates Typetta typings.
- `generate:graphql-endpoint` - Generates typings for our GraphQL endpiont.
- `generate:graphql-endpoint` - Generates typings for our GraphQL endpoint.
- `compile:app` - Cleans the `dist` directory and recompiles the backend.
- `compile:tools` - Cleans the `dist` directory and recompile the backend in tool mode, which basically includes the `src/_tools` folder in the final build.
- `tidy uploads` - Removes unused user-uploaded images and assets from the `uploads` folder.
- `clean` - Deletes the `dist` directory
- `build` - Cleans the `dist` directory, regenerates the autogenerated code, and then recompiles the backend.
- `pretty` - Run the prettier formatter on the Typescript files within `src`.
- `pretty` - Run the prettier formatter on the TypeScript files within `src`.

!!! note

Expand Down
14 changes: 7 additions & 7 deletions docs/devops/ci_cd.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@

## Recommended Reading

- [Understanding Github Actions](https://docs.github.com/en/actions/learn-github-actions/understanding-github-actions)
- [Understanding GitHub Actions](https://docs.github.com/en/actions/learn-github-actions/understanding-github-actions)

## Overview

Continuous integration and deployment is the process of automatically running unit tests and building/deploying software. We only use Github Actions at the moment to automate deployment of the website as well as perform weekly backups.
Continuous integration and deployment is the process of automatically running unit tests and building/deploying software. We only use GitHub Actions at the moment to automate deployment of the website as well as perform weekly backups.

## Website

We use this for our website, since it's hosted on Github Pages. Inside our `rucogs.github.io` repository, we have `.github/workflows/gh-pages-deployment.yml` workflow show below. This workflow automatically builds and deploys the website to Github Pages any time there is a commit made to the `main` branch.
We use this for our website, since it's hosted on GitHub Pages. Inside our `rucogs.github.io` repository, we have `.github/workflows/gh-pages-deployment.yml` workflow show below. This workflow automatically builds and deploys the website to GitHub Pages any time there is a commit made to the `main` branch.

```yaml
name: Deploy to GitHub Pages
Expand Down Expand Up @@ -48,7 +48,7 @@ jobs:
## Backups
We also use Github Actions to automate backups of both the database and users' uploaded files. Inside our `rucogs-infrastructure-backup` repository, we have `.github/workflows/actions.yml` workflow shown below. This workflows requires the URI connection string to the MongoDB database, as well as the
We also use GitHub Actions to automate backups of both the database and users' uploaded files. Inside our `rucogs-infrastructure-backup` repository, we have `.github/workflows/actions.yml` workflow shown below. This workflows requires the URI connection string to the MongoDB database, as well as the

```yaml
name: 📦 Make Backups
Expand Down Expand Up @@ -159,7 +159,7 @@ jobs:

### Environment Variables

Nonsensitive configuration can be done in the workflow file itself
Non-sensitive configuration can be done in the workflow file itself

- `MONGODB_TOOLS_DOWNLOAD` - A environment variable that links to a download for `mongodump`, a tool that can dump the contents of the database into a file.
We use this to create a backup of the MongoDB database hosted on MongoDB Atlas.
Expand All @@ -169,8 +169,8 @@ Nonsensitive configuration can be done in the workflow file itself
### Secrets
Sensitive information is stored as a repository secret on our Github repository. Here is a list of the follow secrets that can be configured
Sensitive information is stored as a repository secret on our GitHub repository. Here is a list of the follow secrets that can be configured
- `MONGO_URI` - The [MongoDB connection string](https://www.mongodb.com/docs/manual/reference/connection-string/) used to connect to our `MainDB` database
- `BACKEND_URI` - The ssh connection string to the backend. It's typically `root@123.45.678` where `123.45.678` represents your server's ip address.
- `BACKEND_URI` - The ssh connection string to the backend. It's typically `root@123.45.678` where `123.45.678` represents your server's IP address.
- `BACKEND_ROOT_PASS` - The password of the backend for the user you specified in the `BACKEND_URI`.
10 changes: 5 additions & 5 deletions docs/devops/hosting.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Given a `.service` file named `myservice.service`, you can start it by navigatin
systemctl start myservice
```

So in order to start the backend and discord bots, you need to bavigate to the directory containing `rucogs.service` and run
So in order to start the backend and discord bots, you need to navigate to the directory containing `rucogs.service` and run

```bash
sudo systemctl start rucogs
Expand Down Expand Up @@ -80,7 +80,7 @@ Please check of the following guides to set up NGINX:
- [Beginner's Guide to NGINX](https://nginx.org/en/docs/beginners_guide.html)
- [Sites Enabled with NGINX or Apache](https://www.linode.com/docs/guides/how-to-enable-disable-website/)

Here's an example NGINX conf file used by Alan to host the backend on his personal website at [atlinx.net](https://atlinx.net). It's stored underneath the `site-enabled` directory of NGINX.
Here's an example NGINX `conf` file used by Alan to host the backend on his personal website at [atlinx.net](https://atlinx.net). It's stored underneath the `site-enabled` directory of NGINX.

```NGINX
# /etc/nginx/sites-enabled/default
Expand Down Expand Up @@ -155,8 +155,8 @@ An important part of setting up the server is getting SSL/TLS certificates. Thes

!!! note

It's important to ensure we have access to the cogs.club domain.
It's important to ensure we have access to the cogs.club domain.

Alumni who currently owns the cogs.club domain:
Alumni who currently owns the cogs.club domain:

- Harry Stern (Discord: `ohmyachingtentacles`)
- Harry Stern (Discord: `ohmyachingtentacles`)
12 changes: 6 additions & 6 deletions docs/discord-bot/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,13 @@ The repository provides templates files ending in `.config.template.json` for th

- `type` - The type of server this config file is for. It can be set to either `"production"` or `"debug"`. If you are using `"debug"`, make sure to also name the config as `server.debug.config.json`.
- `backendDomain` - The domain for the backend.
- `cdnDomain` - The domain for the cdn.
- `cdnHttpsPrefix` - Https prefix for the cdn domain. This can be set to `http://` or `https://`.
- `cdnDomain` - The domain for the CDN.
- `cdnHttpsPrefix` - Https prefix for the CDN domain. This can be set to `http://` or `https://`.
- `httpsPrefix` - Https prefix for the backend domain. This can be set to `http://` or `https://`.
- `wssPrefix` - Websocket prefix for the backend domain. This can be set to `ws://` or `wss://`.
- `cdnRelativePath` - The path of the cdn relative to the `cdnDomain`.
- `dynamicCdnRelativePath` - The path for getting dynamically generated images from the cdn, relative to the `cdnDomain`.
- `graphqlRelativePath` - The path to the graphql endpoint relative to the `backendDomain`.
- `wssPrefix` - WebSocket prefix for the backend domain. This can be set to `ws://` or `wss://`.
- `cdnRelativePath` - The path of the CDN relative to the `cdnDomain`.
- `dynamicCdnRelativePath` - The path for getting dynamically generated images from the CDN, relative to the `cdnDomain`.
- `graphqlRelativePath` - The path to the GraphQL endpoint relative to the `backendDomain`.
- `selfHostedPrefix` - Prefix for indicated an image is self-hosted. By default it's `cdn://`
- `archiveCategoryId` - Id of the archive category of the discord server that the bot is operating in. The discord server the bot is operating in is specified by the Auth config.

Expand Down
4 changes: 2 additions & 2 deletions docs/discord-bot/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@

## Overview

The discord bot is built on Node.JS with Discord.JS using Typescript. GraphQL is used to communicate with the backend.
The discord bot is built on Node.JS with Discord.JS using TypeScript. GraphQL is used to communicate with the backend.

Tools:

- Node.JS - An asynchronous event-driven Javascript runtime that lets you build network applications.
- Node.JS - An asynchronous event-driven JavaScript runtime that lets you build network applications.
- Apollo GraphQL - A GraphQL client/server library
- Discord.JS - A Discord bot framework for NodeJS that can interact with the Discord API

Expand Down
6 changes: 3 additions & 3 deletions docs/discord-bot/structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,17 @@
## Folder Structure

- `src` - Contains
- `server.ts` - The entry point of the discord bot. It reads the command line arguments or environment variables to start a server in devlopment or production mode.
- `server.ts` - The entry point of the discord bot. It reads the command line arguments or environment variables to start a server in development or production mode.
- `config` - Stores config files that change how the discord bot runs. See the [Config section](#config) for more information
- `commands` - Contains code for slash commands. Each slash command is represented by a script that exports a `Command` object, which defines the command and the handlers for it. Note that sub commands are handled manually by each command script.
- `_tools` - Contains code used by Node.JS scripts defined in our `package.json`.
- `generated` - Auto-generated code based on our GraphQL schema
- `misc` - Contains miscallenous helper code
- `misc` - Contains miscellaneous helper code
- `shared` - Code that's shared between the backend and frontends
- `dist` - Where the release version of the discord bot is stored once you build it.
- `gulpfile.js` - Script that automates copying assets over when you build the discord bot.
- `rucogs-discord.service` - Service file for hosting discord bot. See [DevOps/Hosting](../devops/hosting.md) for more information.
- `tsconfig.json` - Configuration for Typescript
- `tsconfig.json` - Configuration for TypeScript

## NodeJS Scripts

Expand Down
6 changes: 3 additions & 3 deletions docs/documentation.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Documentation

The documentation is written using MkDocs and hosted on Github Pages. It also uses Material for MkDocs for the general theming of the docs site.
The documentation is written using MkDocs and hosted on GitHub Pages. It also uses Material for MkDocs for the general theming of the docs site.

## Contributing

1. To edit the doucmentation it you'll need [Python](https://www.python.org/downloads/)
1. To edit the documentation it you'll need [Python](https://www.python.org/downloads/)

2. Install mkdocs-material with:
`pip install mkdocs-material`
Expand All @@ -15,4 +15,4 @@ The documentation is written using MkDocs and hosted on Github Pages. It also us
> mkdocs serve
```

4. The documentation automatically builds and deploys to Github Pages when you push to the main branch.
4. The documentation automatically builds and deploys to GitHub Pages when you push to the main branch.
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@ A table of contents is available on the left side of the site. You can use the s
- [Backend](backend/index.md)
- [Discord Bot](discord-bot/index.md)
- [Music Bot](music-bot/index.md)
- [Devops](devops/index.md)
- [DevOps](devops/index.md)
4 changes: 2 additions & 2 deletions docs/new_webmaster.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

This documentation will assume you have prerequisite knowledge of frameworks being used, therefore teaching is out of the scope of this site. However, there will be recommended reading sections at the start of each section to give an entry point to learning a new topic.

For the ease of learning and consistency, all COGS infrastructure projects are written in Typescript. Please check out the [Typescript documentation](https://www.typescriptlang.org/docs/) if you are unfamiliar with the language.
For the ease of learning and consistency, all COGS infrastructure projects are written in TypeScript. Please check out the [TypeScript documentation](https://www.typescriptlang.org/docs/) if you are unfamiliar with the language.

## Tools

Expand All @@ -19,7 +19,7 @@ We also use Prettier to automatically format our code. If you're using VSCode yo
We use Git for version control, with repositories hosted on GitHub. If you are unfamiliar with Git or GitHub you should check out the following tutorials:

- [Learning Git Branching](https://learngitbranching.js.org/?locale=en_US)
- [Introduction to Github](https://zarkom.notion.site/zarkom/Introduction-to-GitHub-202af6f64bbd4299b15f238dcd09d2a7#5177c6445c724460a400df2617e86bcd)
- [Introduction to GitHub](https://zarkom.notion.site/zarkom/Introduction-to-GitHub-202af6f64bbd4299b15f238dcd09d2a7#5177c6445c724460a400df2617e86bcd)

### RUCOGS Infrastructure

Expand Down
2 changes: 1 addition & 1 deletion docs/website/blog.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ To add an article, follow the steps below:
> py update_articles.py
```
3. Commit and push your changes to Github
3. Commit and push your changes to GitHub
```bash
> git add .
Expand Down
2 changes: 1 addition & 1 deletion docs/website/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@ The behavior of the website is determined by `src/_settings.ts` file.
- `backendRelativeBaseUrl` - Relative path to the backend from the `backendDomain`.
- `graphQLRelativePath` - Relative to the GraphQL endpoint from the `backendDomain`.
- `selfHostedPrefix` - Prefix that indicates whether a file is self-hosted on the backend or not.
- `cdnRelativePath` - Relative path to the cdn from the `backendDomain`.
- `cdnRelativePath` - Relative path to the CDN from the `backendDomain`.
Loading

0 comments on commit fd4f806

Please sign in to comment.