Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] remove vagrant references and put some small snippet about docker in #1953

Merged
merged 1 commit into from
Jun 15, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion docs/contributing/pull-requests.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
Binary file removed docs/images/wizard.png
Binary file not shown.
13 changes: 13 additions & 0 deletions docs/installation/demo-environment.md
Original file line number Diff line number Diff line change
@@ -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.
27 changes: 0 additions & 27 deletions docs/installation/development-environment.md

This file was deleted.

12 changes: 4 additions & 8 deletions docs/installation/index.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -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)

Expand Down Expand Up @@ -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.
2 changes: 1 addition & 1 deletion docs/installation/system-requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)