From de6040a14d5860ec0eb172ee574c4350dd02d80d Mon Sep 17 00:00:00 2001 From: Mahmoud Zalt Date: Thu, 16 Mar 2017 17:44:14 -0400 Subject: [PATCH] move the documentation markdown files outside the generated html folder --- DOCUMENTATION/_settings/CNAME-COPY | 1 + {docs => DOCUMENTATION}/_settings/config.toml | 2 +- .../_settings/content/contributing/index.md | 91 +++++++++--------- .../_settings/content/documentation/index.md | 0 .../content/getting-started/index.md | 8 +- .../_settings/content/help/index.md | 0 .../_settings/content/index.md | 0 .../_settings/content/introduction/index.md | 0 .../_settings/content/license/index.md | 0 .../content/related-projects/index.md | 0 .../_settings/static/.gitkeep | 0 .../themes/hugo-material-docs/CHANGELOG.md | 0 .../themes/hugo-material-docs/LICENSE.md | 0 .../themes/hugo-material-docs/README.md | 0 .../hugo-material-docs/archetypes/default.md | 0 .../hugo-material-docs/images/screenshot.png | Bin .../themes/hugo-material-docs/images/tn.png | Bin .../hugo-material-docs/layouts/404.html | 0 .../layouts/_default/__list.html | 0 .../layouts/_default/single.html | 0 .../hugo-material-docs/layouts/index.html | 0 .../layouts/partials/drawer.html | 0 .../layouts/partials/footer.html | 0 .../layouts/partials/footer_js.html | 0 .../layouts/partials/head.html | 0 .../layouts/partials/header.html | 0 .../layouts/partials/nav.html | 0 .../layouts/partials/nav_link.html | 0 .../layouts/shortcodes/note.html | 0 .../layouts/shortcodes/warning.html | 0 .../hugo-material-docs/static/fonts/icon.eot | Bin .../hugo-material-docs/static/fonts/icon.svg | 0 .../hugo-material-docs/static/fonts/icon.ttf | Bin .../hugo-material-docs/static/fonts/icon.woff | Bin .../static/images/colors.png | Bin .../static/images/favicon.ico | Bin .../hugo-material-docs/static/images/logo.png | Bin .../static/images/screen.png | Bin .../static/javascripts/application.js | 0 .../static/javascripts/modernizr.js | 0 .../static/stylesheets/application.css | 0 .../stylesheets/highlight/highlight.css | 0 .../static/stylesheets/palettes.css | 0 .../static/stylesheets/temporary.css | 0 .../themes/hugo-material-docs/theme.toml | 0 docs/contributing/index.html | 83 ++++++++-------- docs/contributing/index.xml | 83 ++++++++-------- docs/getting-started/index.html | 8 +- docs/getting-started/index.xml | 8 +- docs/index.html | 91 +++++++++--------- docs/index.xml | 91 +++++++++--------- 51 files changed, 239 insertions(+), 227 deletions(-) create mode 100644 DOCUMENTATION/_settings/CNAME-COPY rename {docs => DOCUMENTATION}/_settings/config.toml (98%) rename {docs => DOCUMENTATION}/_settings/content/contributing/index.md (58%) rename {docs => DOCUMENTATION}/_settings/content/documentation/index.md (100%) rename {docs => DOCUMENTATION}/_settings/content/getting-started/index.md (97%) rename {docs => DOCUMENTATION}/_settings/content/help/index.md (100%) rename {docs => DOCUMENTATION}/_settings/content/index.md (100%) rename {docs => DOCUMENTATION}/_settings/content/introduction/index.md (100%) rename {docs => DOCUMENTATION}/_settings/content/license/index.md (100%) rename {docs => DOCUMENTATION}/_settings/content/related-projects/index.md (100%) rename {docs => DOCUMENTATION}/_settings/static/.gitkeep (100%) rename {docs => DOCUMENTATION}/_settings/themes/hugo-material-docs/CHANGELOG.md (100%) rename {docs => DOCUMENTATION}/_settings/themes/hugo-material-docs/LICENSE.md (100%) rename {docs => DOCUMENTATION}/_settings/themes/hugo-material-docs/README.md (100%) rename {docs => DOCUMENTATION}/_settings/themes/hugo-material-docs/archetypes/default.md (100%) rename {docs => DOCUMENTATION}/_settings/themes/hugo-material-docs/images/screenshot.png (100%) rename {docs => DOCUMENTATION}/_settings/themes/hugo-material-docs/images/tn.png (100%) rename {docs => DOCUMENTATION}/_settings/themes/hugo-material-docs/layouts/404.html (100%) rename {docs => DOCUMENTATION}/_settings/themes/hugo-material-docs/layouts/_default/__list.html (100%) rename {docs => DOCUMENTATION}/_settings/themes/hugo-material-docs/layouts/_default/single.html (100%) rename {docs => DOCUMENTATION}/_settings/themes/hugo-material-docs/layouts/index.html (100%) rename {docs => DOCUMENTATION}/_settings/themes/hugo-material-docs/layouts/partials/drawer.html (100%) rename {docs => DOCUMENTATION}/_settings/themes/hugo-material-docs/layouts/partials/footer.html (100%) rename {docs => DOCUMENTATION}/_settings/themes/hugo-material-docs/layouts/partials/footer_js.html (100%) rename {docs => DOCUMENTATION}/_settings/themes/hugo-material-docs/layouts/partials/head.html (100%) rename {docs => DOCUMENTATION}/_settings/themes/hugo-material-docs/layouts/partials/header.html (100%) rename {docs => DOCUMENTATION}/_settings/themes/hugo-material-docs/layouts/partials/nav.html (100%) rename {docs => DOCUMENTATION}/_settings/themes/hugo-material-docs/layouts/partials/nav_link.html (100%) rename {docs => DOCUMENTATION}/_settings/themes/hugo-material-docs/layouts/shortcodes/note.html (100%) rename {docs => DOCUMENTATION}/_settings/themes/hugo-material-docs/layouts/shortcodes/warning.html (100%) rename {docs => DOCUMENTATION}/_settings/themes/hugo-material-docs/static/fonts/icon.eot (100%) rename {docs => DOCUMENTATION}/_settings/themes/hugo-material-docs/static/fonts/icon.svg (100%) rename {docs => DOCUMENTATION}/_settings/themes/hugo-material-docs/static/fonts/icon.ttf (100%) rename {docs => DOCUMENTATION}/_settings/themes/hugo-material-docs/static/fonts/icon.woff (100%) rename {docs => DOCUMENTATION}/_settings/themes/hugo-material-docs/static/images/colors.png (100%) rename {docs => DOCUMENTATION}/_settings/themes/hugo-material-docs/static/images/favicon.ico (100%) rename {docs => DOCUMENTATION}/_settings/themes/hugo-material-docs/static/images/logo.png (100%) rename {docs => DOCUMENTATION}/_settings/themes/hugo-material-docs/static/images/screen.png (100%) rename {docs => DOCUMENTATION}/_settings/themes/hugo-material-docs/static/javascripts/application.js (100%) rename {docs => DOCUMENTATION}/_settings/themes/hugo-material-docs/static/javascripts/modernizr.js (100%) rename {docs => DOCUMENTATION}/_settings/themes/hugo-material-docs/static/stylesheets/application.css (100%) rename {docs => DOCUMENTATION}/_settings/themes/hugo-material-docs/static/stylesheets/highlight/highlight.css (100%) rename {docs => DOCUMENTATION}/_settings/themes/hugo-material-docs/static/stylesheets/palettes.css (100%) rename {docs => DOCUMENTATION}/_settings/themes/hugo-material-docs/static/stylesheets/temporary.css (100%) rename {docs => DOCUMENTATION}/_settings/themes/hugo-material-docs/theme.toml (100%) diff --git a/DOCUMENTATION/_settings/CNAME-COPY b/DOCUMENTATION/_settings/CNAME-COPY new file mode 100644 index 00000000..df75fb6b --- /dev/null +++ b/DOCUMENTATION/_settings/CNAME-COPY @@ -0,0 +1 @@ +laradock.io \ No newline at end of file diff --git a/docs/_settings/config.toml b/DOCUMENTATION/_settings/config.toml similarity index 98% rename from docs/_settings/config.toml rename to DOCUMENTATION/_settings/config.toml index d204953d..90b5b535 100644 --- a/docs/_settings/config.toml +++ b/DOCUMENTATION/_settings/config.toml @@ -1,6 +1,6 @@ baseurl = "http://laradock.io/" languageCode = "en-us" -publishDir = "../" +publishDir = "../../docs" title = "Laradock" theme = "hugo-material-docs" metadataformat = "yaml" diff --git a/docs/_settings/content/contributing/index.md b/DOCUMENTATION/_settings/content/contributing/index.md similarity index 58% rename from docs/_settings/content/contributing/index.md rename to DOCUMENTATION/_settings/content/contributing/index.md index 14d01109..29b90bea 100644 --- a/docs/_settings/content/contributing/index.md +++ b/DOCUMENTATION/_settings/content/contributing/index.md @@ -7,41 +7,52 @@ weight: 6 Your contribution is more than welcome. -## Got a Question or Problem? +## I have a Question/Problem -If you have questions about how to use Laradock, please direct your questions to the discussion on [Gitter](https://gitter.im/Laradock/laradock). If you believe your question could help others, then consider opening an [Issue](https://github.com/laradock/laradock/issues) (it will be labeled as Question). +If you have questions about how to use Laradock, please direct your questions to the discussion on [Gitter](https://gitter.im/Laradock/laradock). If you believe your question could help others, then consider opening an [Issue](https://github.com/laradock/laradock/issues) (it will be labeled as `Question`) And you can still seek help on Gitter for it. -## 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](https://github.com/laradock/laradock/issues). Even better you can submit a Pull Request with a fix. +## I found an Issue +If have an issue or you found a typo in the documentation, you can help us by +opnening an [Issue](https://github.com/laradock/laradock/issues). -## Want a Feature? -You can request a new feature by submitting an [Issue](https://github.com/laradock/laradock/issues) (it will be labeled as Feature Suggestion). If you would like to implement a new feature then consider submitting a Pull Request. +**Steps to do before opening an Issue:** + +1. Before you submit your issue search the archive, maybe your question was already answered couple hours ago (search in the closed Issues as well). + +2. Decide if the Issue belongs to this project or to [Docker](https://github.com/docker) itself! or even the tool you are using such as Nginx or MongoDB... + +If your issue appears to be a bug, and hasn't been reported, then open a new issue. + +*This Help us to maximize the effort we can spend fixing issues and adding new +features, by not reporting duplicate issues.* -## Update Documentation (Site) +## I want a Feature +You can request a new feature by submitting an [Issue](https://github.com/laradock/laradock/issues) (it will be labeled as `Feature Suggestion`). If you would like to implement a new feature then consider submitting a Pull Request yourself. + + + + + +## I want to update the Documentation (Site) 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. -1. Install [Hugo](https://gohugo.io/) on your machine. -2. Clone laradock. -3. Go to `/docs`. -4. Delete everything except the `_settings` folder & the `CNAME` file. -5. Open `docs/_settings` from your terminal and run `hugo serve` to host the website locally. -6. Open the `docs/_settings/content` and search for the folder of the section you want to edit. -7. In each section there's an `index.md` file, that's the file you need to edit. -8. To edit the sidebar (in case you are adding new section) go to `docs/_settings/config.toml` and add the section there. -9. After done editing, run the this command `hugo` to generate the updated site inside the `docs` folder. -10. Go back to the project root directory, commit and push.. +1. Install [Hugo](https://gohugo.io/) on your machine (easy steps). +2. Open the `DOCUMENTATION/_settings/content` and search for the markdown file you want to edit (every folder is a section in the menu). +3. After done editing, run the this command `hugo` to generate the updated site inside the `docs` folder (It's recommended to delete all files form the `/docs` folder, except the `CNAME` file, before running the `hugo` command). + +#### 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`. - -## Coding Guidelines - -## Support new Software +## How to support new Software (Add new Container) * Create folder with the software name. @@ -53,9 +64,9 @@ Laradock uses [Hugo](https://gohugo.io/) as website generator tool, with the [Ma * Make sure you follow our commenting style. -* Add the software in the `Readme`. +* Add the software in the `Documentation`. -## Edit existing Software +## Edit existing Software (Edit a Container) * Open the software (container) folder. @@ -64,19 +75,12 @@ Laradock uses [Hugo](https://gohugo.io/) as website generator tool, with the [Ma * **Note:** If you want to edit the base image of the `Workspace` or the `php-fpm` Containers, you need to edit their Docker-files from their GitHub repositories. For more info read their Dockerfiles comment on the Laradock repository. -* Make sure to update the `Readme` in case you made any changes. - -## Issue/PR Submission Guidelines - -## 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. -Help us to maximize the effort we can spend fixing issues and adding new -features, by not reporting duplicate issues. +* Make sure to update the `Documentation` in case you made any changes. -## Before Submitting a Pull Request (PR) +## Pull Request + +### 1. Before Submitting a Pull Request (PR) Always Test everything and make sure its working: @@ -86,13 +90,13 @@ Always Test everything and make sure its working: - Test running the container with some other containers in real app and see of everything is working fine. - Now edit the container (edit section by section and test rebuilding the container after every edited section) - Testing building the container (docker-compose build container-name) with no errors. - - Test it in real App. + - Test it in a real App if possible. -## Submitting a PR +### 2. Submitting a PR Consider the following guidelines: -* Search [GitHub](https://github.com/laradock/laradock/pulls) for an open or closed Pull Request that relates to your submission. You don't want to duplicate effort. +* Search [GitHub](https://github.com/laradock/laradock/pulls) for an open or closed Pull Request that relates to your submission. You don't want to duplicate efforts. * Make your changes in a new git branch: @@ -123,14 +127,9 @@ git push origin my-fix-branch -f *WARNING. Squashing or reverting commits and forced push thereafter may remove GitHub comments on code that were previously made by you and others in your commits.* +### 3. After your PR is merged - - - -## After your PR is merged - -After your pull request is merged, you can safely delete your branch and pull the changes -from the main (upstream) repository: +After your pull request is merged, you can safely delete your branch and pull the changes from the main (upstream) repository: * Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows: @@ -161,4 +160,4 @@ from the main (upstream) repository:
-## Happy Coding :) +#### Happy Coding :) diff --git a/docs/_settings/content/documentation/index.md b/DOCUMENTATION/_settings/content/documentation/index.md similarity index 100% rename from docs/_settings/content/documentation/index.md rename to DOCUMENTATION/_settings/content/documentation/index.md diff --git a/docs/_settings/content/getting-started/index.md b/DOCUMENTATION/_settings/content/getting-started/index.md similarity index 97% rename from docs/_settings/content/getting-started/index.md rename to DOCUMENTATION/_settings/content/getting-started/index.md index f767d386..05f9265f 100644 --- a/docs/_settings/content/getting-started/index.md +++ b/DOCUMENTATION/_settings/content/getting-started/index.md @@ -26,12 +26,12 @@ Choose the setup the best suits your needs. -#### A) Setup for Single Project +### A) Setup for Single Project > (Follow these steps if you want a separate Docker environment for each project) -##### A.1) Already have a PHP project: +### A.1) Already have a PHP project: > (Follow these steps if you already have a PHP project, and all you need is an environment to run it) 1 - Clone laradock on your project root directory: @@ -58,7 +58,7 @@ Your folder structure should look like this: -##### A.2) Don't have a PHP project yet: +### A.2) Don't have a PHP project yet: > (Follow these steps if you don't have a PHP project yet, and you need an environment to create the project) 1 - Clone this repository anywhere on your machine: @@ -84,7 +84,7 @@ docker-compose stop && docker-compose up -d XXXX YYYY ZZZZ .... ``` -#### B) Setup for Multiple Projects: +### B) Setup for Multiple Projects: > (Follow these steps if you want a single Docker environment for all project) 1 - Clone this repository anywhere on your machine: diff --git a/docs/_settings/content/help/index.md b/DOCUMENTATION/_settings/content/help/index.md similarity index 100% rename from docs/_settings/content/help/index.md rename to DOCUMENTATION/_settings/content/help/index.md diff --git a/docs/_settings/content/index.md b/DOCUMENTATION/_settings/content/index.md similarity index 100% rename from docs/_settings/content/index.md rename to DOCUMENTATION/_settings/content/index.md diff --git a/docs/_settings/content/introduction/index.md b/DOCUMENTATION/_settings/content/introduction/index.md similarity index 100% rename from docs/_settings/content/introduction/index.md rename to DOCUMENTATION/_settings/content/introduction/index.md diff --git a/docs/_settings/content/license/index.md b/DOCUMENTATION/_settings/content/license/index.md similarity index 100% rename from docs/_settings/content/license/index.md rename to DOCUMENTATION/_settings/content/license/index.md diff --git a/docs/_settings/content/related-projects/index.md b/DOCUMENTATION/_settings/content/related-projects/index.md similarity index 100% rename from docs/_settings/content/related-projects/index.md rename to DOCUMENTATION/_settings/content/related-projects/index.md diff --git a/docs/_settings/static/.gitkeep b/DOCUMENTATION/_settings/static/.gitkeep similarity index 100% rename from docs/_settings/static/.gitkeep rename to DOCUMENTATION/_settings/static/.gitkeep diff --git a/docs/_settings/themes/hugo-material-docs/CHANGELOG.md b/DOCUMENTATION/_settings/themes/hugo-material-docs/CHANGELOG.md similarity index 100% rename from docs/_settings/themes/hugo-material-docs/CHANGELOG.md rename to DOCUMENTATION/_settings/themes/hugo-material-docs/CHANGELOG.md diff --git a/docs/_settings/themes/hugo-material-docs/LICENSE.md b/DOCUMENTATION/_settings/themes/hugo-material-docs/LICENSE.md similarity index 100% rename from docs/_settings/themes/hugo-material-docs/LICENSE.md rename to DOCUMENTATION/_settings/themes/hugo-material-docs/LICENSE.md diff --git a/docs/_settings/themes/hugo-material-docs/README.md b/DOCUMENTATION/_settings/themes/hugo-material-docs/README.md similarity index 100% rename from docs/_settings/themes/hugo-material-docs/README.md rename to DOCUMENTATION/_settings/themes/hugo-material-docs/README.md diff --git a/docs/_settings/themes/hugo-material-docs/archetypes/default.md b/DOCUMENTATION/_settings/themes/hugo-material-docs/archetypes/default.md similarity index 100% rename from docs/_settings/themes/hugo-material-docs/archetypes/default.md rename to DOCUMENTATION/_settings/themes/hugo-material-docs/archetypes/default.md diff --git a/docs/_settings/themes/hugo-material-docs/images/screenshot.png b/DOCUMENTATION/_settings/themes/hugo-material-docs/images/screenshot.png similarity index 100% rename from docs/_settings/themes/hugo-material-docs/images/screenshot.png rename to DOCUMENTATION/_settings/themes/hugo-material-docs/images/screenshot.png diff --git a/docs/_settings/themes/hugo-material-docs/images/tn.png b/DOCUMENTATION/_settings/themes/hugo-material-docs/images/tn.png similarity index 100% rename from docs/_settings/themes/hugo-material-docs/images/tn.png rename to DOCUMENTATION/_settings/themes/hugo-material-docs/images/tn.png diff --git a/docs/_settings/themes/hugo-material-docs/layouts/404.html b/DOCUMENTATION/_settings/themes/hugo-material-docs/layouts/404.html similarity index 100% rename from docs/_settings/themes/hugo-material-docs/layouts/404.html rename to DOCUMENTATION/_settings/themes/hugo-material-docs/layouts/404.html diff --git a/docs/_settings/themes/hugo-material-docs/layouts/_default/__list.html b/DOCUMENTATION/_settings/themes/hugo-material-docs/layouts/_default/__list.html similarity index 100% rename from docs/_settings/themes/hugo-material-docs/layouts/_default/__list.html rename to DOCUMENTATION/_settings/themes/hugo-material-docs/layouts/_default/__list.html diff --git a/docs/_settings/themes/hugo-material-docs/layouts/_default/single.html b/DOCUMENTATION/_settings/themes/hugo-material-docs/layouts/_default/single.html similarity index 100% rename from docs/_settings/themes/hugo-material-docs/layouts/_default/single.html rename to DOCUMENTATION/_settings/themes/hugo-material-docs/layouts/_default/single.html diff --git a/docs/_settings/themes/hugo-material-docs/layouts/index.html b/DOCUMENTATION/_settings/themes/hugo-material-docs/layouts/index.html similarity index 100% rename from docs/_settings/themes/hugo-material-docs/layouts/index.html rename to DOCUMENTATION/_settings/themes/hugo-material-docs/layouts/index.html diff --git a/docs/_settings/themes/hugo-material-docs/layouts/partials/drawer.html b/DOCUMENTATION/_settings/themes/hugo-material-docs/layouts/partials/drawer.html similarity index 100% rename from docs/_settings/themes/hugo-material-docs/layouts/partials/drawer.html rename to DOCUMENTATION/_settings/themes/hugo-material-docs/layouts/partials/drawer.html diff --git a/docs/_settings/themes/hugo-material-docs/layouts/partials/footer.html b/DOCUMENTATION/_settings/themes/hugo-material-docs/layouts/partials/footer.html similarity index 100% rename from docs/_settings/themes/hugo-material-docs/layouts/partials/footer.html rename to DOCUMENTATION/_settings/themes/hugo-material-docs/layouts/partials/footer.html diff --git a/docs/_settings/themes/hugo-material-docs/layouts/partials/footer_js.html b/DOCUMENTATION/_settings/themes/hugo-material-docs/layouts/partials/footer_js.html similarity index 100% rename from docs/_settings/themes/hugo-material-docs/layouts/partials/footer_js.html rename to DOCUMENTATION/_settings/themes/hugo-material-docs/layouts/partials/footer_js.html diff --git a/docs/_settings/themes/hugo-material-docs/layouts/partials/head.html b/DOCUMENTATION/_settings/themes/hugo-material-docs/layouts/partials/head.html similarity index 100% rename from docs/_settings/themes/hugo-material-docs/layouts/partials/head.html rename to DOCUMENTATION/_settings/themes/hugo-material-docs/layouts/partials/head.html diff --git a/docs/_settings/themes/hugo-material-docs/layouts/partials/header.html b/DOCUMENTATION/_settings/themes/hugo-material-docs/layouts/partials/header.html similarity index 100% rename from docs/_settings/themes/hugo-material-docs/layouts/partials/header.html rename to DOCUMENTATION/_settings/themes/hugo-material-docs/layouts/partials/header.html diff --git a/docs/_settings/themes/hugo-material-docs/layouts/partials/nav.html b/DOCUMENTATION/_settings/themes/hugo-material-docs/layouts/partials/nav.html similarity index 100% rename from docs/_settings/themes/hugo-material-docs/layouts/partials/nav.html rename to DOCUMENTATION/_settings/themes/hugo-material-docs/layouts/partials/nav.html diff --git a/docs/_settings/themes/hugo-material-docs/layouts/partials/nav_link.html b/DOCUMENTATION/_settings/themes/hugo-material-docs/layouts/partials/nav_link.html similarity index 100% rename from docs/_settings/themes/hugo-material-docs/layouts/partials/nav_link.html rename to DOCUMENTATION/_settings/themes/hugo-material-docs/layouts/partials/nav_link.html diff --git a/docs/_settings/themes/hugo-material-docs/layouts/shortcodes/note.html b/DOCUMENTATION/_settings/themes/hugo-material-docs/layouts/shortcodes/note.html similarity index 100% rename from docs/_settings/themes/hugo-material-docs/layouts/shortcodes/note.html rename to DOCUMENTATION/_settings/themes/hugo-material-docs/layouts/shortcodes/note.html diff --git a/docs/_settings/themes/hugo-material-docs/layouts/shortcodes/warning.html b/DOCUMENTATION/_settings/themes/hugo-material-docs/layouts/shortcodes/warning.html similarity index 100% rename from docs/_settings/themes/hugo-material-docs/layouts/shortcodes/warning.html rename to DOCUMENTATION/_settings/themes/hugo-material-docs/layouts/shortcodes/warning.html diff --git a/docs/_settings/themes/hugo-material-docs/static/fonts/icon.eot b/DOCUMENTATION/_settings/themes/hugo-material-docs/static/fonts/icon.eot similarity index 100% rename from docs/_settings/themes/hugo-material-docs/static/fonts/icon.eot rename to DOCUMENTATION/_settings/themes/hugo-material-docs/static/fonts/icon.eot diff --git a/docs/_settings/themes/hugo-material-docs/static/fonts/icon.svg b/DOCUMENTATION/_settings/themes/hugo-material-docs/static/fonts/icon.svg similarity index 100% rename from docs/_settings/themes/hugo-material-docs/static/fonts/icon.svg rename to DOCUMENTATION/_settings/themes/hugo-material-docs/static/fonts/icon.svg diff --git a/docs/_settings/themes/hugo-material-docs/static/fonts/icon.ttf b/DOCUMENTATION/_settings/themes/hugo-material-docs/static/fonts/icon.ttf similarity index 100% rename from docs/_settings/themes/hugo-material-docs/static/fonts/icon.ttf rename to DOCUMENTATION/_settings/themes/hugo-material-docs/static/fonts/icon.ttf diff --git a/docs/_settings/themes/hugo-material-docs/static/fonts/icon.woff b/DOCUMENTATION/_settings/themes/hugo-material-docs/static/fonts/icon.woff similarity index 100% rename from docs/_settings/themes/hugo-material-docs/static/fonts/icon.woff rename to DOCUMENTATION/_settings/themes/hugo-material-docs/static/fonts/icon.woff diff --git a/docs/_settings/themes/hugo-material-docs/static/images/colors.png b/DOCUMENTATION/_settings/themes/hugo-material-docs/static/images/colors.png similarity index 100% rename from docs/_settings/themes/hugo-material-docs/static/images/colors.png rename to DOCUMENTATION/_settings/themes/hugo-material-docs/static/images/colors.png diff --git a/docs/_settings/themes/hugo-material-docs/static/images/favicon.ico b/DOCUMENTATION/_settings/themes/hugo-material-docs/static/images/favicon.ico similarity index 100% rename from docs/_settings/themes/hugo-material-docs/static/images/favicon.ico rename to DOCUMENTATION/_settings/themes/hugo-material-docs/static/images/favicon.ico diff --git a/docs/_settings/themes/hugo-material-docs/static/images/logo.png b/DOCUMENTATION/_settings/themes/hugo-material-docs/static/images/logo.png similarity index 100% rename from docs/_settings/themes/hugo-material-docs/static/images/logo.png rename to DOCUMENTATION/_settings/themes/hugo-material-docs/static/images/logo.png diff --git a/docs/_settings/themes/hugo-material-docs/static/images/screen.png b/DOCUMENTATION/_settings/themes/hugo-material-docs/static/images/screen.png similarity index 100% rename from docs/_settings/themes/hugo-material-docs/static/images/screen.png rename to DOCUMENTATION/_settings/themes/hugo-material-docs/static/images/screen.png diff --git a/docs/_settings/themes/hugo-material-docs/static/javascripts/application.js b/DOCUMENTATION/_settings/themes/hugo-material-docs/static/javascripts/application.js similarity index 100% rename from docs/_settings/themes/hugo-material-docs/static/javascripts/application.js rename to DOCUMENTATION/_settings/themes/hugo-material-docs/static/javascripts/application.js diff --git a/docs/_settings/themes/hugo-material-docs/static/javascripts/modernizr.js b/DOCUMENTATION/_settings/themes/hugo-material-docs/static/javascripts/modernizr.js similarity index 100% rename from docs/_settings/themes/hugo-material-docs/static/javascripts/modernizr.js rename to DOCUMENTATION/_settings/themes/hugo-material-docs/static/javascripts/modernizr.js diff --git a/docs/_settings/themes/hugo-material-docs/static/stylesheets/application.css b/DOCUMENTATION/_settings/themes/hugo-material-docs/static/stylesheets/application.css similarity index 100% rename from docs/_settings/themes/hugo-material-docs/static/stylesheets/application.css rename to DOCUMENTATION/_settings/themes/hugo-material-docs/static/stylesheets/application.css diff --git a/docs/_settings/themes/hugo-material-docs/static/stylesheets/highlight/highlight.css b/DOCUMENTATION/_settings/themes/hugo-material-docs/static/stylesheets/highlight/highlight.css similarity index 100% rename from docs/_settings/themes/hugo-material-docs/static/stylesheets/highlight/highlight.css rename to DOCUMENTATION/_settings/themes/hugo-material-docs/static/stylesheets/highlight/highlight.css diff --git a/docs/_settings/themes/hugo-material-docs/static/stylesheets/palettes.css b/DOCUMENTATION/_settings/themes/hugo-material-docs/static/stylesheets/palettes.css similarity index 100% rename from docs/_settings/themes/hugo-material-docs/static/stylesheets/palettes.css rename to DOCUMENTATION/_settings/themes/hugo-material-docs/static/stylesheets/palettes.css diff --git a/docs/_settings/themes/hugo-material-docs/static/stylesheets/temporary.css b/DOCUMENTATION/_settings/themes/hugo-material-docs/static/stylesheets/temporary.css similarity index 100% rename from docs/_settings/themes/hugo-material-docs/static/stylesheets/temporary.css rename to DOCUMENTATION/_settings/themes/hugo-material-docs/static/stylesheets/temporary.css diff --git a/docs/_settings/themes/hugo-material-docs/theme.toml b/DOCUMENTATION/_settings/themes/hugo-material-docs/theme.toml similarity index 100% rename from docs/_settings/themes/hugo-material-docs/theme.toml rename to DOCUMENTATION/_settings/themes/hugo-material-docs/theme.toml diff --git a/docs/contributing/index.html b/docs/contributing/index.html index b40742f2..7095c67f 100644 --- a/docs/contributing/index.html +++ b/docs/contributing/index.html @@ -315,39 +315,51 @@

