From 57452f9d958b45167a973ad154c85c653d2bd5e7 Mon Sep 17 00:00:00 2001 From: Justin Campbell Date: Fri, 2 Apr 2021 11:05:49 -0400 Subject: [PATCH] Remove unnecessary file --- docs/index.md | 17 ----------------- docs/webqueue2 backend overview.md | 17 ----------------- 2 files changed, 34 deletions(-) delete mode 100644 docs/index.md delete mode 100644 docs/webqueue2 backend overview.md diff --git a/docs/index.md b/docs/index.md deleted file mode 100644 index 000ea34..0000000 --- a/docs/index.md +++ /dev/null @@ -1,17 +0,0 @@ -# Welcome to MkDocs - -For full documentation visit [mkdocs.org](https://www.mkdocs.org). - -## Commands - -* `mkdocs new [dir-name]` - Create a new project. -* `mkdocs serve` - Start the live-reloading docs server. -* `mkdocs build` - Build the documentation site. -* `mkdocs -h` - Print help message and exit. - -## Project layout - - mkdocs.yml # The configuration file. - docs/ - index.md # The documentation homepage. - ... # Other markdown pages, images and other files. diff --git a/docs/webqueue2 backend overview.md b/docs/webqueue2 backend overview.md deleted file mode 100644 index 9c128d3..0000000 --- a/docs/webqueue2 backend overview.md +++ /dev/null @@ -1,17 +0,0 @@ -# *(draft)* Webqueue2 backend overview - -!!! note - *This document should be renamed to `index.md` to make it the default landing page. The current index.md file contains information for mkdocs that maybe useful later* - -## Overview -In order to function, the backend of Webqueue2 relies primarily on two scripts, the `ECNQueue.py` script, and the `api.py` script. These two scripts work in conjuction with eachother inorder to read, parse, and transfer item and queue information created by the `qcli` to the frontend. - -### ECNQueue.py -The `ECNQueue.py` script does all of the data and information parsing. - -Items are currently stored in plain text within text files and all updates to those items are documented directly into those textfiles via the `qcli`. The `ECNQueue.py` script parses these text files and stores all the information regarding the item into a custom `Item` object. - -### api.py -The `api.py` script does all of the interaction between the front end and the `ECNQueue.py` script. - -The front end makes requests, which are then routed to the `api.py` script, which are translated to functions within the `ECNQueue.py`. The json that the `ECNQueue.py` script returns is then returned to the `api.py` script which then routes the json to the frontend. \ No newline at end of file