refactor: Moved all dev/docker files to /tools folder

This commit is contained in:
NGPixel
2017-08-12 15:11:27 -04:00
parent d6c5264f9e
commit 5f415a4045
16 changed files with 42 additions and 110 deletions

View File

@@ -14,7 +14,8 @@
##### A modern, lightweight and powerful wiki app built on NodeJS, Git and Markdown
- [Official Website](https://wiki.js.org/)
- [Documentation](#documentation)
- **[Getting Started](https://wiki.js.org/get-started.html)**
- [Documentation](https://docs.requarks.io/wiki/)
- [Requirements](#requirements)
- [Change Log](https://github.com/Requarks/wiki/blob/master/CHANGELOG.md)
- [Feature Requests](https://wikijs.canny.io/features)
@@ -23,12 +24,6 @@
- [Translations](#translations) *(We need your help!)*
- [Special Thanks](#special-thanks)
## Documentation
- [Installation Guide](https://wiki.js.org/get-started.html)
- [Admin Guide](https://docs.requarks.io/wiki/#admin-guide)
- [User Guide](https://docs.requarks.io/wiki/#user-guide)
## Requirements
Wiki.js can run on virtually all platforms where Node.js can (Windows, Mac, Linux, etc.).
@@ -43,10 +38,17 @@ Wiki.js can run on virtually all platforms where Node.js can (Windows, Mac, Linu
## Cloud Install
[![Deploy to Heroku](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/requarks/wiki-heroku)
[![Docker Image](https://raw.githubusercontent.com/Requarks/wiki-site/master/assets/images/docker-deploy.png)](https://hub.docker.com/r/requarks/wiki/)
*Docker Cloud, Azure, IBM Bluemix and more coming soon!*
## Docker
A docker Wiki.js image is available on Docker Hub:
[![Docker Image](https://raw.githubusercontent.com/Requarks/wiki-site/master/assets/images/docker-deploy.png)](https://hub.docker.com/r/requarks/wiki/)
You can also use a Dockerfile ([see example]()) or Docker Compose ([see example]()) to run Wiki.js.
## Milestones
Current and upcoming milestones *(major features only, see the [changelog](https://github.com/Requarks/wiki/blob/master/CHANGELOG.md) for complete list of features and bug fixes)*:
@@ -74,7 +76,7 @@ Current and upcoming milestones *(major features only, see the [changelog](https
- [x] Migrate to PostgreSQL + Redis datastore
- [ ] History / Revert to previous version
- [ ] Optional Two-Steps Authentication (2FA)
- [ ] Docker support + Auto compile/publish to Docker Hub
- [x] Docker support + Auto compile/publish to Docker Hub
- [ ] Support sub-directory installations (e.g. example.com/wiki)
- [ ] Persist system settings to database instead of file-based
- [ ] User Groups + Better permissions management