Your contribution is more than welcome.

-

Got a Question or Problem?

+

I have a Question/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).

+

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) And you can still seek help on Gitter for it.

-

Found an Issue?

+

I 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.

+

If have an issue or you found a typo in the documentation, you can help us by +opnening an Issue.

-

Want a Feature?

+

Steps to do before opening an Issue:

-

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.

+
    +

  1. Before you submit your issue search the archive, maybe your question was already answered couple hours ago (search in the closed Issues as well).

    2. -

    Update Documentation (Site)

    +

  2. Decide if the Issue belongs to this project or to Docker itself! or even the tool you are using such as Nginx or MongoDB…

    3. +
+ +

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

+ +

This Help us to maximize the effort we can spend fixing issues and adding new +features, by not reporting duplicate issues.

+ +

I 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 yourself.

+ +

I want to update the Documentation (Site)

Laradock uses Hugo as website generator tool, with the Material Docs theme. You might need to check their docs quickly.

    -
  1. Install Hugo on your machine.
    2. -
  2. Clone laradock.
    3. -
  3. Go to /docs.
    4. -
  4. Delete everything except the _settings folder & the CNAME file.
    5. -
  5. Open docs/_settings from your terminal and run hugo serve to host the website locally.
    6. -
  6. Open the docs/_settings/content and search for the folder of the section you want to edit.
    7. -
  7. In each section there’s an index.md file, that’s the file you need to edit.
    8. -
  8. To edit the sidebar (in case you are adding new section) go to docs/_settings/config.toml and add the section there.
    9. -
  9. After done editing, run the this command hugo to generate the updated site inside the docs folder.
    10. -
  10. Go back to the project root directory, commit and push..
    11. +
  11. Install Hugo on your machine (easy steps).
    12. +
  12. Open the DOCUMENTATION/_settings/content and search for the markdown file you want to edit (every folder is a section in the menu).
    13. +
  13. After done editing, run the this command hugo to generate the updated site inside the docs folder (It’s recommended to delete all files form the /docs folder, except the CNAME file, before running the hugo command).
-

Coding Guidelines

+

To Host the website locally

-

Support new Software

+

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.

+ +

How to support new Software (Add new Container)

-

Edit existing Software

+

Edit existing Software (Edit a Container)

-

Issue/PR Submission Guidelines

+

Pull Request

-

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. -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)

+

1. Before Submitting a Pull Request (PR)

Always Test everything and make sure its working:

@@ -402,16 +406,16 @@ features, by not reporting duplicate issues.

-

Submitting a PR

+

2. Submitting a PR

Consider the following guidelines: