From e5fa629a64b568b364ca59de634522d7f794a4a0 Mon Sep 17 00:00:00 2001 From: Mahmoud Zalt Date: Wed, 22 Feb 2017 15:58:06 -0500 Subject: [PATCH] update the docs --- docs/_settings/config.toml | 26 +- docs/_settings/content/contributing/index.md | 4 +- docs/_settings/content/documentation/index.md | 10 +- .../content/getting-started/index.md | 21 +- docs/_settings/content/help/index.md | 2 +- docs/_settings/content/index.md | 4 +- docs/_settings/content/license/index.md | 2 +- .../content/related-projects/index.md | 2 +- docs/contributing/index.html | 40 +- docs/contributing/index.xml | 32 +- docs/documentation/index.html | 174 +- docs/documentation/index.xml | 162 +- docs/getting-started/index.html | 66 +- docs/getting-started/index.xml | 38 +- docs/help/index.html | 8 +- docs/index.html | 2918 +++++++-------- docs/index.xml | 3134 ++++++++--------- docs/license/index.html | 8 +- docs/related-projects/index.html | 8 +- docs/sitemap.xml | 8 +- 20 files changed, 3406 insertions(+), 3261 deletions(-) diff --git a/docs/_settings/config.toml b/docs/_settings/config.toml index 6f14583a..390bcc4c 100644 --- a/docs/_settings/config.toml +++ b/docs/_settings/config.toml @@ -47,44 +47,44 @@ googleAnalytics = "" # ------- MENU START ----------------------------------------- [[menu.main]] - name = "Introduction" + name = "Overview" url = "/" - weight = 0 + weight = 1 [[menu.main]] - name = "Getting started" + name = "Getting Started" url = "getting-started/" - weight = 10 + weight = 2 [[menu.main]] name = "Documentation" url = "documentation/" - weight = 20 + weight = 3 [[menu.main]] name = "Related Projects" url = "related-projects/" - weight = 30 + weight = 4 [[menu.main]] name = "Help & Questions" url = "help/" - weight = 40 + weight = 5 [[menu.main]] name = "Contributing" url = "contributing/" - weight = 50 + weight = 6 [[menu.main]] name = "License" url = "license/" - weight = 60 + weight = 7 # ------- MENU END ----------------------------------------- [blackfriday] - smartypants = false - fractions = false - smartDashes = false - plainIDAnchors = false + smartypants = true + fractions = true + smartDashes = true + plainIDAnchors = true diff --git a/docs/_settings/content/contributing/index.md b/docs/_settings/content/contributing/index.md index 0bad05ac..838bca78 100644 --- a/docs/_settings/content/contributing/index.md +++ b/docs/_settings/content/contributing/index.md @@ -1,7 +1,7 @@ --- title: Contributing type: index -weight: 50 +weight: 6 --- @@ -143,4 +143,4 @@ from the main (upstream) repository:
-### Happy Coding :) \ No newline at end of file +### Happy Coding :) diff --git a/docs/_settings/content/documentation/index.md b/docs/_settings/content/documentation/index.md index ab4f46f6..46d220c6 100644 --- a/docs/_settings/content/documentation/index.md +++ b/docs/_settings/content/documentation/index.md @@ -1,7 +1,7 @@ --- title: Documentation type: index -weight: 20 +weight: 3 --- @@ -1308,15 +1308,15 @@ Moving from Docker Toolbox (VirtualBox) to Docker Native (for Mac/Windows). Requ ## Improve speed on MacOS Sharing code into Docker containers with osxfs have very poor performance compared to Linux. You can get around this issue by using NFS to share your files betwen your host and your container. - + > How to share files using NFS (d4m-nfs) [d4m-nfs](https://github.com/IFSight/d4m-nfs) automatically mount NFS volume instead of osxfs one. 1) Update the Docker [File Sharing] preferences: -Click on the Docker Icon > Preferences > (remove everything form the list except `/tmp`). - +Click on the Docker Icon > Preferences > (remove everything form the list except `/tmp`). + 2) Restart Docker. 3) Clone the [d4m-nfs](https://github.com/IFSight/d4m-nfs) repository to your `home` directory. @@ -1354,7 +1354,7 @@ docker-compose up -d nginx mysql
-## Common Problems +## Common Problems *Here's a list of the common problems you might face, and the possible solutions.* diff --git a/docs/_settings/content/getting-started/index.md b/docs/_settings/content/getting-started/index.md index 3dc17f52..5b8e23cd 100644 --- a/docs/_settings/content/getting-started/index.md +++ b/docs/_settings/content/getting-started/index.md @@ -1,13 +1,11 @@ --- -date: 2017 -title: Getting started -weight: 10 +title: Getting Started +type: index +weight: 2 --- - - ## Requirements - [Git](https://git-scm.com/downloads) @@ -16,8 +14,6 @@ weight: 10 - - ## Installation Choose the setup the best suits your needs. @@ -114,8 +110,6 @@ Do the same for each project `project2.conf`, `project3.conf`,... - - ## Usage **Read Before starting:** @@ -183,12 +177,3 @@ DB_HOST=mysql If you need a special support. Contact me, more details in the [Help & Questions](#Help) section. - - - - - - - - - diff --git a/docs/_settings/content/help/index.md b/docs/_settings/content/help/index.md index 871347c6..9c31979d 100644 --- a/docs/_settings/content/help/index.md +++ b/docs/_settings/content/help/index.md @@ -1,7 +1,7 @@ --- title: Help & Questions type: index -weight: 40 +weight: 5 --- Join the chat room on [Gitter](https://gitter.im/LaraDock/laradock) and get help and support from the community. diff --git a/docs/_settings/content/index.md b/docs/_settings/content/index.md index d9487b2e..f6c636f0 100644 --- a/docs/_settings/content/index.md +++ b/docs/_settings/content/index.md @@ -1,7 +1,7 @@ --- -title: Welcome to Laradock +title: Overview type: index -weight: 0 +weight: 1 --- LaraDock strives to make the PHP development experience easier and faster. diff --git a/docs/_settings/content/license/index.md b/docs/_settings/content/license/index.md index eac7757e..d65e5abc 100644 --- a/docs/_settings/content/license/index.md +++ b/docs/_settings/content/license/index.md @@ -1,7 +1,7 @@ --- title: License type: index -weight: 60 +weight: 7 --- [MIT License](https://github.com/laradock/laradock/blob/master/LICENSE) (MIT) diff --git a/docs/_settings/content/related-projects/index.md b/docs/_settings/content/related-projects/index.md index cdb2296a..e0327a2c 100644 --- a/docs/_settings/content/related-projects/index.md +++ b/docs/_settings/content/related-projects/index.md @@ -1,7 +1,7 @@ --- title: Related Projects type: index -weight: 30 +weight: 4 --- diff --git a/docs/contributing/index.html b/docs/contributing/index.html index deb14fa6..287932a7 100644 --- a/docs/contributing/index.html +++ b/docs/contributing/index.html @@ -180,9 +180,9 @@ - + - Introduction + Overview @@ -198,9 +198,9 @@ - + - Getting started + Getting Started @@ -336,26 +336,26 @@ -

