This repository has been archived by the owner on Dec 13, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 240
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
enh(GitHub): add more information (#7552)
* doc(README): Add README to provide instructions for documentation * enh(CONTRIBUTING.md): add section for the documentation * enh(FEATURE_REQUEST.md): fully use the markdown language * enh(ISSUE_TEMPLATE.md): ask for more information * Asking for browser information * Asking for logs * Fully use the markdown syntax * enh(PULL_REQUEST_TEMPLATE.md): fully use markdown syntax
- Loading branch information
Showing
5 changed files
with
135 additions
and
47 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,39 +1,39 @@ | ||
| <h1> Contributing to Centreon project </h1> | ||
| # Contributing to Centreon project | ||
|
|
||
| :clap: First thing first... Thank you for taking the time to contribute to Centreon project ! :clap: Much appreciated ! :metal: | ||
|
|
||
| This article contains guidelines for contributing to [Centreon](https://github.com/centreon/) project. | ||
|
|
||
| <h3>Table of contents </h3> | ||
| ### Table of contents | ||
|
|
||
| [I have a question](#i-have-a-question-) | ||
|
|
||
| [How can I contribute?](#-how-can-i-contribute-) | ||
| * [Where should I report ?](#-where-shoud-i-report-) | ||
| * [I have an issue to report](#-i-have-an-issue-to-report-) | ||
| * [I have a suggestion of enhancement](#-i-have-a-suggestion-of-enhancement-) | ||
| * [I have a pull request to submit](#-i-have-a-pull-request-to-submit-) | ||
| - [Where should I report ?](#-where-shoud-i-report-) | ||
| - [I have an issue to report](#-i-have-an-issue-to-report-) | ||
| - [I have a suggestion of enhancement](#-i-have-a-suggestion-of-enhancement-) | ||
| - [I have a pull request to submit](#-i-have-a-pull-request-to-submit-) | ||
|
|
||
| [Centreon style guides](#-centreon-style-guides-) | ||
| * [Formating commit messages](#-formating-commit-messages-) | ||
| * [Coding style](#-coding-style-) | ||
| - [Formating commit messages](#-formating-commit-messages-) | ||
| - [Coding style](#-coding-style-) | ||
|
|
||
| <h2> Code of Conduct </h2> | ||
| ## Code of Conduct | ||
|
|
||
| Any people that wants to contribute and participate in developping the project must respect [Centreon Code of Conduct](CODE_OF_CONDUCT.md). Please report any unacceptable behavior to [[email protected]](mailto:[email protected]). | ||
|
|
||
| <h2> I have a question </h2> | ||
| ## I have a question | ||
|
|
||
| > **Advise**: Centreon GitHub is meant for opening issues (code related), feature requests and so on. It is not **meant** for **support**. Please refer to the following available ressources, you'll get an answer from a Centreon team or community member. | ||
|
|
||
| * [Official Centreon Slack](https://centreon.github.io/register-slack) | ||
| - [Official Centreon Slack](https://centreon.github.io/register-slack) | ||
|
|
||
| <h2> How can I contribute </h2> | ||
| ## How can I contribute | ||
|
|
||
| Centreon community can contribute in **many ways** to the project. | ||
|
|
||
| <h3> Where shoud I report ? </h3> | ||
| ### Where shoud I report ? | ||
|
|
||
| Issues and feature requests should be done on the **appropriate repositories**. Here are the repositories maintened by Centreon: | ||
|
|
||
|
|
@@ -60,27 +60,27 @@ Issues and feature requests should be done on the **appropriate repositories**. | |
| | [centreon-widget-engine-status](https://github.com/centreon/centreon-widget-engine-status) | ||
|
|
||
|
|
||
| <h3> I have an issue to report </h3> | ||
| ### I have an issue to report | ||
|
|
||
| Before reporting an issue please make sure that it has not been already reported by checking [Centreon Bug Tracker](https://github.com/centreon/centreon/issues) | ||
|
|
||
| If your issue has **not** been reported yet, then the issue should be opened using the following template [ISSUE_TEMPLATE.md](.github/ISSUE_TEMPLATE.md) | ||
|
|
||
| <h3> I have a suggestion of enhancement </h3> | ||
| ### I have a suggestion of enhancement | ||
|
|
||
| Any ideas, enhancements, feature requests are more than welcome. Feature requests should be opened by using the following template [FEATURE_REQUEST.md](.github/FEATURE_REQUEST.md) | ||
|
|
||
| <h3> I have a pull request to submit </h3> | ||
| ### I have a pull request to submit | ||
|
|
||
| You have been working on Centreon base code and want to submit it to us. Well... Again you are more than welcome and thank you in advance ! :clap: | ||
|
|
||
| The pull request should respect the some requirements that can found in the following template [PULL_REQUEST_TEMPLATE.md](.github/PULL_REQUEST_TEMPLATE.md) | ||
|
|
||
| > **Notice**: Any pull request that does not respect those requirements will be legitimately rejected ! | ||
| <h3> Centreon style guides </h3> | ||
| ### Centreon style guides | ||
|
|
||
| <h4> Formating commit messages </h4> | ||
| #### Formating commit messages | ||
|
|
||
| The commit format should follow this commit template message | ||
| ``` | ||
|
|
@@ -101,18 +101,18 @@ Applied to the sample ticket | |
| Refs: #5567 (GitHub) or MON-2234 (Jira) | ||
| ``` | ||
| The ***type*** can refer to | ||
| * **feat**: adding a feature | ||
| * **fix**: adding a patch | ||
| * **enh**: adding an enhancement | ||
| * **docs**: adding documentation changes | ||
| * **style**: fixing coding style issues | ||
| * **refactor**: code refactoring | ||
| * **test**: adding new tests or fixing old ones | ||
| * **chore** : updating project construction files (Jenkins files, CMakefile, gulp, webpack ...) | ||
| - **feat**: adding a feature | ||
| - **fix**: adding a patch | ||
| - **enh**: adding an enhancement | ||
| - **docs**: adding documentation changes | ||
| - **style**: fixing coding style issues | ||
| - **refactor**: code refactoring | ||
| - **test**: adding new tests or fixing old ones | ||
| - **chore** : updating project construction files (Jenkins files, CMakefile, gulp, webpack ...) | ||
|
|
||
| The ***scope*** is defined by project. Scopes for Centreon Open Source project can be found [here](scopes/centreon.md). | ||
|
|
||
| <h4> Coding style </h4> | ||
| #### Coding style | ||
|
|
||
| Centreon software is made of several languages. For each language a specific coding style **must be respected**. | ||
|
|
||
|
|
@@ -124,6 +124,11 @@ For other languages, coding style rules are defined in Centreon GitHub repositor | |
| * [HTML](https://github.com/centreon/centreon/tree/master/doc/coding-style/html) | ||
| * [JavaScript](https://github.com/centreon/centreon/tree/master/doc/coding-style/js) | ||
|
|
||
| #### Documentation | ||
|
|
||
| If you want to visualize and suggest modification to the documentation through a pull request | ||
| you can check the **HOW TO** build the documentation section [here](doc/README.md) | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| # Centreon documentation | ||
|
|
||
| The official **Centreon documentation** can be found [here](https://documentation.centreon.com/docs/centreon/en/latest/) | ||
|
|
||
| It is possible to build the **official** Centreon documentation if you want to visualize it | ||
| or make some modifications. | ||
|
|
||
| ## Prerequisite | ||
|
|
||
| You will need to install a python dependency. | ||
|
|
||
| On **debian based** distributions | ||
| ``` | ||
| sudo apt-get install python-sphinx | ||
| ``` | ||
| On **RedHat based** distributions | ||
| ``` | ||
| sudo yum install python-sphinx | ||
| ``` | ||
| On **Arch based** distributions | ||
| ``` | ||
| sudo pacman -S python-sphinx | ||
| ``` | ||
|
|
||
| ## Compile | ||
|
|
||
| Once the dependency installed you will have to compile the documentation either the | ||
| French or English version. For the example lets compile the English version. | ||
|
|
||
| Go to the directory: | ||
| ``` | ||
| cd en/ | ||
| ``` | ||
|
|
||
| Then compile: | ||
| ``` | ||
| make clean ; make html | ||
| ``` | ||
|
|
||
| We can use python to serve the `_build/html` directory and visualize the built documentation | ||
|
|
||
| If you are running **python2**: | ||
| ``` | ||
| cd _build/html | ||
| python -m SimpleHTTPServer | ||
| ``` | ||
| If you are running **python3**: | ||
| ``` | ||
| cd _build/html | ||
| python3 -m http.server | ||
| ``` |