accounting/frappe_docker
2
0
Fork 0
mirror of https://github.com/frappe/frappe_docker.git synced 2024-11-08 14:21:05 +00:00
Code Issues Releases Activity

docs: improve docs

Browse Source 
Add section about wiki in contribution section
Mention about wiki in README
Mention about cron job in README
[skip travis]
This commit is contained in:
Revant Nandgaonkar 2021-02-25 15:29:54 +05:30
parent b7f19e0bbe
commit bc3b3aa83e
2 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
CONTRIBUTING.md
View File

@ -32,3 +32,7 @@ Please be considerate when pushing commits and opening PR for multiple branches,
# Documentation # Documentation
Place relevant markdown file(s) in the `docs` directory and index them in README.md located at the root of repo. 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.

6
README.md
View File

@ -35,6 +35,11 @@ It takes care of the following:
* Setting up all the system requirements: eg. MariaDB, Node, Redis. * Setting up all the system requirements: eg. MariaDB, Node, Redis.
* Configure networking for remote access and setting up LetsEncrypt. * 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 Server Installs
1. [Single bench](docs/single-bench.md). Easiest Install! 1. [Single bench](docs/single-bench.md). Easiest Install!
2. [Multi bench](docs/multi-bench.md) 2. [Multi bench](docs/multi-bench.md)
@ -45,6 +50,7 @@ It takes care of the following:
4. [Environment Variables](docs/environment-variables.md) 4. [Environment Variables](docs/environment-variables.md)
5. [Custom apps for production](docs/custom-apps-for-production.md) 5. [Custom apps for production](docs/custom-apps-for-production.md)
6. [Tips for moving deployments](docs/tips-for-moving-deployments.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 ## Development Setup