Guidelines

+

Guidelines

Your contribution is more than welcome.

-

Got a Question or Problem?

+

Got a Question or Problem?

If you have questions about how to use LaraDock, please direct your questions to the discussion on Gitter. If you believe your question could help others, then consider opening an Issue (it will be labeled as Question).

-

Found an Issue?

+

Found an Issue?

If you find a bug in the source code or a mistake in the documentation, you can help us by submitting an Issue. Even better you can submit a Pull Request with a fix.

-

Want a Feature?

+

Want a Feature?

You can request a new feature by submitting an Issue (it will be labeled as Feature Suggestion). If you would like to implement a new feature then consider submitting a Pull Request.

-

Coding Guidelines

+

Coding Guidelines

-

Support new Software

+

Support new Software

-

Edit existing Software

+

Edit existing Software

-

Issue/PR Submission Guidelines

+

Issue/PR Submission Guidelines

-

Submitting an Issue

+

Submitting an Issue

Before you submit your issue search the archive, maybe your question was already answered.

-

If your issue appears to be a bug, and hasn't been reported, open a new issue. +

If your issue appears to be a bug, and hasn’t been reported, open a new issue. Help us to maximize the effort we can spend fixing issues and adding new features, by not reporting duplicate issues.

-

Before Submitting a Pull Request (PR)

+

Before Submitting a Pull Request (PR)

Always Test everything and make sure its working:

