Skip to content

Commit

Permalink
Improve docs readability & performance
Browse files Browse the repository at this point in the history
  • Loading branch information
Mahmoudz committed Apr 29, 2020
1 parent d2823c0 commit 5824676
Show file tree
Hide file tree
Showing 42 changed files with 210 additions and 97 deletions.
1 change: 1 addition & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@
github: Mahmoudz
open_collective: laradock
custom: ['paypal.me/mzmmzz']
patreon: zalt
21 changes: 8 additions & 13 deletions DOCUMENTATION/config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ googleAnalytics = "UA-37514928-9"
repo_url = "https://github.com/laradock/laradock"

version = ""
logo = "images/logo.png"
favicon = ""
logo = "images/favicons/ms-icon-310x310.png"
favicon = "images/favicons/favicon.ico"

permalink = "#"

Expand All @@ -48,40 +48,35 @@ googleAnalytics = "UA-37514928-9"
# ------- MENU START -----------------------------------------

[[menu.main]]
name = "1. Introduction"
name = "Introduction"
url = "introduction/"
weight = 1

[[menu.main]]
name = "2. Getting Started"
name = "Getting Started"
url = "getting-started/"
weight = 2

[[menu.main]]
name = "3. Documentation"
name = "Documentation"
url = "documentation/"
weight = 3

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

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

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

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

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

[blackfriday]
Expand Down
20 changes: 14 additions & 6 deletions DOCUMENTATION/content/contributing/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: 7. Contributing
title: Contributions
type: index
weight: 7
weight: 6
---


Expand Down Expand Up @@ -51,12 +51,20 @@ To update the sidebar or add a new section to it, you can edit this `DOCUMENTATI

### Host the documentation locally

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).
**Option 1: Use Hugo Docker Image:**

1. Update the `DOCUMENTATION/content`.
2. Go to `DOCUMENTATION/`.
3. Run `docker run --rm -it -v $PWD:/src -p 1313:1313 -u hugo jguyomard/hugo-builder hugo server -w --bind=0.0.0.0`
4. Visit [http://localhost:1313/](http://localhost:1313/)

**Option 2: Install Hugo Locally:**

1. Install [Hugo](https://gohugo.io/) on your machine.
2. Update the `DOCUMENTATION/content`.
3. Delete the `/docs` folder from the root.
4. Go to `DOCUMENTATION/`.
5. Run the `hugo` command to generate the HTML docs inside a new `/docs` folder.


## Support new Software (Add new Container)
Expand Down
70 changes: 43 additions & 27 deletions DOCUMENTATION/content/documentation/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 3. Documentation
title: Documentation
type: index
weight: 3
---
Expand Down Expand Up @@ -57,7 +57,9 @@ docker-compose down

<br>
<a name="Enter-Container"></a>
## Enter a Container (run commands in a running Container)
## Enter a Container

> Run commands in a running Container.
1 - First list the current running containers with `docker ps`

Expand Down Expand Up @@ -88,7 +90,8 @@ docker-compose exec mysql mysql -udefault -psecret

<br>
<a name="Edit-Container"></a>
## Edit default container configuration
## Edit default Container config

Open the `docker-compose.yml` and change anything you want.

Examples:
Expand Down Expand Up @@ -161,7 +164,7 @@ You might use the `--no-cache` option if you want full rebuilding (`docker-compo

<br>
<a name="Add-Docker-Images"></a>
## Add more Software (Docker Images)
## Add more Docker Images

