diff --git a/docs/contributing/pull-requests.md b/docs/contributing/pull-requests.md index d66919f1d6..5e341f1e2c 100644 --- a/docs/contributing/pull-requests.md +++ b/docs/contributing/pull-requests.md @@ -4,10 +4,23 @@ Pull request are the best way to provide a bug fix or to propose enhancements to ## Step 1: Setup your environment -Before working on the KunstmaanBundlesCMS, setup a Symfony friendly environment like described in the [system requirements documentation](../installation/system-requirements.md) or [work with the PuPHPet Vagrant box](../installation/development-environment.md). +Before working on the KunstmaanBundlesCMS, setup a Symfony friendly environment like described in the [system requirements documentation](../installation/system-requirements.md). Make sure your git setup is complete. If you are new to git, we highly recommended you read the excellent and free [ProGit book](http://git-scm.com/book). +The easiest way to start from scratch is by using our demo docker-compose file. +You can find it in our [standardedition](https://github.com/Kunstmaan/KunstmaanBundlesStandardEdition). Assuming you have already set up docker on your computer, booting up the demo is a matter of 2 simple commands. + +```bash +#In the KunstmaanBundlesStandardEdition +cd docker_demo +docker-compose up +``` + +A demo website will be running at localhost:2468 now. Also there will be a maildev available at localhost:1080. + +If you decide to use this approach you should do all the following steps from inside your container. + ## Step 2: Get the source Start by forking the [repository](https://github.com/Kunstmaan/KunstmaanBundlesCMS) and add the following to the `composer.json` file of your project: diff --git a/docs/getting-started/index.md b/docs/getting-started/index.md index b9254b78d4..e628fdffd8 100644 --- a/docs/getting-started/index.md +++ b/docs/getting-started/index.md @@ -20,7 +20,7 @@ Documentation specific to the KunstmaanBundlesCMS can be found on: * [Installation Guide](../installation/index.md) * [System requirements](../installation/system-requirements.md) - * [Development environment](../installation/development-environment.md) + * [Demo environment](../installation/demo-environment.md) * [Content Management Guide](../content-management/index.md) * [Creating a pagepart](../content-management/creating-a-page-part.md) * [Creating a pagetype](../content-management/creating-a-pagetype.md) diff --git a/docs/images/wizard.png b/docs/images/wizard.png deleted file mode 100644 index 8a13452a5a..0000000000 Binary files a/docs/images/wizard.png and /dev/null differ diff --git a/docs/installation/demo-environment.md b/docs/installation/demo-environment.md new file mode 100644 index 0000000000..022abfd1f1 --- /dev/null +++ b/docs/installation/demo-environment.md @@ -0,0 +1,13 @@ +# Running the Demo Website inside a docker environment + +We provide a docker-compose.yml file inside our [standardedition](https://github.com/Kunstmaan/KunstmaanBundlesStandardEdition). + +Assuming you have already set up docker on your computer, booting up the demo is a matter of 2 simple commands. + +```bash +#In the KunstmaanBundlesStandardEdition +cd docker_demo +docker-compose up +``` + +An exact copy of te demo website will be available at localhost:2468 now. Also there will be a maildev available at localhost:1080. diff --git a/docs/installation/development-environment.md b/docs/installation/development-environment.md deleted file mode 100644 index 38778373ab..0000000000 --- a/docs/installation/development-environment.md +++ /dev/null @@ -1,27 +0,0 @@ -# Using PuPHPet and Vagrant - -PuPHPet - -For the sake of clarity we will perform this installation in a Vagrant box built with [PuPHPet](https://puphpet.com). PuPHPet is a web application that allows you to easily and quickly generate [Vagrant](http://vagrantup.com/) and [Puppet](https://puppetlabs.com/) controlled virtual machines. It's a perfect replacement for local development environments like XAMPP, WAMPP, MAMPP, etc - -## Getting the PuPHPet Vagrant box - -Get our preconfigured box by cloning [this repo](https://github.com/Kunstmaan/puphpet) to your local machine with this command: - -```sh -git clone https://github.com/Kunstmaan/puphpet -``` - -Install Vagrant from [vagrantup.com](http://vagrantup.com/). Also install these plugins if you haven't already: - -```sh -vagrant plugin install vagrant-bindfs vagrant-cachier vagrant-hostmanager -``` - -After cloning go into the `puphpet` folder and run `vagrant up`. This will take a while but when completed you will have a fully functional Ubuntu 14.04 box with all dependencies installed and configured. - -## Adjusting the dummy Apache and MySQL configuration - -We use *myprojectname* as a name for our project and vhost setup. We also use dummy database credentials (*mydbname, mydbuser, mydbpass*) for MySQL. - -For real world use you will need to change this. You can do this via the [PuPHPet web interface](https://puphpet.com) by dragging the `puphpet/config.yaml` file into the browser and adjust the settings. Alternatively you can easily edit the YAML file `puphpet/config.yaml` by hand. diff --git a/docs/installation/index.md b/docs/installation/index.md index 512ec28d14..72408f3642 100644 --- a/docs/installation/index.md +++ b/docs/installation/index.md @@ -1,9 +1,5 @@ # Installation -> For the sake of clarity we will perform this installation in a preconfigured Vagrant box built with [PuPHPet](https://puphpet.com). More info in [this chapter about the PuPHPet development environment](./development-environment.md). If you have a development environment, just adjust to match your specifics. -> -> This chapter assumes you have started the box (`vagrant up`), ssh'ed into it (`vagrant ssh`) and have navigated to the `/var/www` folder (`cd /var/www`). If there is a folder there called `myprojectname` you should delete it by running: `rm -Rf myprojectname` - ## Downloading and configuring the base CMS We will get started by downloading the Kunstmaan Bundles Standard Edition to get the CMS and all it's dependencies. @@ -115,7 +111,9 @@ Execute the following command: bin/console assets:install --symlink ``` -At this point browsing to [http://kunstmaan.cms/en/admin](http://kunstmaan.cms/en/admin) should greet you with the following screens. +If you have done all the aforementioned staps successfuly. You should be able to +browse to the website on the environment of your choice, and be greeted with the +following screens. ![Demo Site Admin](https://raw.githubusercontent.com/kunstmaan/KunstmaanBundlesCMS/master/docs/images/demositeadmin.png) @@ -146,6 +144,4 @@ npm install npm run build ``` -At this point browsing to [http://kunstmaan.cms](http://kunstmaan.cms) should show you the website with minimalistic styling. -======= ->>>>>>> 4.0 +At this point browsing to the website on the environment of your choice should show you the website with minimalistic styling. diff --git a/docs/installation/system-requirements.md b/docs/installation/system-requirements.md index 474ec7446a..aafc82439c 100644 --- a/docs/installation/system-requirements.md +++ b/docs/installation/system-requirements.md @@ -28,5 +28,5 @@ * MySQL 5.x (some work on sqlite has been done but is not supported) * A webserver like Apache or Nginx (preferably with a Varnish server in front) * Imagemagick -* Elasticsearch (1.7.3) +* Elasticsearch * Memcached (optionally)