This repository has been archived by the owner on Mar 4, 2023. It is now read-only.

Improve README #4

Open

JokerQyou opened this issue Aug 3, 2019 · 0 comments

Labels

documentation enhancement

Projects

Owner

JokerQyou commented Aug 3, 2019 •

edited

Loading

Let's just put everything in the main README, instead of splitting them into subdirectories. It should include these sections:

Quick start guide:
- How to get a local instance running in 10 seconds?
- How to add extensions?
Production deployment:
- How to add SSL termination via reverse proxy?
- Upgrade guide: how to run migrations?
Advanced topics & development & contribution:
- How to build your own docker images?
- How to use the official Ruby server instead of the Golang server? (Let's do this later)

JokerQyou created this issue from a note in Selfhost (To do)

JokerQyou changed the title ~~Upgrade guide~~ Improve README

JokerQyou added documentation enhancement labels

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.