Skip to content

Commit

Permalink
Merge branch 'master' of https://github.com/laradock/laradock
Browse files Browse the repository at this point in the history
  • Loading branch information
naillizard committed Apr 17, 2017
2 parents ba32ded + df87c3e commit a91bd19
Show file tree
Hide file tree
Showing 130 changed files with 7,997 additions and 1,130 deletions.
25 changes: 25 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
language: bash
sudo: required
services:
- docker

env:
matrix:
- PHP_VERSION=56
- PHP_VERSION=70
- PHP_VERSION=71
- HUGO_VERSION=0.20

script: ./_scripts/travis-build.sh

deploy:
provider: pages
skip_cleanup: true
local_dir: docs
github_token: $GITHUB_TOKEN
on:
branch: master
condition: -n "${HUGO_VERSION}"

notifications:
email: false
Empty file.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
19 changes: 12 additions & 7 deletions DOCUMENTATION/_settings/config.toml → DOCUMENTATION/config.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
baseurl = "http://laradock.io/"
languageCode = "en-us"
publishDir = "../../docs"
publishDir = "../docs"
title = "Laradock"
theme = "hugo-material-docs"
metadataformat = "yaml"
Expand All @@ -11,15 +11,15 @@ googleAnalytics = "UA-37514928-9"
[params]
# General information
author = "Mahmoud Zalt"
description = "Laradock documentations."
description = "Full PHP development environment for Docker."
copyright = ""

# Repository
provider = ""
repo_url = ""

version = ""
logo = ""
logo = "images/logo.png"
favicon = ""

permalink = "#"
Expand Down Expand Up @@ -62,24 +62,29 @@ googleAnalytics = "UA-37514928-9"
weight = 3

[[menu.main]]
name = "Related Projects"
url = "related-projects/"
name = "Guides"
url = "guides/"
weight = 4

[[menu.main]]
name = "Help & Questions"
url = "help/"
weight = 5

[[menu.main]]
name = "Related Projects"
url = "related-projects/"
weight = 6

[[menu.main]]
name = "Contributing"
url = "contributing/"
weight = 6
weight = 7

[[menu.main]]
name = "License"
url = "license/"
weight = 7
weight = 8

# ------- MENU END -----------------------------------------

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Contributing
type: index
weight: 6
weight: 7
---


Expand Down Expand Up @@ -38,17 +38,23 @@ You can request a new feature by submitting an [Issue](https://github.com/larado

Laradock uses [Hugo](https://gohugo.io/) as website generator tool, with the [Material Docs theme](http://themes.gohugo.io/theme/material-docs/). You might need to check their docs quickly.

Go the `DOCUMENTATION/content` and search for the markdown file you want to edit

Note: Every folder represents a section in the sidebar "Menu". And every page and sidebar has a `weight` number to show it's position in the site.

To update the sidebar or add a new section to it, you can edit this `DOCUMENTATION/config.toml` toml file.

> The site will be auto-generated in the `docs/` folder by [Travis CI](https://travis-ci.org/laradock/laradock/).
1. Install [Hugo](https://gohugo.io/) on your machine (easy thing).
2. Open the `DOCUMENTATION/_settings/content` and search for the markdown file you want to edit (every folder represents a section in the menu).
3. Delete the `/docs` folder from the root.
4. When you finish editing, go to `DOCUMENTATION/_settings/` and run the `hugo` command to generate the HTML docs (inside new `/docs` folder).

<br>

### To Host the website locally
Go to `DOCUMENTATION/_settings` in your terminal and run `hugo serve` to host the website locally.

### Edit the sidebar
To add a new section to the sidebar or edit existing one, you need to edit this file `DOCUMENTATION/_settings/config.toml`.
1. Install [Hugo](https://gohugo.io/) on your machine.
2. Edit the `DOCUMENTATION/content`.
3. Delete the `/docs` folder from the root.
4. After you finish the editing, go to `DOCUMENTATION/` and run the `hugo` command to generate the HTML docs (inside a new `/docs` folder).



Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ Your folder structure should look like this:

*Or you can keep `default.conf` as it is, and create a separate config `my-site.conf` file for it.*

**In case of Apache:** :P
**In case of Apache:** :P

<br>

Expand Down Expand Up @@ -166,9 +166,7 @@ docker-compose up -d nginx mysql
**Note**: The `workspace` and `php-fpm` will run automatically in most of the cases, so no need to specify them in the `up` command. If you couldn't find them running then you need specify them as follow: `docker-compose up -d nginx php-fpm mysql workspace`.


You can select your own combination of containers form the list below:

> `nginx`, `hhvm`, `php-fpm`, `mysql`, `percona`, `redis`, `postgres`, `mariadb`, `neo4j`, `mongo`, `apache2`, `caddy`, `memcached`, `beanstalkd`, `beanstalkd-console`, `rabbitmq`, `beanstalkd-console`, `workspace`, `phpmyadmin`, `adminer`, `aerospike`, `pgadmin`, `elasticsearch`, `rethinkdb`, `postgres-postgis`, `certbot`, `mailhog`, `minio` and more...!
You can select your own combination of containers form [this list](http://laradock.io/introduction/#supported-software-images).

*(Please note that sometimes we forget to update the docs, so check the `docker-compose.yml` file to see an updated list of all available containers).*

Expand All @@ -186,7 +184,7 @@ docker-compose exec workspace bash
docker exec -it {workspace-container-id} bash
```

**Note:** You can add `--user=laradock` to have files created as your host's user. Example:
**Note:** You can add `--user=laradock` to have files created as your host's user. Example:

```shell
docker-compose exec --user=laradock workspace bash
Expand All @@ -206,6 +204,6 @@ DB_HOST=mysql
*If you want to install Laravel as PHP project, see [How to Install Laravel in a Docker Container](#Install-Laravel).*

<br>
5 - Open your browser and visit your localhost address `http://localhost/`. If you followed the multiple projects setup, you can visit `http://project-1.dev/` and `http://project-2.dev/`. But first don't
5 - Open your browser and visit your localhost address `http://localhost/`. If you followed the multiple projects setup, you can visit `http://project-1.dev/` and `http://project-2.dev/`. But first don't


Loading

0 comments on commit a91bd19

Please sign in to comment.