Merge pull request #13 from mentor-matching-online/remove-jekyll-docs

Remove Jekyll docs
mentor-matching-online · Sep 3, 2023 · 50c9d15 · 50c9d15
2 parents c5eb448 + e5b3be8
commit 50c9d15
Show file tree

Hide file tree

Showing 17 changed files with 8 additions and 420 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,9 +9,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - Users can now edit the weightings, but only for specific attributes, and for the pre-existing calculation
 
+## [3.0.0] - 2022-06-26
+
+### Changed
 
+The licence for this code has changed from MIT to Open Government Licence. This should not radically change how you
+use the software, but because it is a licence change it is breaking - hence the major bump
 
-[2.5.0]
+## [2.5.0]
 
 ### Added
 This release adds the notification workflow, using GOV.UK Notify. Getting from the "matching" to the "notification"
@@ -24,13 +29,6 @@ you lucky people. As ever the entire system can be brought up with `docker-compo
 `localhost:4000`. Documentation is so important for an open-source system like ours, so additions to that are just
 as welcome as code changes.
 
-## [3.0.0] - 2022-06-26
-
-### Changed
-
-The licence for this code has changed from MIT to Open Government Licence. This should not radically change how you
-use the software, but because it is a licence change it is breaking - hence the major bump
-
 ## [2.4.0] - 2022-06-26
 
 ### Added

diff --git a/README.md b/README.md
@@ -8,16 +8,13 @@ It uses [this package](https://github.com/jonodrew/mentor-match-package) to calc
 
 This service is free and open source. It welcomes pull requests, feature suggestions, improvements to grammar, spelling, or any other way folks want to help.
 
-Our roadmap is hosted [here on GitHub](https://github.com/users/jonodrew/projects/1). Make feature suggestions by
-raising an issue on this repo.
+Our roadmap is hosted [here on GitHub](https://github.com/users/jonodrew/projects/1). Make feature suggestions by raising an issue on this repo.
 
 ## Architecture
 This service has three main parts: a web server, running Flask; a Celery worker; and a Redis instance. The long-running task of matching mentors and mentees is passed off to the Celery worker via Redis, which acts as the broker. Results are also stored in Redis and retrieved by the Flask app as needed.
 
 The Flask app is very basic: mostly HTML and basic routes, with a smidgeon of javascript to keep the user interested in what's happening while they wait for their results. That needs some work **so pull requests are welcome**.
 
-Docs are served with Jekyll.
-
 ## Setup
 
 To use this software your local machine, you will need:
@@ -33,7 +30,6 @@ By default, the service can be accessed on the following ports:
 |---------|------|
 | flask   | 5001 |
 | redis   | 6379 |
-| docs    | 4000 |
 
 ## Installing dependencies
 
@@ -51,8 +47,7 @@ From the repository folder, in the command line run:
 docker-compose up
 ```
 
-You should now be able to access the service on the `localhost:` followed by the ports above. I recommend starting
-with [the docs](localhost:4000), so you can come back here and keep going!
+You should now be able to access the service on the `localhost:` followed by the ports above. 
 
 To stop the service at any time, just press the control (<kbd>Ctrl</kbd>) key and <kbd>C</kbd> key together.
 

diff --git a/docker-compose.override.yml b/docker-compose.override.yml
@@ -6,11 +6,3 @@ services:
     environment:
       - USERNAME=CSLGBT
       - PASSWORD=HorseBatteryStapleCorrect
-
-  jekyll:
-    build:
-      context: "./docs/"
-    ports:
-      - "4000:4000"
-    volumes:
-      - ./docs:/srv/jekyll
diff --git a/docs/.gitignore b/docs/.gitignore
diff --git a/docs/404.html b/docs/404.html
diff --git a/docs/CNAME b/docs/CNAME
diff --git a/docs/Dockerfile b/docs/Dockerfile
diff --git a/docs/Gemfile b/docs/Gemfile
diff --git a/docs/_config.yml b/docs/_config.yml
diff --git a/docs/_docs/architecture.md b/docs/_docs/architecture.md
diff --git a/docs/_docs/contributing.md b/docs/_docs/contributing.md
diff --git a/docs/_docs/cookies.md b/docs/_docs/cookies.md
diff --git a/docs/_docs/getting-started.md b/docs/_docs/getting-started.md
diff --git a/docs/_docs/licences.md b/docs/_docs/licences.md