Merge branch 'main' into doc-config-options

Author: bmcutler

Gemfile

@@ -2,12 +2,12 @@
 source 'https://rubygems.org'
 
 group :jekyll_plugins do
-  gem "github-pages", "231"
+  gem "github-pages", "232"
 end
 
 gem 'wdm', '>= 0.1.1' if Gem.win_platform?
 
-gem "webrick", "~> 1.8"
+gem "webrick", "~> 1.9"
 
 gem 'html-proofer', "~> 3.19.4"
 

Gemfile.lock

@@ -1,7 +1,7 @@
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.1.3.2)
+    activesupport (7.1.3.4)
       base64
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
@@ -11,19 +11,20 @@ GEM
       minitest (>= 5.1)
       mutex_m
       tzinfo (~> 2.0)
-    addressable (2.8.6)
-      public_suffix (>= 2.0.2, < 6.0)
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
     base64 (0.2.0)
-    bigdecimal (3.1.7)
+    bigdecimal (3.1.8)
     coffee-script (2.4.1)
       coffee-script-source
       execjs
     coffee-script-source (1.12.2)
     colorator (1.1.0)
     commonmarker (0.23.10)
-    concurrent-ruby (1.2.3)
+    concurrent-ruby (1.3.3)
     connection_pool (2.4.1)
-    dnsruby (1.71.0)
+    csv (3.3.0)
+    dnsruby (1.72.2)
       simpleidn (~> 0.2.1)
     drb (2.2.1)
     em-websocket (0.5.3)
@@ -33,20 +34,21 @@ GEM
       ffi (>= 1.15.0)
     eventmachine (1.2.7)
     execjs (2.9.1)
-    faraday (2.9.0)
+    faraday (2.10.1)
       faraday-net_http (>= 2.0, < 3.2)
-    faraday-net_http (3.1.0)
+      logger
+    faraday-net_http (3.1.1)
       net-http
-    ffi (1.16.3)
-    ffi (1.16.3-x64-mingw-ucrt)
+    ffi (1.17.0-arm64-darwin)
+    ffi (1.17.0-x86_64-linux-gnu)
     forwardable-extended (2.6.0)
     gemoji (4.1.0)
-    github-pages (231)
+    github-pages (232)
       github-pages-health-check (= 1.18.2)
-      jekyll (= 3.9.5)
+      jekyll (= 3.10.0)
       jekyll-avatar (= 0.8.0)
       jekyll-coffeescript (= 1.2.2)
-      jekyll-commonmark-ghpages (= 0.4.0)
+      jekyll-commonmark-ghpages (= 0.5.1)
       jekyll-default-layout (= 0.1.5)
       jekyll-feed (= 0.17.0)
       jekyll-gist (= 1.5.0)
@@ -83,9 +85,10 @@ GEM
       liquid (= 4.0.4)
       mercenary (~> 0.3)
       minima (= 2.5.1)
-      nokogiri (>= 1.13.6, < 2.0)
+      nokogiri (>= 1.16.2, < 2.0)
       rouge (= 3.30.0)
       terminal-table (~> 1.4)
+      webrick (~> 1.8)
     github-pages-health-check (1.18.2)
       addressable (~> 2.3)
       dnsruby (~> 1.60)
@@ -104,11 +107,12 @@ GEM
       typhoeus (~> 1.3)
       yell (~> 2.0)
     http_parser.rb (0.8.0)
-    i18n (1.14.4)
+    i18n (1.14.5)
       concurrent-ruby (~> 1.0)
-    jekyll (3.9.5)
+    jekyll (3.10.0)
       addressable (~> 2.4)
       colorator (~> 1.0)
+      csv (~> 3.0)
       em-websocket (~> 0.5)
       i18n (>= 0.7, < 2)
       jekyll-sass-converter (~> 1.0)
@@ -119,16 +123,17 @@ GEM
       pathutil (~> 0.9)
       rouge (>= 1.7, < 4)
       safe_yaml (~> 1.0)
+      webrick (>= 1.0)
     jekyll-avatar (0.8.0)
       jekyll (>= 3.0, < 5.0)
     jekyll-coffeescript (1.2.2)
       coffee-script (~> 2.2)
       coffee-script-source (~> 1.12)
     jekyll-commonmark (1.4.0)
       commonmarker (~> 0.22)
-    jekyll-commonmark-ghpages (0.4.0)
-      commonmarker (~> 0.23.7)
-      jekyll (~> 3.9.0)
+    jekyll-commonmark-ghpages (0.5.1)
+      commonmarker (>= 0.23.7, < 1.1.0)
+      jekyll (>= 3.9, < 4.0)
       jekyll-commonmark (~> 1.4.0)
       rouge (>= 2.0, < 5.0)
     jekyll-default-layout (0.1.5)
@@ -214,7 +219,7 @@ GEM
       gemoji (>= 3, < 5)
       html-pipeline (~> 2.2)
       jekyll (>= 3.0, < 5.0)
-    json (2.7.2)
+    json (2.12.2)
     kramdown (2.4.0)
       rexml
     kramdown-parser-gfm (1.1.0)