To add an image (software), just edit the `docker-compose.yml` and add your container details, to do so you need to be familiar with the [docker compose file syntax](https://docs.docker.com/compose/compose-file/).

Expand Down Expand Up @@ -384,7 +387,9 @@ Always download the latest version of [Loaders for ionCube ](http://www.ioncube.

<br>
<a name="Install-Deployer"></a>
## Install Deployer (Deployment tool for PHP)
## Install Deployer

> A deployment tool for PHP.
1 - Open the `.env` file
<br>
Expand All @@ -402,7 +407,10 @@ Always download the latest version of [Loaders for ionCube ](http://www.ioncube.
<br>
<a name="Install-SonarQube"></a>

## Install SonarQube (automatic code review tool)
## Install SonarQube

> An automatic code review tool.
SonarQube® is an automatic code review tool to detect bugs, vulnerabilities and code smells in your code. It can integrate with your existing workflow to enable continuous code inspection across your project branches and pull requests.
<br>
1 - Open the `.env` file
Expand Down Expand Up @@ -463,14 +471,6 @@ To learn more about how Docker publishes ports, please read [this excellent post



<br>
<a name="Digital-Ocean"></a>
## Setup Laravel and Docker on Digital Ocean

### [Full Guide Here](/guides/#Digital-Ocean)






Expand All @@ -483,7 +483,7 @@ To learn more about how Docker publishes ports, please read [this excellent post


<a name="Install-Laravel"></a>
## Install Laravel from a Docker Container
## Install Laravel from Container

1 - First you need to enter the Workspace Container.

Expand Down Expand Up @@ -619,7 +619,9 @@ docker-compose up -d php-worker

<br>
<a name="Use-Browsersync-With-Laravel-Mix"></a>
## Use Browsersync with Laravel Mix
## Use Browsersync

> Using Use Browsersync with Laravel Mix.
1. Add the following settings to your `webpack.mix.js` file. Please refer to Browsersync [Options](https://browsersync.io/docs/options) page for more options.
```
Expand Down Expand Up @@ -1731,7 +1733,9 @@ The default username and password for the root MySQL user are `root` and `root `

<br>
<a name="Create-Multiple-Databases"></a>
## Create Multiple Databases (MySQL)
## Create Multiple Databases

> With MySQL.
Create `createdb.sql` from `mysql/docker-entrypoint-initdb.d/createdb.sql.example` in `mysql/docker-entrypoint-initdb.d/*` and add your SQL syntax as follow:

Expand Down Expand Up @@ -1765,7 +1769,9 @@ If you need <a href="#MySQL-access-from-host">MySQL access from your host</a>, d

<br>
<a name="Use-custom-Domain"></a>
## Use custom Domain (instead of the Docker IP)
## Use custom Domain

> How to use a custom domain, instead of the Docker IP.
Assuming your custom domain is `laravel.test`

Expand All @@ -1791,7 +1797,7 @@ server_name laravel.test;

<br>
<a name="Enable-Global-Composer-Build-Install"></a>
## Enable Global Composer Build Install
## Global Composer Build Install

Enabling Global Composer Install during the build for the container allows you to get your composer requirements installed and available in the container after the build is done.

Expand All @@ -1810,7 +1816,9 @@ Enabling Global Composer Install during the build for the container allows you t

<br>
<a name="Magento-2-authentication-credentials"></a>
## Add authentication credential for Magento 2
## Add authentication for Magento

> Adding authentication credentials for Magento 2.
1 - Open the `.env` file

Expand Down Expand Up @@ -1902,7 +1910,7 @@ To install NPM GULP toolkit in the Workspace container

<br>
<a name="Install-NPM-BOWER"></a>
## Install NPM BOWER package manager
## Install NPM BOWER

To install NPM BOWER package manager in the Workspace container

Expand Down Expand Up @@ -2088,7 +2096,9 @@ e) set it to `true`

<br>
<a name="Install-Laravel-Envoy"></a>
## Install Laravel Envoy (Envoy Task Runner)
## Install Laravel Envoy

> A Tasks Runner.
1 - Open the `.env` file
<br>
Expand Down Expand Up @@ -2121,7 +2131,8 @@ e) set it to `true`

<br>
<a name="Install-Faketime"></a>
## Install libfaketime in the php-fpm container
## Install libfaketime in php-fpm

Libfaketime allows you to control the date and time that is returned from the operating system.
It can be used by specifying a special string in the `PHP_FPM_FAKETIME` variable in the `.env` file.
For example:
Expand All @@ -2145,7 +2156,8 @@ will set the clock back 1 day. See (https://github.com/wolfcw/libfaketime) for m

<br>
<a name="Install-YAML"></a>
## Install YAML PHP extension in the php-fpm container
## Install YAML extension in php-fpm

YAML PHP extension allows you to easily parse and create YAML structured data. I like YAML because it's well readable for humans. See http://php.net/manual/en/ref.yaml.php and http://yaml.org/ for more info.

1 - Open the `.env` file
Expand Down Expand Up @@ -2195,7 +2207,9 @@ For configuration information, visit the [bash-git-prompt repository](https://gi

<br>
<a name="Install-Oh-My-Zsh"></a>
## Install Oh My ZSH! with Laravel autocomplete plugin
## Install Oh My ZSH

> With the Laravel autocomplete plugin.
[Zsh](https://en.wikipedia.org/wiki/Z_shell) is an extended Bourne shell with many improvements, including some features of Bash, ksh, and tcsh.

Expand Down Expand Up @@ -2226,7 +2240,9 @@ Remote debug Laravel web and phpunit tests.

<br>
<a name="Setup-gcloud"></a>
## Setup Google Cloud for docker registry
## Setup Google Cloud

> Setting up Google Cloud for the docker registry.
```
gcloud auth configure-docker
Expand All @@ -2242,7 +2258,7 @@ gcloud auth login

<br>
<a name="keep-tracking-Laradock"></a>
## Keep track of your Laradock changes
## Track your Laradock changes

1. Fork the Laradock repository.
2. Use that fork as a submodule.
Expand Down
28 changes: 14 additions & 14 deletions DOCUMENTATION/content/getting-started/index.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
---
title: 2. Getting Started
title: Getting Started
type: index
weight: 2
---

## 2.1 Requirements
## Requirements

- [Git](https://git-scm.com/downloads)
- [Docker](https://www.docker.com/products/docker/) `>= 17.12`
- [Docker](https://www.docker.com/products/docker/) [ >= 17.12 ]




## 2.2 Installation
## Installation

Choose the setup the best suits your needs.

Expand Down Expand Up @@ -44,10 +44,10 @@ Note: If you are not using Git yet for your project, you can use `git clone` ins
2 - Make sure your folder structure should look like this:

```
+ project-a
+ laradock-a
+ project-b
+ laradock-b
* project-a
* laradock-a
* project-b
* laradock-b
```

*(It's important to rename the laradock folders to unique name in each project, if you want to run laradock per project).*
Expand All @@ -66,8 +66,8 @@ git clone https://github.com/laradock/laradock.git
Your folder structure should look like this:

```
+ laradock
+ project-z
* laradock
* project-z
```

2 - Edit your web server sites configuration.
Expand Down Expand Up @@ -102,9 +102,9 @@ git clone https://github.com/laradock/laradock.git
Your folder structure should look like this:

```
+ laradock
+ project-1
+ project-2
* laradock
* project-1
* project-2
```

2 - Go to your web server and create config files to point to different project directory when visiting different domains:
Expand Down Expand Up @@ -136,7 +136,7 @@ If you use Chrome 63 or above for development, don't use `.dev`. [Why?](https://


<a name="Usage"></a>
## 2.3 Usage
## Usage

**Read Before starting:**

Expand Down
4 changes: 2 additions & 2 deletions DOCUMENTATION/content/help/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: 5. Help & Questions
title: Help & Questions
type: index
weight: 5
weight: 4
---

Join the chat room on [Gitter](https://gitter.im/Laradock/laradock) and get help and support from the community.
Expand Down
Loading

0 comments on commit 5824676

Please sign in to comment.