@@ -403,7 +403,7 @@ features, by not reporting duplicate issues.

  • Before editing anything:
  • Now edit the container (edit section by section and test rebuilding the container after every edited section) @@ -414,12 +414,12 @@ features, by not reporting duplicate issues.

    • -

    Submitting a PR

    +

    Submitting a PR

    Consider the following guidelines:

    -

    Note: If ./xdebugPhpFpm doesn't execute and gives Permission Denied error the problem can be that file xdebugPhpFpm doesn't have execution access. This can be fixed by running chmod command with desired access permissions.

    +

    Note: If ./xdebugPhpFpm doesn’t execute and gives Permission Denied error the problem can be that file xdebugPhpFpm doesn’t have execution access. This can be fixed by running chmod command with desired access permissions.


    -

    Install Deployer (Deployment tool for PHP)

    +

    Install Deployer (Deployment tool for PHP)

    1 - Open the docker-compose.yml file
    @@ -636,7 +636,7 @@ xdebug.remote_connect_back=1

    4 - Re-build the containers docker-compose build workspace

    -

    Deployer Documentation Here

    +

    Deployer Documentation Here


    @@ -644,11 +644,11 @@ xdebug.remote_connect_back=1


    -

    Prepare LaraDock for Production

    +

    Prepare LaraDock for Production

    -

    It's recommended for production to create a custom docker-compose.yml file. For that reason, LaraDock is shipped with production-docker-compose.yml which should contain only the containers you are planning to run on production (usage example: docker-compose -f production-docker-compose.yml up -d nginx mysql redis ...).

    +

    It’s recommended for production to create a custom docker-compose.yml file. For that reason, LaraDock is shipped with production-docker-compose.yml which should contain only the containers you are planning to run on production (usage example: docker-compose -f production-docker-compose.yml up -d nginx mysql redis ...).

    -

    Note: The Database (MySQL/MariaDB/...) ports should not be forwarded on production, because Docker will automatically publish the port on the host, which is quite insecure, unless specifically told not to. So make sure to remove these lines:

    +

    Note: The Database (MySQL/MariaDB/…) ports should not be forwarded on production, because Docker will automatically publish the port on the host, which is quite insecure, unless specifically told not to. So make sure to remove these lines:

    ports:
     - "3306:3306"
@@ -659,16 +659,16 @@ xdebug.remote_connect_back=1
 

    
 
    
 
-
    Setup Laravel and Docker on Digital Ocean
    
+
    Setup Laravel and Docker on Digital Ocean
    
 
-
    Full Guide Here
    
+
    Full Guide Here
    
 
 

    
 
    
 
 
    
 
-
    Install Laravel from a Docker Container
    
+
    Install Laravel from a Docker Container
    
 
 
    1 - First you need to enter the Workspace Container.
    
 
@@ -708,7 +708,7 @@ xdebug.remote_connect_back=1
 

    
 
    
 
-
    Run Artisan Commands
    
+
    Run Artisan Commands
    
 
 
    You can run artisan commands and many other Terminal commands from the Workspace container.
    
 
@@ -727,7 +727,7 @@ xdebug.remote_connect_back=1
 
    docker-compose exec workspace bash
 
    
 
-
    Add --user=laradock (example docker-compose exec --user=laradock workspace bash) to have files created as your host's user.
    
+
    Add --user=laradock (example docker-compose exec --user=laradock workspace bash) to have files created as your host’s user.
    
 
 
    4 - Run anything you want :)
    
 
@@ -743,7 +743,7 @@ xdebug.remote_connect_back=1
 

    
 
    
 
-
    Run Laravel Queue Worker
    
+
    Run Laravel Queue Worker
    
 
 
    1 - First add php-worker container. It will be similar as like PHP-FPM Container.
 
    
@@ -768,19 +768,19 @@ b) add a new service container by simply copy-paste this section below PHP-FPM c
 

    
 
    
 
-
    Use Redis
    
+
    Use Redis
    
 
 
    1 - First make sure you run the Redis Container (redis) with the docker-compose up command.
    
 
 
    docker-compose up -d redis
 
    
 
-
    2 - Open your Laravel's .env file and set the REDIS_HOST to redis
    
+
    2 - Open your Laravel’s .env file and set the REDIS_HOST to redis
    
 
 
    REDIS_HOST=redis
 
    
 
-
    If you don't find the REDIS_HOST variable in your .env file. Go to the database configuration file config/database.php and replace the default 127.0.0.1 IP with redis for Redis like this:
    
+
    If you don’t find the REDIS_HOST variable in your .env file. Go to the database configuration file config/database.php and replace the default 127.0.0.1 IP with redis for Redis like this:
    
 
 
    'redis' => [
     'cluster' => false,
@@ -811,7 +811,7 @@ SESSION_DRIVER=redis
 

    
 
    
 
-
    Use Mongo
    
+
    Use Mongo
    
 
 
    1 - First install mongo in the Workspace and the PHP-FPM Containers:
 
    
@@ -869,7 +869,7 @@ e) set it to true
    
 ],
 
    
 
-
    5 - Open your Laravel's .env file and update the following variables:
    
+
    5 - Open your Laravel’s .env file and update the following variables:
    -

    4 - Open your Laravel's .env file and update the following variables:

    +

    4 - Open your Laravel’s .env file and update the following variables: