Skip to content

Commit

Permalink
fixed spelling and improved some table formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
zeim839 committed Sep 16, 2023
1 parent a072db5 commit 0faa887
Show file tree
Hide file tree
Showing 13 changed files with 26 additions and 26 deletions.
2 changes: 1 addition & 1 deletion docs/osc-docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,5 +21,5 @@ The source code is available on the Open Source Club's [GitHub page](https://git
* [Usage](/docs/osc-docs/usage): Instructions on setting up a local development server and using the project.
* [Markdown](/docs/osc-docs/markdown): Introduction to the Markdown language.
* [Documentation](/docs/osc-docs/writingdocs): Creating documentation sites and managing their contents.
* [Static Pages](/docs/osc-docs/static-pages): Guide to creating non-documentational static pages.
* [Static Pages](/docs/osc-docs/static-pages): Guide to creating non-documentation static pages.
* [Configuring Docusaurus](/docs/osc-docs/docusaurus): Guide to modifying the Docusaurus website template.
2 changes: 1 addition & 1 deletion docs/osc-docs/static-pages.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,6 @@ navbar: {

:::tip

The OSC Docs homepage is an example of a non-documentational static page. You may find its source code (in Markdown) in the project's `src/pages/index.md` path.
The OSC Docs homepage is an example of a non-documentation static page. You may find its source code (in Markdown) in the project's `src/pages/index.md` path.

:::
4 changes: 2 additions & 2 deletions docs/osc-docs/writingdocs.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Docusaurus is a powerful tool for creating documentation websites with ease. It

:::caution Installing the Project

It is highly recommended to have the OSC Docs repository installed on your system prior to modifying the codebase. Installation of OSC Docs is documented in the [Installation](/docs/osc-docs/installation) guide.
It is highly recommended to have the OSC Docs repository installed on your system prior to modifying the code base. Installation of OSC Docs is documented in the [Installation](/docs/osc-docs/installation) guide.

:::

Expand Down Expand Up @@ -128,4 +128,4 @@ Starting a docusaurus server will allow you to instantly preview your markdown c
npm start
```

For more information, see the [Usage](/docs/osc-docs/usage) section. You must have the project and its dependencies installed, if you dont, then refer to the [Installation](/docs/osc-docs/installation) guide.
For more information, see the [Usage](/docs/osc-docs/usage) section. You must have the project and its dependencies installed, if you don't, then refer to the [Installation](/docs/osc-docs/installation) guide.
2 changes: 1 addition & 1 deletion docs/website/Developers/API/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ In the source code, each route occupies a separate file in the [routes folder](h
Express.js is a backend web framework for creating and serving RESTful APIs on NodeJS. It is documented extensively at [expressjs.com](https://expressjs.com/).
:::

Expressjs, otherwise known as Express, implements a simple NodeJS web server. It defines a relative routing path and a series of middleware to use with each function. Each middleware iis a JavaScript function that accepts an HTTP request (the `req` variable) and a respone object (the `res` variable). The `res` variable is an interface for sending responses back to users.
Expressjs, otherwise known as Express, implements a simple NodeJS web server. It defines a relative routing path and a series of middleware to use with each function. Each middleware is a JavaScript function that accepts an HTTP request (the `req` variable) and a response object (the `res` variable). The `res` variable is an interface for sending responses back to users.

Example:
```js
Expand Down
2 changes: 1 addition & 1 deletion docs/website/Developers/API/blog.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ The server responds with the modified JSON blog object
}
```

If the `_id` and `date` keys are ommitted, then the above response example may also be used as a sample request body. Note that all schema keys are optional: only the key/values that the client wishes to modify need to be specified.
If the `_id` and `date` keys are omitted, then the above response example may also be used as a sample request body. Note that all schema keys are optional: only the key/values that the client wishes to modify need to be specified.

If the ':id' parameter is invalid, the following JSON object is returned:

Expand Down
2 changes: 1 addition & 1 deletion docs/website/Developers/API/contact.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The contact route is defined in [/routes/contact.js](https://github.com/ufosc/Cl

## Submit Contact Form: (POST) /api/contact/

This route expects the contact form's field data (as JSON). If the data is succesfully validated, it sends an email to the admin account notifying it of the new message, whilst also sending a receipt of the submitted form to the specified email address of the submitter.
This route expects the contact form's field data (as JSON). If the data is successfully validated, it sends an email to the admin account notifying it of the new message, whilst also sending a receipt of the submitted form to the specified email address of the submitter.

Email protocol interfacing is achieved via an SMTP server, which receives and processes outgoing server mail. For configuration instructions, see [configuration](/docs/website/Developers/configuration).

Expand Down
4 changes: 2 additions & 2 deletions docs/website/Developers/Databases/image-storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ sidebar_position: 3

# Image Storage

The images API route exists to serve image content for blog articles. To minimise latency, images are stored on the server's hard disk, whilst image metadata lives on the database. The purpose of the metadata is to assert the image's existence, physical location, description, and API path.
The images API route exists to serve image content for blog articles. To minimize latency, images are stored on the server's hard disk, whilst image metadata lives on the database. The purpose of the metadata is to assert the image's existence, physical location, description, and API path.

If you'd like to learn more about the type of metadata that's stored, refer to [models/images.js](https://github.com/ufosc/Club_Website_2/blob/main/model/images.js).

## Express Multer

The [Express Multer](https://expressjs.com/en/resources/middleware/multer.html) library enables the Express webserver to do multiplexing. Consequently, this means that it can receive multiform and multipart data (data that takes multiple requests to transmit, i.e large image files). The library is configured to save incoming image files to the disk (`/uploads`) folder:
The [Express Multer](https://expressjs.com/en/resources/middleware/multer.html) library enables the Express web server to do multiplexing. Consequently, this means that it can receive multiform and multipart data (data that takes multiple requests to transmit, i.e large image files). The library is configured to save incoming image files to the disk (`/uploads`) folder:

```js title="routes/images.js"
const multer = require('multer')
Expand Down
2 changes: 1 addition & 1 deletion docs/website/Developers/caching.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_position: 6

