added vuepress documentation to site

Author: briancaffey

.gitlab-ci.yml

@@ -20,7 +20,11 @@ Build Documentation:
   before_script:
     - echo "ok"
   script:
-    - ./documentation/build_docs.sh
+    - ./documentation/build_documentation.sh
+  artifacts:
+    paths:
+      - documentation/docs/.vuepress/public
+    expire_in: 7 days
 
 .Pytest:
   image: python:3.7

README.md

@@ -29,6 +29,17 @@ Open `http://localhost` in your browser.
 
 You can specify environment variables for docker-compose by adding an `.env` file to the root of the project based on `.env.template`.
 
+## VuePress Documentation
+
+This project uses VuePress for documentation. To view the documentation site locally, run the following command:
+
+```bash
+docker-compose -f compose/docs.yml up --build
+```
+
+This will make the docs available at `http://localhost:8082/docs/`. Hot-reloading through websockets is supported, so changes will show up as they are saved in your code editor.
+
+
 ### Access Django Shell in Jupyter Notebook
 
 With all containers running, run the following commands:
@@ -88,6 +99,5 @@ docker-compose -f docker-compose.ci.yml -f cypress.yml up
 - Put django apps in apps folder
 - Redeploy django app to check settings files
 - Add GitLab pages site for Group project
-- Decide how to build the documentation site (quasar, vuepress?)
 - Add file upload examples with Django REST Framework
 - Setup password reset

compose/docs.yml

@@ -2,10 +2,12 @@ version: '3.7'
 
 services:
   vuepress:
+    container_name: vuepress
     build:
       context: ../documentation
     command: ["sh", "/app/start_dev.sh"]
     ports:
-      - "8082:8082"
+      - "8082:8080"
+      - "8081:8081"
     volumes:
-      - ./documentation/docs:/app/docs
+      - ../documentation/docs:/app/docs

docker-compose.yml

@@ -32,7 +32,7 @@ services:
     environment:
     - REDIS_HOST=redis
     ports:
-    - "8081:8081"
+    - "8085:8081"
     networks:
       - main
 

documentation/docs/.vuepress/config.js

@@ -1,7 +1,7 @@
 module.exports = {
   title: 'Verbose Equals True',
   base: '/docs/',
-  port: 8082,
+  port: 8080,
   dest: "public",
   plugins: {
     '@vuepress/google-analytics': {

documentation/docs/README.md

@@ -13,3 +13,5 @@ features:
   details: This project aims to be accessible to people with all levels of skill.
 footer: MIT Licensed | Copyright © 2018-present Brian Caffey
 ---
+
+Home page?

quasar/src/pages/Services/documentation.js

@@ -1,4 +1,11 @@
 const documentationLinks = [
+  {
+    icon: "book",
+    name: "Documentation for this project",
+    href: "http://localhost:8082/docs/",
+    type: "a",
+    target: "_blank"
+  },
   {
     name: "Django",
     href: "https://docs.djangoproject.com/en/2.2/",

quasar/src/pages/Services/services.js

@@ -1,11 +1,4 @@
-const services = [
-  {
-    icon: "local_florist",
-    name: "Flower",
-    href: "http://localhost/flower",
-    type: "a",
-    target: "_blank"
-  },
+let services = [
   {
     icon: "verified_user",
     name: "Django",
@@ -14,16 +7,16 @@ const services = [
     target: "_blank"
   },
   {
-    icon: "email",
-    name: "Mailhog",
-    href: "http://localhost:8025",
+    icon: "local_florist",
+    name: "Flower",
+    href: "http://localhost/flower",
     type: "a",
     target: "_blank"
   },
   {
-    icon: "storage",
-    name: "Redis Commander",
-    href: "http://localhost:8081",
+    icon: "email",
+    name: "Mailhog",
+    href: "http://localhost:8025",
     type: "a",
     target: "_blank"
   },
@@ -36,4 +29,16 @@ const services = [
   }
 ];
 
+if (process.env.NODE_ENV === "development") {
+  services = [ ...services,
+    {
+      icon: "storage",
+      name: "Redis Commander",
+      href: "http://localhost:8081",
+      type: "a",
+      target: "_blank"
+    }
+  ];
+}
+console.log(JSON.stringify(services));
 export default services;