Skip to content

Commit

Permalink
[Documentation:Developer] Add Codespell Action (Submitty#431)
Browse files Browse the repository at this point in the history
  • Loading branch information
prestoncarman authored Jun 7, 2022
1 parent e2df5c1 commit 26854df
Show file tree
Hide file tree
Showing 40 changed files with 90 additions and 68 deletions.
2 changes: 2 additions & 0 deletions .codespellrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[codespell]
skip = *.png,*.lock,./.git/*,*.jpg,*.js,*.yml,Gemfile,./_sass
20 changes: 20 additions & 0 deletions .github/workflows/codespell.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Check Spelling

on: [push, pull_request]

jobs:
build:
name: Check Spelling
runs-on: ubuntu-latest

steps:
- name: Checkout Code
uses: actions/checkout@v2
with:
fetch-depth: 0

- name: Check Spelling
uses: codespell-project/actions-codespell@master
with:
check_filenames: true
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ The site's content is defined with markdown files under the
[`docs/`](https://github.com/Submitty/submitty.github.io/blob/main/_docs) folder, where
then it's separated by a couple of high-level sections (student, instructor,
sysadmin, developer). For any new page, a new entry must be added to the
navigation manually (see below). The rendered markdown uses a varient of
navigation manually (see below). The rendered markdown uses a variant of
[Github Flavored Markdown](https://github.github.com/gfm/). For every page,
it should have a front-matter block at the top of the file that has minimally:

Expand Down
2 changes: 1 addition & 1 deletion _docs/developer/developing_the_php_site/javascript.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ minified JavaScript file that is served to the user.
Unlike regular JS files, ES6 modules are not included into the global JS scope, and are self-contained. When a module is
executed, it only has access to the things that it imports, and we cannot call functions defined within modules directly from
the DOM. As such, to hook a function defined in a module to something in the DOM, such as a click event listener, you will need to
use the addEventListener API. This seperation of regular JS and modules also extends to HTML, attributes such as `onclick`
use the addEventListener API. This separation of regular JS and modules also extends to HTML, attributes such as `onclick`
and other inline event handlers cannot call functions defined in modules even if they are exported.

JavaScript modules are placed in the `Submitty/site/ts` directory and running the install script will launch esbuild
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ To do this:
```

And similarly from each machine that will be autograding (including
the primary machine, as appropriate), run the worker manger and
the primary machine, as appropriate), run the worker manager and
watch the output:

```
Expand Down
2 changes: 1 addition & 1 deletion _docs/developer/development_instructions/migrations.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ and that we are not left with partial DB upgrades due to a broken script.
To do this, we utilize a custom migration tool written for Submitty,
[migrator](https://github.com/Submitty/Submitty/tree/master/migration). This tool
can be used manually, as well as being baked into the
installation/upgarde procedure of Submitty. For instance, running
installation/upgrade procedure of Submitty. For instance, running
`/usr/local/submitty/.setup/INSTALL_SUBMITTY.sh` will apply any pending
migrations for all environments.

Expand Down
4 changes: 2 additions & 2 deletions _docs/developer/getting_started/project_ideas.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ redirect_from:
Submitty has been selected for participation in
[Google Summer of Code (GSoC) 2022](https://summerofcode.withgoogle.com/).
See [Submitty GSoC Application & Reports](/developer/google_summer_of_code/index) for more information about
the application process and to read reports from Submitty GSoC contributers
the application process and to read reports from Submitty GSoC contributors
from Summers 2018, 2019, and 2020.


Expand Down Expand Up @@ -217,7 +217,7 @@ Tracker](https://github.com/Submitty/Submitty/issues).
Once a potential vulnerability is found, the system must be
promptly patched and documented to prevent future problems.

_Expected Outcomes_: Security risk assessment, indentification and repair
_Expected Outcomes_: Security risk assessment, identification and repair
of specific security vulnerabilities, expansion and creation of continuous
integration tools to prevent introduction of new vulnerabilities.

Expand Down
6 changes: 3 additions & 3 deletions _docs/developer/google_summer_of_code/2019_AnubhavSingh.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ category: Developer > Google Summer of Code 2019

# Discussion Forum Refactor, VPAT & WebSocket Integration

The project was an upgrade to the Discussion Forum module of the Submitty web application. The Discussion Forum allows students in a course to discuss their coursework, allowing image upload, links and code embed. My work over the summer made the Discussion Forum more user friendly in terms of accesibility and speed of using the Forum
The project was an upgrade to the Discussion Forum module of the Submitty web application. The Discussion Forum allows students in a course to discuss their coursework, allowing image upload, links and code embed. My work over the summer made the Discussion Forum more user friendly in terms of accessibility and speed of using the Forum

I am [Anubhav Singh](https://github.com/xprilion), an undergraduate student from [NSEC](https://nsec.ac.in), [Kolkata](https://en.wikipedia.org/wiki/Kolkata), as part of [Google Summer of Code](https://summerofcode.withgoogle.com/).

Expand Down Expand Up @@ -88,7 +88,7 @@ Working with e2e tests using Selenium was new to me, and with continuous support

## Future Scope of Work

I believe my work on the WebSocket opens up new avenues for not just the Discussion Forum but also for the rest of Submitty. It allows the possiblity of making a lot of existing features use the benefit of real time and to make new features which take benefit of it. I would look forward to seeing the following in Submitty in future -
I believe my work on the WebSocket opens up new avenues for not just the Discussion Forum but also for the rest of Submitty. It allows the possibility of making a lot of existing features use the benefit of real time and to make new features which take benefit of it. I would look forward to seeing the following in Submitty in future -

- Forum Search working as an extended filter, generating results on the same page instead of going to a new page.
- Push Notifications to users
Expand All @@ -104,4 +104,4 @@ I had an enriching and exciting summer of 2019, working on Submitty under the [G

I extended gratitude to [Saketh](https://github.com/sak6lab), Han and [Drumil](https://github.com/drumilpatel2000) whose comments/reviews helped me in a number of my PRs.

GSoC with Submitty was a warm and unforgettable experience for me. Everytime I talk of Open Source, Submitty will be remembered fondly.
GSoC with Submitty was a warm and unforgettable experience for me. Every time I talk of Open Source, Submitty will be remembered fondly.
2 changes: 1 addition & 1 deletion _docs/developer/google_summer_of_code/2019_DrumilPatel.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ category: Developer > Google Summer of Code 2019
<b> Automating Configuration For Assignments Uploads </b> is an upgrade to old assignment configuration. Previously all inputs and outputs file was to be provided at time of configuration of assignment this made input and output constant for every submission.
After this project we can add random inputs and corresponding output at the time of submission.This is possible by providing an instructor solution and python script which can generate random inputs. We can also generate only outputs from predefined inputs at the time of building gradeable. This can be used to remove dependencies on predefined output.

I am [Drumil Patel](https://github.com/drumilpatel2000) an undergraduate Electrical Engineer from [Indian Institue of Technology, Roorkee](https://www.iitr.ac.in).
I am [Drumil Patel](https://github.com/drumilpatel2000) an undergraduate Electrical Engineer from [Indian Institute of Technology, Roorkee](https://www.iitr.ac.in).

This project was mentored by [Barbara Cutler](https://github.com/bmcutler), [Evan Maicus](https://github.com/emaicus).

Expand Down
4 changes: 2 additions & 2 deletions _docs/developer/google_summer_of_code/2019_FonNoel.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ As a result, we expected Buildbot, the highly configurable Continues Integration
In general, I was able to set up and have Builbot run builds on pull requests and also changes to the master branch.

The major things are achieved here are :
- Breakdown and seperation of builds, so using thesame concept of build stages distinct sections such as the `migrator`, `site`, and `autograder` where assigned independent Builbot bulders which run more concurrently.
- Breakdown and separation of builds, so using thesame concept of build stages distinct sections such as the `migrator`, `site`, and `autograder` where assigned independent Builbot bulders which run more concurrently.
- There's a dramatic increase in the speed of builds. In practise from between 10mins to 2 hours to less than 5 minutes for the parts that were moved.

<p align="center">
Expand All @@ -64,7 +64,7 @@ To complement work being done on Buildbot, and also to help me understand the st
#### References, major tasks

* Modified python scripts related to generating Sample data for TA notes. [#3885](https://github.com/Submitty/Submitty/pull/3885)
* Added generation of cancelled submitions in sample data. [#3848](https://github.com/Submitty/Submitty/pull/3848)
* Added generation of cancelled submissions in sample data. [#3848](https://github.com/Submitty/Submitty/pull/3848)
* Implemented shorchut buttons for the flatpick date picker. [#3963](https://github.com/Submitty/Submitty/pull/3963)
* Fixed stream errors on Forensics page. [#4053](https://github.com/Submitty/Submitty/pull/4053)

Expand Down
8 changes: 4 additions & 4 deletions _docs/developer/google_summer_of_code/2020_Harsh_Joshi.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Peer matrix options allow to configure the peer grading assignments. My work on

* **Submit before grading** enables the instructor to allow grading to only those students who have submitted their own assignments. Note that this option should only be used when sufficient submissions have been made, usually after the submissions are closed.

* **Download Peer CSV** exports the current peer matrix to csv which can be reuploaded for future/other peer assigments.
* **Download Peer CSV** exports the current peer matrix to csv which can be reuploaded for future/other peer assignments.

* **Clear Peer Matrix** resets the current peer matrix. Note that this option should be used carefully when randomized peer assignments are used as it can't be undone.

Expand All @@ -48,10 +48,10 @@ Sample course contains sample data which is used for various development purpose
Optimized and modularized peer grading assignment function to better suit the unit testing needs.

## Optimized Queries for peer matrix.
Wrote database queries and server side logic to optimize time take to set the peer matrix via upload csv method. The updated logic uses optimized sql queries along with bulk upload function to reduce the number of server interactions with the databse and pushed data at one go.
Wrote database queries and server side logic to optimize time take to set the peer matrix via upload csv method. The updated logic uses optimized sql queries along with bulk upload function to reduce the number of server interactions with the database and pushed data at one go.

## Randomized peer assignmend in sample course
Implemented the randomized peer assigments logic for the sample peer gradeables in the sample course.
Implemented the randomized peer assignments logic for the sample peer gradeables in the sample course.

## Documentation
Wrote documentation at submitty.org for
Expand All @@ -61,7 +61,7 @@ Wrote documentation at submitty.org for

## Review
Reviewed pull request of fellow developers which included PRs on
* Late submission sheck
* Late submission check
* Adding new grader to the peer matrix
* Editing peer matrix
* Upgrading download zip feature for peer gradeables
Expand Down
2 changes: 1 addition & 1 deletion _docs/developer/google_summer_of_code/2020_Marwan_Atef.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ An example for the checkpoint cells updating with websockets
6. Upon message receiving users call the associated function depending on the message type mentioned above (eg. `SocketNewPostHandler()`)
7. The associated function makes an Ajax request to fetch the new post and place it in the correct place in the DOM.

#### Refrences
#### References

* [WebSocket CLient wrapper](https://github.com/Submitty/Submitty/blob/master/site/public/js/websocket.js) `websocket.js`
* [WebSocket Server](https://github.com/Submitty/Submitty/blob/master/site/app/libraries/socket/Server.php) `Server.php`
Expand Down
4 changes: 2 additions & 2 deletions _docs/developer/google_summer_of_code/2020_Mukul_Kumar_Jha.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ Following listed Pull Requests were created during the GSoC timeline under this

- [Plagiarism refactor and mobile page](https://github.com/Submitty/Submitty/pull/5516)
- [[UI/UX:InstructorUI] Plagiarism full screen & resizable panels](https://github.com/Submitty/Submitty/pull/5611)
* Refactored plagarism module code, improved the MVC design flow and synced it with the existing codebase.
* Refactored plagiarism module code, improved the MVC design flow and synced it with the existing codebase.
* Made plagiarism pages compatible across different sized screens.
* Added full screen display and drag-bar to adjust width of the codebox panels.

Expand Down Expand Up @@ -150,7 +150,7 @@ Here are some of [my PRs](https://github.com/Submitty/submitty.github.io/pulls/m

#### Overall Experience

I got introduced to Submitty last year and from the very beginning, I loved the Submitty's objective and friendly environment, thanks to [Matthew Peveler](https://github.com/MasterOdin) for helping me with the onboarding and valueable feedbacks through your reviews.
I got introduced to Submitty last year and from the very beginning, I loved the Submitty's objective and friendly environment, thanks to [Matthew Peveler](https://github.com/MasterOdin) for helping me with the onboarding and valuable feedbacks through your reviews.
I am very thankful to [Barbara Cutler](https://github.com/bmcutler), Submitty, RPI, and the GSoC team for giving me this chance and for bringing in this amazing experience full of learning and fun.
Complete project involved a lot of learning and challenges. I loved collaborating with RPI faculty and students and enjoyed working on the project used by not only RPI but a number of other universities across the globe.
During the whole summer, all of my project mentors were super awesome and super supportive and I learned a lot from them. Special thanks to [Barbara Cutler](https://github.com/bmcutler), [Eli Schiff](https://github.com/elihschiff), [Shail Patel](https://github.com/shailpatels), [Evan Maicus](https://github.com/emaicus), [Matthew Peveler](https://github.com/MasterOdin). They helped me with designing the new interface and gave me interesting developer tips during the whole project, I also enjoyed reviewing other developers code.
Expand Down
4 changes: 2 additions & 2 deletions _docs/developer/ms_phd_students/MS_2021_Hector_Rodriguez.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ happened was a byproduct of the shippers’ original algorithm, summarized below
3. Pick the oldest one, mark it as being graded, and send it to the worker.
4. Unlock the autograding queue directory.
5. Wait for the current submission to finish grading.
6. Retreive the current submission’s results and save them.
6. Retrieve the current submission’s results and save them.
7. Return to Step 1.

Although this works, this has the potential issue of bottlenecking very easily
Expand Down Expand Up @@ -294,6 +294,6 @@ Because of this, it would be interesting to experiment with various different
scheduling algorithms in order to make a system that’s perhaps more “fair” in a
different sense of the word. Furthermore, a more sophisticated algorithm could
help overcome some trickier constraints. For example, a worker might have the
computational capacity to grade mutliple small assignments or one big
computational capacity to grade multiple small assignments or one big
assignment. How “heavy” an assignment is is not something that the scheduler
currently takes into account.
4 changes: 2 additions & 2 deletions _docs/developer/ms_phd_students/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ redirect_from:
- /developer/poster_session
---

### PhD Theses
### PhD Thesis

* Evan Maicus - PhD - *Expected May 2021*

### Masters Theses / Projects
### Masters Thesis / Projects

* [Hector Rodriguez - MS - *Expected May 2021*](MS_2021_Hector_Rodriguez)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ Your CSS file should go in the directory:
/Submitty/site/public/css/
```

Futher, as we are still integrating responsive design to the site, to soft "enable" mobile on
Further, as we are still integrating responsive design to the site, to soft "enable" mobile on
a page, you must explicitly add the following viewport tag to your HTML:
```
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no" />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ redirect_from:
to connect to. The user and password are both `submitty_dbuser`. All tables are then
located in the `public` schema.

We recommed that to connect to the DB that you use one of the following
We recommend that to connect to the DB that you use one of the following
options ranging from simplest to most powerful.

1. [psql](http://postgresguide.com/utilities/psql.html) (CLI for connecting to PostgreSQL)
Expand Down
2 changes: 1 addition & 1 deletion _docs/developer/testing/github_actions.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ the [python](/developer/testing/python_unit_tests) and [PHP](/developer/testing/
unit tests, the [Autograding Integration Tests](/developer/testing/autograding_integration_tests),
and the [Site End-to-End Tests](/developer/testing/site_end_to_end_tests).

Submitty's CI is seperated into different workflows, each workflow contain a number of jobs that run the tests mentioned above. Some jobs can run in parallel and others may depend on other jobs. The workflows are written as yaml files and are located within the repository [here](https://github.com/Submitty/Submitty/tree/master/.github/workflows) under `Submitty/.github/workflows/`.
Submitty's CI is separated into different workflows, each workflow contain a number of jobs that run the tests mentioned above. Some jobs can run in parallel and others may depend on other jobs. The workflows are written as yaml files and are located within the repository [here](https://github.com/Submitty/Submitty/tree/master/.github/workflows) under `Submitty/.github/workflows/`.

Workflows can also be viewed under the [actions tab](https://github.com/Submitty/Submitty/actions) on the GitHub UI for Submitty's repository. Each workflow run and its status will also be listed here for commits pushed to branches and pull requests.

Expand Down
2 changes: 1 addition & 1 deletion _docs/developer/testing/site_end_to_end_tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ a different browser stack by modifying the `setUpClass` method in
You'll need to install the
[ChromeDriver](https://sites.google.com/a/chromium.org/chromedriver/getting-started)
to allow selenium access to utilize Chrome. You can either download the binary
from the above site or use your OS' package manager. For convinence, we list
from the above site or use your OS' package manager. For convenience, we list
some options for installation on Mac, Linux, and Windows below. For any step
that lists `<CHROMEDRIVER_VERSION>`, you will have to determine the appropriate
version using the [Version Selection](https://sites.google.com/a/chromium.org/chromedriver/downloads/version-selection)
Expand Down
2 changes: 1 addition & 1 deletion _docs/grader/queue.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ the current day. As desired, you can click to view all queue events
from the current day. The history displays who was helped, how long
they waited before help arrive, the length of time they were being
helped, and who helped them. The history includes an option to the
student to the queue if they were accidently removed.
student to the queue if they were accidentally removed.

Students, graders, and instructors can view data on the office hours
queue by clicking the "View Queue Stats" button in the Office Hours
Expand Down
6 changes: 3 additions & 3 deletions _docs/grader/rubric_grading/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ into Registration or Rotating sections:
The *white, green, yellow, blue, and purple stoplights* indicate
grading progress per submission. Submissions with incomplete grading
will have a blue "Grade" button. Completed grading will show the
cummulative score for that submission.
cumulative score for that submission.

Clicking on a "Grade" or cummulative score buttons brings up the TA grading interface.
Clicking on a "Grade" or cumulative score buttons brings up the TA grading interface.

The "View All"/"View Your Sections" button switches between viewing all students registered in the course and registration or rotating sections assigned to the grader. This option is not available for limited access graders.

Expand All @@ -38,7 +38,7 @@ and dimensions of these panels.

* **File and Directory Browser** (blue border)
Displays the tree
hierachy of files and directories. The grader can view each of the
hierarchy of files and directories. The grader can view each of the
submission files (the *submissions* directory) and various output and
logging files produced during autograding (the *results* directory).
If this gradeable is submitted via GIT or other VCS, the submission
Expand Down
Loading

0 comments on commit 26854df

Please sign in to comment.