diff --git a/docs/_settings/content/contributing/index.md b/docs/_settings/content/contributing/index.md index 838bca78..eba88237 100644 --- a/docs/_settings/content/contributing/index.md +++ b/docs/_settings/content/contributing/index.md @@ -5,25 +5,43 @@ weight: 6 --- -## 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](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). -### 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](https://github.com/laradock/laradock/issues). 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](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. +## Edit the documentation + +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 secion 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.. + + + + + ## Coding Guidelines -### Support new Software +## Support new Software * Create folder with the software name. @@ -37,7 +55,7 @@ You can request a new feature by submitting an [Issue](https://github.com/larado * Add the software in the `Readme`. -### Edit existing Software +## Edit existing Software * Open the software (container) folder. @@ -50,7 +68,7 @@ you need to edit their Dockerfiles from their GitHub repositories. For more info ## 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. @@ -58,7 +76,7 @@ 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: @@ -71,7 +89,7 @@ Always Test everything and make sure its working: - Test it in real App. -### Submitting a PR +## 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. @@ -109,7 +127,7 @@ git push origin my-fix-branch -f -### 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: @@ -143,4 +161,4 @@ from the main (upstream) repository:
-### Happy Coding :) +## Happy Coding :) diff --git a/docs/contributing/index.html b/docs/contributing/index.html index 287932a7..8995f990 100644 --- a/docs/contributing/index.html +++ b/docs/contributing/index.html @@ -336,26 +336,41 @@ -

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.

+

Edit the documentation

+ +

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 secion 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. +
+

Coding Guidelines

-

Support new Software

+

Support new Software

-

Edit existing Software

+

Edit existing Software

-

Submitting a PR

+

Submitting a PR

Consider the following guidelines:

@@ -454,7 +469,7 @@ 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.

-

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:

@@ -483,7 +498,7 @@ from the main (upstream) repository:


-

Happy Coding :)

+

Happy Coding :)