yorktechsoc · chriscn · May 21, 2023 · May 21, 2023 · May 21, 2023 · May 21, 2023
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -5,8 +5,7 @@
 
 version: 2
 updates:
-  - package-ecosystem: "npm" # See documentation for possible values
+  - package-ecosystem: "pip" # See documentation for possible values
     directory: "/" # Location of package manifests
     schedule:
       interval: "weekly"
-
diff --git a/.github/workflows/deploy-docusaurus.yml b/.github/workflows/deploy-docusaurus.yml
diff --git a/.github/workflows/deploy-mkdocs.yml b/.github/workflows/deploy-mkdocs.yml
@@ -0,0 +1,34 @@
+name: Deploy Wiki to GitHub Pages
+
+on:
+  push:
+    branches:
+      - main
+
+concurrency:
+  group: 'pages'
+  cancel-in-progress: true
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+jobs:
+  deploy:
+    name: Deploy to GitHub Pages
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.x
+      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 
+      - uses: actions/cache@v3
+        with:
+          key: mkdocs-material-${{ env.cache_id }}
+          path: .cache
+          restore-keys: |
+            mkdocs-material-
+      - run: pip install mkdocs-material 
+      - run: mkdocs gh-deploy --force
diff --git a/.github/workflows/test-pr.yml b/.github/workflows/test-pr.yml
diff --git a/LICENSE.txt b/LICENSE.txt
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Technical Theatre Society
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -1,23 +1,33 @@
 # Technical Theatre Wiki
 
-This is the repository for the Technical Theatre Wiki, a collection of guides and resources for technical theatre at the University of York. The website is build using [Docasaurus](https://docusaurus.io/), a static site generator for documentation websites.
+This is the repository for the Technical Theatre Wiki, a collection of guides and resources for technical theatre at the University of York. The website is build using [MkDocs](https://www.mkdocs.org/), a static site generator for documentation. The decision was taken to use this instead of Docusaurus to allow for easier contribution from non-technical members of the society.
 
 ## Local Development / Contributing
 
-In order to contribute to the wiki, you will need to have [Node.js](https://nodejs.org/en/) installed. Once you have done this, you can clone the repository and install the dependencies:
+To develop the Wiki to add new pages, edit existing pages, or fix typos, you will need to install MkDocs. This can be done using `pip`:
+
+Firstly, create a virtual environment, activate it, and install the dependencies:
 
 ```bash
-npm install
+python3 -m venv venv
+source venv/bin/activate
+pip install -r requirements.txt
 ```
 
-You can then run the development server:
+Then run the local development instance using:
 
 ```bash
-npm run start
+mkdocs serve
 ```
 
-This will start a local development server at `http://localhost:3000`. You can then make changes to the website and see them reflected in real time.
+This will start a local development server on port 8000. You can view the site by navigating to [localhost:8000](http://localhost:8000) in your browser.
 
 ## Deployment
 
 The site is automatically built and deployed using [GitHub Actions](https://docs.github.com/en/actions) to [wiki.yorktechsoc.org](wiki.yorktechsoc.org). The site is built and deployed on every push to the `main` branch.
+
+## With Thanks To
+
+- Jamie Waters
+- John Cherry
+- Christopher Nethercott
diff --git a/babel.config.js b/babel.config.js
diff --git a/docs/equipment/index.md b/docs/equipment/index.md
@@ -0,0 +1,3 @@
+# Equipment
+
+In this section you'll find details about our equipment; mainly the technical aspects. If you're not sure contact the equipment team!
diff --git a/docs/equipment/lighting/MAC700.md b/docs/equipment/lighting/MAC700.md
@@ -0,0 +1 @@
+# MAC 700s
diff --git a/docs/equipment/lighting/index.md b/docs/equipment/lighting/index.md
@@ -0,0 +1,3 @@
+# Lighting
+
+It's bright baby
diff --git a/docs/equipment/lighting/uplighter.md b/docs/equipment/lighting/uplighter.md
@@ -0,0 +1,3 @@
+# Uplighter
+
+We have two types of uplighters
diff --git a/static/img/favicon.ico → docs/img/favicon.ico b/static/img/favicon.ico → docs/img/favicon.ico
diff --git a/static/img/TT.png → docs/img/logo.png b/static/img/TT.png → docs/img/logo.png
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,5 @@
+# Welcome to the Technical Theatre Wiki
+
+This is the repository for the Technical Theatre Wiki, a collection of guides and resources for technical theatre at the University of York. You'll find technical documentation on our equipment and processes.
+
+You may be looking for our [website](https://yorktechsoc.org) instead; or if you need to contact us at [techsoc@yusu.org](mailto:techsoc@yusu.org).
diff --git a/docs/processes/index.md b/docs/processes/index.md
@@ -0,0 +1,3 @@
+# Our Processes
+
+We have a number of processes that we follow to ensure that we can provide the best service possible to our clients. This include safety, new member training, and how we manage our equipment. You can find out more about each of these processes below; they may be useful if you're looking to join the society, or if you're a client looking to hire us. If you have any questions, please contact the committee.
diff --git a/docusaurus.config.js b/docusaurus.config.js
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,23 @@
+site_name: Technical Theatre Wiki
+site_description: A wiki for the Technical Theatre Society at the University of York
+site_author: University of York's Technical Theatre Society et all
+
+theme:
+  name: material
+  logo: img/logo.png
+  favicon: img/favicon.ico
+  features:
+    - navigation.instant
+    - navigation.sections
+    - navigation.indexes
+
+extra:
+  social:
+    - icon: fontawesome/brands/github
+      link: https://github.com/yorktechsoc
+    - icon: fontawesome/brands/twitter
+      link: https://twitter.com/UoYTechSoc
+
+copyright: "Made with <3 by York Tech Soc"
+
+repo_url: https://github.com/yorktechsoc/wiki
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Equipment

		In this section you'll find details about our equipment; mainly the technical aspects. If you're not sure contact the equipment team!
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Our Processes

		We have a number of processes that we follow to ensure that we can provide the best service possible to our clients. This include safety, new member training, and how we manage our equipment. You can find out more about each of these processes below; they may be useful if you're looking to join the society, or if you're a client looking to hire us. If you have any questions, please contact the committee.