From bc3b3aa83e8eda621fe1e71b0d65e70d3ef01313 Mon Sep 17 00:00:00 2001 From: Revant Nandgaonkar Date: Thu, 25 Feb 2021 15:29:54 +0530 Subject: [PATCH] docs: improve docs Add section about wiki in contribution section Mention about wiki in README Mention about cron job in README [skip travis] --- CONTRIBUTING.md | 4 ++++ README.md | 6 ++++++ 2 files changed, 10 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index debf9c61..6e1bc6da 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -32,3 +32,7 @@ Please be considerate when pushing commits and opening PR for multiple branches, # Documentation Place relevant markdown file(s) in the `docs` directory and index them in README.md located at the root of repo. + +# Wiki + +Add alternatives that can be used optionally along with frappe_docker. Add articles to list on home page as well. diff --git a/README.md b/README.md index 3a47895e..f4390a56 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,11 @@ It takes care of the following: * Setting up all the system requirements: eg. MariaDB, Node, Redis. * Configure networking for remote access and setting up LetsEncrypt. +It doesn't take care of the following: + +* Cron Job to backup sites is not created by default. +* Use `CronJob` on k8s or refer wiki for alternatives. + 1. Single Server Installs 1. [Single bench](docs/single-bench.md). Easiest Install! 2. [Multi bench](docs/multi-bench.md) @@ -45,6 +50,7 @@ It takes care of the following: 4. [Environment Variables](docs/environment-variables.md) 5. [Custom apps for production](docs/custom-apps-for-production.md) 6. [Tips for moving deployments](docs/tips-for-moving-deployments.md) +7. [Wiki for optional recipes](https://github.com/frappe/frappe_docker/wiki) ## Development Setup