From 9a30b975095a6ac43f8a14b886b87db130ca9b89 Mon Sep 17 00:00:00 2001 From: Kaitlyn Parkhurst Date: Sun, 20 Nov 2022 18:34:00 -0800 Subject: [PATCH] Docs --- README.md | 32 +++++++++++++++++--------------- 1 file changed, 17 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index a668696..85589f9 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,35 @@ -# Table of Contents +# MyJekyllBlog + +MyJekyllBlog is an all-in-one multi-user CMS and hosting platform for Jekyll blogs. + +Administrators can log into the web panel and configure hosted domains that users can host blogs under (i.e. hosted-blog.com). + +Users can log into the web panel and configure a blog on their own domain or a subdomain of the hosted domains (i.e. mycookingblog.hosted-blog.com). Once they have a blog, they can use the CMS features to create posts, upload media, and otherwise manage their blog. + +Whenever a user updates their blog, the blog is rebuilt and deployed the to webservers. Each update is a git commit, and a history panel allows users to restore their blog to any past state. + +MyJekyllBlog comes with a complete set of ansible roles to automate the installation. + +## Table of Contents 1. [MyJekyllBlog](#myjekyllblog) - 1. [Meet The Servers](#meet-the-servers) + 1. [Table Of Contents](#table-of-contents) + 2. [Meet The Servers](#meet-the-servers) 1. [Panel](#panel) 2. [Build](#build) 3. [Store](#store) 4. [Certbot](#certbot) 5. [WebServer](#webserver) - 2. [Overview](#overview) + 3. [Overview](#overview) 2. [Installation Guide](#installation-guide) 1. [Designing The Network](#designing-the-network) 2. [Running The Installation With Ansible](#running-the-installation-with-ansible) 3. [Configure The Panel](#configure-the-panel) 4. [Configure The Store](#configure-the-store) 3. [Development Guide](#development-guide) -3. [Operations Guide](#operations-guide) +4. [Operations Guide](#operations-guide) -# MyJekyllBlog - -MyJekyllBlog is an all-in-one multi-user CMS and hosting platform for Jekyll blogs. - -Administrators can log into the web panel and configure hosted domains that users can host blogs under (i.e. hosted-blog.com). - -Users can log into the web panel and configure a blog on their own domain or a subdomain of the hosted domains (i.e. mycookingblog.hosted-blog.com). Once they have a blog, they can use the CMS features to create posts, upload media, and otherwise manage their blog. - -Whenever a user updates their blog, the blog is rebuilt and deployed the to webservers. Each update is a git commit, and a history panel allows users to restore their blog to any past state. - -MyJekyllBlog comes with a complete set of ansible roles to automate the installation. ## Meet The Servers