@@ -223,34 +228,34 @@ GEM
     listen (3.9.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
+    logger (1.6.0)
     mercenary (0.3.6)
     minima (2.5.1)
       jekyll (>= 3.5, < 5.0)
       jekyll-feed (~> 0.9)
       jekyll-seo-tag (~> 2.1)
-    minitest (5.22.3)
+    minitest (5.24.1)
     mutex_m (0.2.0)
     net-http (0.4.1)
       uri
-    nokogiri (1.16.3-arm64-darwin)
+    nokogiri (1.16.7-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.16.3-x64-mingw-ucrt)
-      racc (~> 1.4)
-    nokogiri (1.16.3-x86_64-linux)
+    nokogiri (1.16.7-x86_64-linux)
       racc (~> 1.4)
     octokit (4.25.1)
       faraday (>= 1, < 3)
       sawyer (~> 0.9)
     parallel (1.24.0)
     pathutil (0.16.2)
       forwardable-extended (~> 2.6)
-    public_suffix (5.0.4)
-    racc (1.7.3)
+    public_suffix (5.1.1)
+    racc (1.8.1)
     rainbow (3.1.1)
     rb-fsevent (0.11.2)
-    rb-inotify (0.10.1)
+    rb-inotify (0.11.1)
       ffi (~> 1.0)
-    rexml (3.2.6)
+    rexml (3.3.4)
+      strscan
     rouge (3.30.0)
     rubyzip (2.3.2)
     safe_yaml (1.0.5)
@@ -262,35 +267,29 @@ GEM
     sawyer (0.9.2)
       addressable (>= 2.3.5)
       faraday (>= 0.17.3, < 3)
-    simpleidn (0.2.1)
-      unf (~> 0.1.4)
+    simpleidn (0.2.3)
+    strscan (3.1.0)
     terminal-table (1.8.0)
       unicode-display_width (~> 1.1, >= 1.1.1)
     typhoeus (1.4.1)
       ethon (>= 0.9.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unf (0.1.4)
-      unf_ext
-    unf_ext (0.0.9.1)
-    unf_ext (0.0.9.1-x64-mingw-ucrt)
     unicode-display_width (1.8.0)
     uri (0.13.0)
-    wdm (0.2.0)
-    webrick (1.8.1)
+    webrick (1.9.1)
     yell (2.2.2)
 
 PLATFORMS
   arm64-darwin-22
-  x64-mingw-ucrt
+  arm64-darwin-23
   x86_64-linux
 
 DEPENDENCIES
-  github-pages (= 231)
+  github-pages (= 232)
   html-proofer (~> 3.19.4)
   json
-  wdm (>= 0.1.1)
-  webrick (~> 1.8)
+  webrick (~> 1.9)
 
 BUNDLED WITH
    2.5.6

_docs/developer/developing_the_php_site/view.md

@@ -11,7 +11,7 @@ pattern.
 The [Controller](controller) will call the view.  Let's have a look at
 an example `UserView.php`. It might have a function in it like this:
 
-```PHP
+```php
 public function showUserDetails(UserModel $user) {
   $this->core->getOutput()->addInternalJs('user-details.js');
   $this->core->getOutput()->addInternalCss('user-details.css');
@@ -53,4 +53,45 @@ Finally, let's look at `UserDetails.twig`
 ```
 
 In this page, we use `user_id` and `favorite_color` to render information
-about the student.
+about the student.
+
+## Another option: Rendering with Vue
+
+Alternatively, instead of using Twig, we can use [Vue](https://vuejs.org/) instead.
+
+To do this, first make a Vue page in `site/vue/src/pages` (for example, `site/vue/src/pages/UserDetails.vue`): 
+```html
+<script setup lang='ts'>
+  import { inject } from 'vue';
+
+  const userId = inject<string>('user_id') ?? '<no user provided>';
+  const favoriteColor = inject<string>('favorite_color') ?? '<no color provided>';
+</script>
+
+<template>
+  <div class="content">
+    {% raw %}{{ userId }}'s favorite color is {{ favoriteColor }}.{% endraw %}
+  </div>
+</template>
+```
+
+
+To actually render this page, we will then need to use the `renderVue` function in our View (ex. `UserView.php`).
+
+The first paramater of the `renderVue` takes the name of the page (the name of the `.vue` file minus the extension, in this case `UserDetails`), and the second parameter is the same as in `renderTwig`, an associative array of variables that are passed to the Vue page.
+
+If we wanted our `UserView.php` example to render with Vue, it would have a function that might look like this:
+
+```php
+public function showUserDetails(UserModel $user) {
+  return $this->core->getOutput()->renderVue(
+    'UserDetails',
+      [
+        'user_id' => $user->getUserId(),
+        'favorite_color' => $user->getFavoriteColor()
+      ]
+  );
+}
+```
+
+To access the variables passed by the `renderVue` function in Vue, use [`inject`](https://vuejs.org/api/composition-api-dependency-injection.html#inject). The injection keys will be the same as the keys in the provided array. If the key provided to `inject` is not in the array passed to `renderVue`, it will return `undefined`.

_docs/developer/development_instructions/index.md

@@ -250,6 +250,15 @@ these changes.
   missing the hundreds of sample student submissions present in the
   full installation.
 
+  You can append the `--test_only_grading` flag to the above command to
+  more closely mimic the version that is on the Cypress CI.
+
+  If you only need a certain courses, you can append each course name to
+  the above command to only create the courses you want.
+
+  _NOTE: If you mistype a course, that course will not be created. If you
+  only have mistyped courses, then no courses gets created._
+
 
   NOTE: This command will also have to be run twice a year on July 1st and January 1st when the test semester will change from fall to spring or vice versa.
 

_docs/developer/getting_started/commit_to_PR_from_fork.md

@@ -40,7 +40,15 @@ The instructions below are for command line use of git.
     ```
 
     Additionally, find the name of the fork on the fork's page on Github.  
-    The `fork_name` may simply be `Submitty`, or the author may have chosen to another name.
+    The `fork_name` may simply be `Submitty`, or the author may have chosen another name.
+
+    Note: make sure your git credentials are set before pulling or pushing to a forked 
+    repo. You can do this with the following commands. Use the `--global` flag if you 
+    want to set this outside of just Submitty.
+    ```
+    git config user.name "Your Name"
+    git config user.email "Your Email"
+    ```
     
 
 3.  Next, make a local branch on your computer in your working repository