CONTRIBUTING_DOCS.md

   1 # Contribute to Documentation
   2
   3 If you want to contribute to a project documentation and make it better, your help is very welcome.
   4 This guide puts together the guidelines to help you figure out how you can offer your feedback and contribute to the documentation.
   5
   6 ## Contribute in Multiple ways
   7
   8 There are multiple ways to help improve our documentation:
   9 * [Log an issue](https://jira.devtools.intel.com/projects/CVS/issues): Enter an issue for the OpenVINO™ documentation component for minor issues such as typos.
  10 * Make a suggestion: Send your documentation suggestion to the mailing list.
  11 * Contribute via GitHub: Submit pull requests in the [GitHub](https://github.com/openvinotoolkit/openvino/tree/master/docs) documentation repository.
  12
  13 ## Contribute via GitHub
  14
  15 Use the following steps to contribute in the OpenVINO™ Toolkit documentation
  16
  17 ### Use Documentation Guidelines
  18 The documentation for our project is written using Markdown. Use our [guidelines](./docs/documentation_guidelines.md) and best practices to write consistent, readable documentation:
  19
  20 * **[Authoring Guidelines](./docs/documentation_guidelines.md#authoring-guidelines)**
  21 * **[Structure Guidelines](./docs/documentation_guidelines.md#structure-guidelines)**
  22 * **[Formatting Guidelines](./docs/documentation_guidelines.md#structure-guidelines)**
  23 * **[Graphics Guidelines](./docs/documentation_guidelines.md#graphics-guidelines)**
  24
  25 ### Add New Document to the Documentation
  26 > **NOTE**: Please check if that information can be added to existing documents instead of creating a new one.
  27
  28 1. Fork the [OpenVINO™ Toolkit](https://github.com/openvinotoolkit/openvino) repository.
  29 2. Create a new branch.
  30 3. Create a new markdown file in an appropriate folder.
  31     > **REQUIRED**: The document title must contain a document label in a form: `{#openvino_docs_<name>}`. For example: `Deep Learning Network Intermediate Representation and Operation Sets in OpenVINO™ {#openvino_docs_MO_DG_IR_and_opsets}`.
  32 4. Add your file to the documentation structure. Open the documentation structure file [docs/doxygen/ie_docs.xml](./docs/doxygen/ie_docs.xml) and add your file path to the appropriate section.
  33 5. Commit changes to your branch.
  34 6. Create a pull request.
  35 7. Once the pull request is created, automatic checks are started. All checks must pass to continue.
  36 8. Discuss, review, and update your contributions.
  37 9. Get merged once the maintainer approves.
  38
  39 ### Edit Existing Document
  40 1. Fork the [OpenVINO™ Toolkit](https://github.com/openvinotoolkit/openvino) repository.
  41 2. Create a new branch.
  42 3. Edit the documentation markdown file and commit changes to the branch.
  43 4. Create a pull request.
  44 5. Once the pull request is created, automatic checks are started. All checks must pass to continue.
  45 6. Discuss, review, and update your contributions.
  46 7. Get merged once the maintainer approves.
  47
  48 ### Delete Document from the Documentation
  49 1. Fork the [OpenVINO™ Toolkit](https://github.com/openvinotoolkit/openvino) repository.
  50 2. Create a new branch.
  51 3. Remove the documentation file.
  52 4. Remove your file from the documentation structure. Open the documentation structure file [docs/doxygen/ie_docs.xml](./docs/doxygen/ie_docs.xml) and remove all occurences of your file path.
  53 5. Remove all references to that file from other documents or replace with links to alternatives topics (if any).
  54 6. Commit changes to your branch.
  55 7. Create a pull request.
  56 8. Once the pull request is created, automatic checks are started. All checks must pass to continue.
  57 9. Discuss, review, and update your contributions.
  58 10. Get merged once the maintainer approves.