From 316e95de1b279bcf3365682998231d37d10129e8 Mon Sep 17 00:00:00 2001 From: cytopia Date: Tue, 6 Nov 2018 14:25:10 +0100 Subject: [PATCH] Adjust project files: CHANGELOG, CONTRIBUTING and UPDATING --- CHANGELOG.md | 15 ++++++++ CONTRIBUTING.md | 91 ++++++++++++++++++++++++++++++++++++++++++------- UPDATING.md | 23 +++++++++++++ 3 files changed, 116 insertions(+), 13 deletions(-) create mode 100644 CHANGELOG.md create mode 100644 UPDATING.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 000000000..969dd4877 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,15 @@ +# Changelog + +Make sure to have a look at [UPDATING.md](Updating.md) to see any required steps for updating +major versions + +## Devilbox v1.0 + +* Use Docker volumes for stateful data (MySQL, PgSQL, MongoDB) + - This fixes various mount issues on Windows + - This improves general performance +* Split Bind container into internal DNS and autoDNS + - This fixes various issues with Docker Toolbox and DNS resolution +* Use semantic versioning + - This allows for faster releases + - This allows for better visibility of breaking changes diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6456c8332..1ad0e4332 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,30 +1,95 @@ # Contributing -There is quite a lot todo and planned. If you like to contribute, pick any of the below topics or contact me directly. -Contributors will be credited within the intranet and on the github page. +**Abstract** +The Devilbox is currently being developed in my spare time and mostly reflects the features that I +am using for all the web projcets I have to handle. In order to better present it to the majority +of other software developers I do require support to cope with all the feature requests. -## Roadmap -Please see [ROADMAP](https://github.com/cytopia/devilbox/issues/23) for what is planned. +So first of all, If the Devilbox makes your life easier, **star it on GitHub**! +**Table of Contents** -## Documentation +1. [How to contribute](#how-to-contribute) + 1. [Documentation](#documentation) + 2. [Docker Container](#docker-container) + 3. [New Features](#new-features) + 4. [Intranet](#intranet) + 5. [Tests](#tests) +2. [Joining the Devilbox GitHub Organization](#joining-the-devilbox-github-organization) +3. [Important](#important) -* [ ] Improve documentation -* [ ] Remove all typos / wrong grammar -## Intranet +## 1. How to contribute -* [X] View emails sent/received within PHP dockers -* [ ] Better layout -* [ ] Better logos +There are various areas that need support. If you are willing to help, pick a topic below and start +contributing. If you are unclear about anything, let me know and I will clarify. + +See the general [ROADMAP](https://github.com/cytopia/devilbox/issues/23) for what is planned. + +### Documentation + +**Required knowledge:** [Sphinx](http://www.sphinx-doc.org/en/stable/) + +* General improvement of the documentation (typos, grammar, etc) +* Better documentation for setting up Xdebug +* More how to's on how to setup a specific framework or CMS +* General how to's and blog posts + +### Docker Container + +**Required knowledge:** Docker, [Ansible](https://www.ansible.com/), Apache, Nginx, MySQL, PHP-FPM + +* Consolidate MySQL, PerconaDB and MariaDB into one repository for easier change management +* Consolidate Nginx and Apache into one repository for easier change management +* Performance improvements on Apache/Nginx and PHP-FPM +* Add new container to the stack + +### New Features + +**Required knowledge:** Various + +Have a look at the GitHub issues and see if you can implement any features requested + +### Intranet + +**Required knowledge:** PHP, HTML, CSS and Javascript + +* [ ] Fix email view: https://github.com/cytopia/devilbox/issues/337 +* [ ] Better and more modern layout * [ ] Try to remove as much vendor dependencies as possible -## Updating Vendors +### Tests + +**Required knowledge:** [Travis-CI](https://docs.travis-ci.com/) + +* Shorten CI test time for faster releases +* Rewrite current tests, write new tests + + +## Joining the Devilbox GitHub Organization + +If you want to contribute on a regular base and take care about major feature development you can +be invited to the GitHub organization. + +This however requires some prerequisites: + +1. Willing to dedicate a regular amount of time to invest in this project +2. Already spent a decent amount of time in improving the Devilbox +3. A good understanding about the Devilbox +4. A good understanding about the PHP-FPM container (and how it is built with Ansible) + + +## Important + +This section will cover important information about various topics that need to be taken care +of. + +### Updating Vendors -#### phpMyAdmin +##### phpMyAdmin The following settings must be applied to `config.inc.php`: ```php diff --git a/UPDATING.md b/UPDATING.md new file mode 100644 index 000000000..39950202e --- /dev/null +++ b/UPDATING.md @@ -0,0 +1,23 @@ +# Updating + +This document will hold all information on how to update between major versions. + + +## Update from `v0.x` to `v1.x` + +### Docker Volumes + +**PR:** https://github.com/cytopia/devilbox/pull/383 + +This feature will move all data directories (MySQL, PostgreSQL, MongoDB and others) to Docker +volumes for best-practice and compatibility reasons on different operating systems. + +Before updating to this release, you will need to manually trigger a backup of MySQL, +PostgreSQL and MongoDB to ensure that you have a copy of your data. By switching to this release +you will be unable to access your current data: + +**Steps to update:** + +1. Backup your data +2. Switch to the new release +3. Import your data