# Caching

Caching allows the website's server to imporove performance and preserve CPU by storing time-insensitive data in memory. Its most common use case is in serving the home and blog pages: instead of dynamically re-rendering the same page for each user request, it is rendered only once and then served from memory. Naturally, the cache updates its data after some predetermined time period, configurable by the [CACHE_INTERVAL](/docs/website/Developers/configuration#caching) environment variable.
Caching allows the website's server to improve performance and preserve CPU by storing time-insensitive data in memory. Its most common use case is in serving the home and blog pages: instead of dynamically re-rendering the same page for each user request, it is rendered only once and then served from memory. Naturally, the cache updates its data after some predetermined time period, configurable by the [CACHE_INTERVAL](/docs/website/Developers/configuration#caching) environment variable.

## Cache Module

Expand Down
6 changes: 3 additions & 3 deletions docs/website/Developers/contributing-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ We recommend adding the following prefixes to your commit messages. These aren't
- `fix: ...`: For when you've fixed something.
- `lint: ...`: For when you've fixed/changed code syntax.
- `refactor: ...`: For when you've rewritten or reorganized something. Use this if you've moved files or created folders. This is different from `lint` because it doesn't necessarily describe syntactical changes, it describes organizational changes.
- Does your specific change not apply to any of these? Use your own best judgement.
- Does your specific change not apply to any of these? Use your own best judgment.
## Pull Requests
1. Always discuss big changes with by speaking to your group, by contacting a maintainer or by opening a discussion issue (see [opening issues](#opening-issues)). This increases the likelihood that they'll be accepted.
2. Always open pull requests on the `main` branch.
Expand All @@ -96,7 +96,7 @@ We recommend adding the following prefixes to your commit messages. These aren't
4. (Optional) Add a screenshot.
5. (Optional) Add the github `bug` or `error` label.
### Typos
Dont open issues for typos, just fix them and create a PR.
Don't open issues for typos, just fix them and create a PR.
### Fixing issues and implementing proposals
Please ask (by replying to the conversation) before trying to fix an issue or implement a feature proposal. Don't waste your time: the issue might be outdated, someone else might already be assigned or we might be waiting for more information.
## Standard README
Expand All @@ -122,7 +122,7 @@ Refer to this guideline on what labels to use and look for when deciding on what
- `wontfix`: Won't be worked on anymore.
## Maintainers
1. Review all PRs before merging.
2. When upgarding the release version:
2. When upgrading the release version:
- Create a `BUMP X.X.X` commit message (where `X.X.X` is the version). If anyone ever wants to revert to a particular version, they can just modify the git history head to point to this commit.
- The `package.json` contains a version tag, make sure it gets updated.
- Create a github release.
Expand Down
4 changes: 2 additions & 2 deletions docs/website/Developers/rendering.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_position: 3

# Rendering Pages

The OSC website uses EJS to dynamically render HTML pages. EJS stands for "embedded JavaScript templates," and allows developers to write HTML with JavaScript code that gets executed prior to the user's request. It is simillar to PHP in the sense that the server will process the file, replace each EJS JavaScript template with HTML, and ultimately return an HTML page.
The OSC website uses EJS to dynamically render HTML pages. EJS stands for "embedded JavaScript templates," and allows developers to write HTML with JavaScript code that gets executed prior to the user's request. It is similar to PHP in the sense that the server will process the file, replace each EJS JavaScript template with HTML, and ultimately return an HTML page.

For documentation on EJS, see [EJS](https://ejs.co/).

Expand All @@ -26,7 +26,7 @@ EJS files accept standard HTML, with the exception of certain tags which will ac
<% } %>
```

The template may then be renderred by the following JavaScript code:
The template may then be rendered by the following JavaScript code:
```js
const express = require('express')
const app = express()
Expand Down
2 changes: 1 addition & 1 deletion docs/website/Developers/testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Any contribution to the OSC Website source code must pass testing and linting wo

## Test Index

Sourcecode and documentation indices for currently available unit tests.
Source code and documentation indices for currently available unit tests.

* Blog API Route Tests: [GitHub](https://github.com/ufosc/Club_Website_2/blob/main/test/blog.spec.js) or [Docs](/docs/website/Developers/API/blog).
* Cache Tests: [GitHub](https://github.com/ufosc/Club_Website_2/blob/main/test/cache.spec.js) or [Docs](/docs/website/Developers/caching).
Expand Down
16 changes: 8 additions & 8 deletions docs/website/admin.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,14 +51,14 @@ Regardless of whether you choose to edit or create, you should be redirected to

The form fields are described below:

| Field | Description |
|-----------|-------------|
| Title | The title of the blog post |
| Author | The author of the blog post |
| Subtitle | The subtitle of the blog post, which will appear directly <br/>below the title. |
| Cover Image URL | The cover image is the article's thumbnail. If left <br/> blank, a default image will automatically be used. |
| Content | The content body of the blog post. Supports HTML. |
| Status | Selecting 'published' will publish the post immediately. <br/> Selecting 'draft' will save it for later. |
| Field | Description |
|-----------------|--------------------------------------------------------------------------------------------------------------|
| Title | The title of the blog post |
| Author | The author of the blog post |
| Subtitle | The subtitle of the blog post, which will appear directly <br/>below the title. |
| Cover Image URL | The cover image is the article's thumbnail. If left <br/> blank, a default image will automatically be used. |
| Content | The content body of the blog post. Supports HTML. |
| Status | Selecting 'published' will publish the post immediately. <br/> Selecting 'draft' will save it for later. |

:::tip Using Uploaded Images

Expand Down
4 changes: 2 additions & 2 deletions src/pages/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@ Each semester, members meet and collaborate to build open source projects. Their

<hr />

## Documetation Index
## Documentation Index

* [Club Archive](/docs/club): Archive of club presentations, notes, etc.
* [OSC Website](/docs/website): User & Developer Documentation for the [OSC website](https://ufosc.org).
* [OSC Docs](/docs/osc-docs): Developer Documentation for the OSC Docs website.

## Contributing

All projects by the UF Open Source Club are governed by open-source licenses. In nearly all projecs, you are allowed and encouraged to make contributions - as long as they likewise adhere to the project's respective license. You can browse available projects on the [GitHub UF OSC page](https://github.com/ufosc).
All projects by the UF Open Source Club are governed by open-source licenses. In nearly all projects, you are allowed and encouraged to make contributions - as long as they likewise adhere to the project's respective license. You can browse available projects on the [GitHub UF OSC page](https://github.com/ufosc).

If you wish to contribute to OSC Docs, navigate to its [GitHub Repository](https://github.com/ufosc/osc-docs). Alternatively, clicking on the "Edit this page" button on your desired documentation page will redirect you to the source code for that particular page, where you'll be able to contribute.

Expand Down

0 comments on commit 0faa887

Please sign in to comment.