docs reorganization

Archmonger · Aug 26, 2022 · 466ecf2 · 466ecf2
1 parent 55f3849
commit 466ecf2
Show file tree

Hide file tree

Showing 29 changed files with 242 additions and 153 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,34 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+<!--attr-start-->
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+<!--attr-end-->
+
+<!--
+Using the following categories, list your changes in this order:
+    - "Added" for new features.
+    - "Changed" for changes in existing functionality.
+    - "Deprecated" for soon-to-be removed features.
+    - "Removed" for now removed features.
+    - "Fixed" for any bug fixes.
+    - "Security" in case of vulnerabilities.
+ -->
+
+<!--changelog-start-->
+
+## [Unreleased]
+
+-   Nothing (Yet)
+
+## [0.100.0] - 2021-08-18
+
+### Added
+
+-   App store support
+
+[unreleased]: https://github.com/Archmonger/Conreq/compare/0.100.0...HEAD
+[0.100.0]: https://github.com/Archmonger/Conreq/releases/tag/0.100.0
diff --git a/docs/configure/env_vars.md b/docs/configure/env_vars.md
diff --git a/docs/configure/webserver.md b/docs/configure/webserver.md
diff --git a/docs/develop/run_conreq.md b/docs/develop/run_conreq.md
diff --git a/docs/includes/requirements.md b/docs/includes/requirements.md
@@ -0,0 +1,9 @@
+<!-- conreq -->
+
+-   Install [Python 3.9+](https://www.python.org/downloads/)
+    -   Make sure to select "Add Python 3.x to PATH" during installation.
+    -   Easiest if this is the only version of Python on your computer
+-   Install [Visual Studio C++](https://visualstudio.microsoft.com/visual-cpp-build-tools/) and make sure to select navigate to _C++ Build Tools -> MSVC_ and _C++ Build Tools -> Windows 10 SDK_)
+-   Install a code editor. We recommend [Visual Studio Code](https://code.visualstudio.com/).
+
+<!-- conreq-end -->
diff --git a/docs/develop/apps/api.md → docs/includes/temp.md b/docs/develop/apps/api.md → docs/includes/temp.md
diff --git a/docs/index.md b/docs/index.md
diff --git a/docs/develop/apps/file_structure.md → docs/src/developers/apps/file_structure.md b/docs/develop/apps/file_structure.md → docs/src/developers/apps/file_structure.md
diff --git a/docs/develop/apps/getting_started.md → docs/src/developers/apps/getting_started.md b/docs/develop/apps/getting_started.md → docs/src/developers/apps/getting_started.md
diff --git a/docs/develop/apps/hello_world.md → docs/src/developers/apps/hello_world.md b/docs/develop/apps/hello_world.md → docs/src/developers/apps/hello_world.md
diff --git a/docs/contrib/apps.md → docs/src/developers/contribute/apps.md b/docs/contrib/apps.md → docs/src/developers/contribute/apps.md
diff --git a/docs/develop/code_tldr.md → docs/src/developers/contribute/code_tldr.md b/docs/develop/code_tldr.md → docs/src/developers/contribute/code_tldr.md
@@ -1,22 +1,22 @@
-This guide is intended to help developers gain an understanding of how Conreq was developed.
+This guide is intended to help individuals gain an understanding of how Conreq was developed.
 
 ---
 
 ## Repository File Structure
 
-| Path                                    | Description                                                                                                                                                |
-| --------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `manage.py`                             | Django development tool _(runs the development web server, initialize the databases, [and more.](https://docs.djangoproject.com/en/3.1/ref/django-admin/)_ |
-| `misc/`                                 | Branding, legal documents, and other miscellaneous files                                                                                                   |
-| `conreq/`                               | Main Django application                                                                                                                                    |
-| `conreq/core/`                          | All back-end functionality                                                                                                                                 |
-| `conreq/static/`                        | CSS, JavaScript, and Image files                                                                                                                           |
-| `conreq/utils/`                         | Generic functions that may be helpful to use                                                                                                               |
-| `conreq/settings.py`                    | Boot-time configuration and settings                                                                                                                       |
-| `conreq/urls.py`                        | HTTP URLs                                                                                                                                                  |
-| `conreq/asgi.py`                        | Websocket URLs                                                                                                                                             |
-| `conreq/core/websockets/consumers.py`   | Back-end Websockets                                                                                                                                        |
-| `conreq/static/js/client_websockets.js` | Front-end websockets                                                                                                                                       |
+| Path | Description |
+| --- | --- |
+| `manage.py` | Django development tool _(runs the development web server, initialize the databases, [and more.](https://docs.djangoproject.com/en/3.1/ref/django-admin/)_ |
+| `misc/` | Branding, legal documents, and other miscellaneous files |
+| `conreq/` | Main Django application |
+| `conreq/core/` | All back-end functionality |
+| `conreq/static/` | CSS, JavaScript, and Image files |
+| `conreq/utils/` | Generic functions that may be helpful to use |
+| `conreq/settings.py` | Boot-time configuration and settings |
+| `conreq/urls.py` | HTTP URLs |
+| `conreq/asgi.py` | Websocket URLs |
+| `conreq/core/websockets/consumers.py` | Back-end Websockets |
+| `conreq/static/js/client_websockets.js` | Front-end websockets |
 
 ---
 

diff --git a/docs/contrib/docs.md → docs/src/developers/contribute/docs.md b/docs/contrib/docs.md → docs/src/developers/contribute/docs.md
diff --git a/docs/develop/cli.md → docs/src/developers/interface/cli.md b/docs/develop/cli.md → docs/src/developers/interface/cli.md
diff --git a/docs/src/developers/interface/python.md b/docs/src/developers/interface/python.md
diff --git a/docs/src/developers/setup/requirements.md b/docs/src/developers/setup/requirements.md
@@ -0,0 +1 @@
+{% include-markdown "../../../includes/requirements.md" start="<!-- conreq -->" end="<!-- conreq-end -->" trailing-newlines=false %}
diff --git a/docs/src/developers/setup/run.md b/docs/src/developers/setup/run.md
@@ -0,0 +1,28 @@
+???+ summary
+
+    There are two environments Conreq can exist in: [Development](#creating-a-development-environment) and [Production](#creating-a-production-environment).
+
+    If you intend to edit Conreq's code, then proceed with the Development instructions.
+
+??? info "Special instruction for Windows users"
+
+    Windows users will need to type `set-executionpolicy remotesigned` in terminal and select Yes to All to allow external Python scripts to run on your computer.
+
+You will need to follow the steps below in order to create and run Conreq from source code.
+
+1. Pull the repository from GitHub.
+2. Open a terminal (ex. Command Prompt) as administrator at the root of the repository.
+3. Type `python -m venv .venv` to create a Python virtual environment called ".venv".
+4. Type `./.venv/Scripts/activate` to enter the virtual environment.
+    - The method of doing this may vary based on operating system.
+5. Type `pip install -r requirements.txt` to install all Python dependencies within the virtual environment.
+6. Set your `DEBUG` environment variable to `true`.
+    - This can either be done within system variables, or within Conreq's `settings.env` file.
+    - Doing this disables _a lot_ of **security features**.
+7. Type `python manage.py run_conreq` to run the development webserver.
+
+??? question "How do I convert this to a Production environment?"
+
+    Follow all instructions laid out within [Creating a Development Environment](#creating-a-development-environment), however, set your `DEBUG` environment variable to `false`.
+
+    Then, Conreq will boot in production mode the next time you use `python manage.py run_conreq`.
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -0,0 +1,17 @@
+---
+hide:
+    - navigation
+    - toc
+---
+
+## Welcome to the Conreq Documentation
+
+Conreq is an extensible web app platform built around [Django](https://www.djangoproject.com/). Read through the docs to learn how to set up Conreq, or how to contribute to the Conreq repository!
+
+Want to join the community or have a question? Chat with us on [Discord](https://discord.gg/gQhGZzEjmX) or create a post on [GitHub Discussions](https://github.com/Archmonger/Conreq/discussions)!
+
+---
+
+## Communities
+
+[:fontawesome-brands-discord: Discord](https://discord.gg/gQhGZzEjmX){ .md-button .md-button--primary } [:fontawesome-brands-reddit: Reddit](https://www.reddit.com/r/conreq/){ .md-button .md-button--primary } [:fontawesome-brands-github: GitHub Discussions](https://github.com/Archmonger/Conreq/discussions){ .md-button .md-button--primary }
diff --git a/docs/install/linux.md → docs/src/install/linux.md b/docs/install/linux.md → docs/src/install/linux.md
diff --git a/docs/src/install/unraid.md b/docs/src/install/unraid.md
@@ -0,0 +1,13 @@
+???+ Summary
+
+    Conreq can be installed via Unraid Community Applications on Unraid.
+
+---
+
+1. Install the [Unraid Community Applications](https://forums.unraid.net/topic/38582-plug-in-community-applications/) plugin
+2. Within Unraid's GUI, navigate to the `Apps` tab
+3. Search for `Conreq`
+4. Click install on the docker image from either `selfhosters` or `hotio`.
+    - Both dockers are maintained by trusted community members. An officially supported docker may come in the future.
+
+!!! tip "Unraid is Conreq Team's suggested operating system for deployment."
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		{% include-markdown "../../../includes/requirements.md" start="<!-- conreq -->" end="<!-- conreq-end -->" trailing-newlines=false %}