Skip to content

Commit

Permalink
[DOCS] Refactoring OV versions in references (#28410)
Browse files Browse the repository at this point in the history
setting 24.6 references to be fixed
  • Loading branch information
kblaszczak-intel authored Jan 14, 2025
1 parent d11b79c commit 0497ab9
Show file tree
Hide file tree
Showing 70 changed files with 689 additions and 689 deletions.
44 changes: 22 additions & 22 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ product better.
### Improve documentation

* **OpenVINO developer documentation** is contained entirely in this repository, under the
[./docs/dev](https://github.com/openvinotoolkit/openvino/tree/master/docs/dev) folder.
[./docs/dev](https://github.com/openvinotoolkit/openvino/tree/releases/2024/6/docs/dev) folder.

* **User documentation** is built from several sources and published at
[docs.openvino.ai](https://docs.openvino.ai/), which is the recommended place for reading
Expand Down Expand Up @@ -97,47 +97,47 @@ Keep in mind that we are here to help - **do not hesitate to ask the development

You can start with the following links:
- [What is OpenVINO?](https://github.com/openvinotoolkit/openvino#what-is-openvino-toolkit)
- [OpenVINO architecture](https://github.com/openvinotoolkit/openvino/blob/master/src/docs/architecture.md)
- [OpenVINO architecture](https://github.com/openvinotoolkit/openvino/blob/releases/2024/6/src/docs/architecture.md)
- [User documentation](https://docs.openvino.ai/)
- [Blog post on contributing to OpenVINO](https://medium.com/openvino-toolkit/how-to-contribute-to-an-ai-open-source-project-c741f48e009e)
- [Pick up a Good First Issue](https://github.com/orgs/openvinotoolkit/projects/3)
- Check out [Intel DevHub Discord server](https://discord.gg/7pVRxUwdWG) - engage in discussions, ask questions and talk to OpenVINO developers

### 2. Building the project

In order to build the project, follow the [build instructions for your specific OS](https://github.com/openvinotoolkit/openvino/blob/master/docs/dev/build.md).
In order to build the project, follow the [build instructions for your specific OS](https://github.com/openvinotoolkit/openvino/blob/releases/2024/6/docs/dev/build.md).

### 3. Familiarize yourself with the component you'll be working with

Choose the component your Good First Issue is related to. You can run tests to make sure it works correctly.

##### APIs
- [C API](https://github.com/openvinotoolkit/openvino/tree/master/src/bindings/c)
- [Core](https://github.com/openvinotoolkit/openvino/tree/master/src/core)
- [Python API](https://github.com/openvinotoolkit/openvino/tree/master/src/bindings/python)
- [Node.js API](https://github.com/openvinotoolkit/openvino/tree/master/src/bindings/js/node)
- [C API](https://github.com/openvinotoolkit/openvino/tree/releases/2024/6/src/bindings/c)
- [Core](https://github.com/openvinotoolkit/openvino/tree/releases/2024/6/src/core)
- [Python API](https://github.com/openvinotoolkit/openvino/tree/releases/2024/6/src/bindings/python)
- [Node.js API](https://github.com/openvinotoolkit/openvino/tree/releases/2024/6/src/bindings/js/node)

##### Frontends
- [IR Frontend](https://github.com/openvinotoolkit/openvino/tree/master/src/frontends/ir)
- [ONNX Frontend](https://github.com/openvinotoolkit/openvino/tree/master/src/frontends/onnx)
- [PaddlePaddle Frontend](https://github.com/openvinotoolkit/openvino/tree/master/src/frontends/paddle)
- [PyTorch Frontend](https://github.com/openvinotoolkit/openvino/tree/master/src/frontends/pytorch)
- [TensorFlow Frontend](https://github.com/openvinotoolkit/openvino/tree/master/src/frontends/tensorflow)
- [IR Frontend](https://github.com/openvinotoolkit/openvino/tree/releases/2024/6/src/frontends/ir)
- [ONNX Frontend](https://github.com/openvinotoolkit/openvino/tree/releases/2024/6/src/frontends/onnx)
- [PaddlePaddle Frontend](https://github.com/openvinotoolkit/openvino/tree/releases/2024/6/src/frontends/paddle)
- [PyTorch Frontend](https://github.com/openvinotoolkit/openvino/tree/releases/2024/6/src/frontends/pytorch)
- [TensorFlow Frontend](https://github.com/openvinotoolkit/openvino/tree/releases/2024/6/src/frontends/tensorflow)

##### Plugins
- [Auto plugin](https://github.com/openvinotoolkit/openvino/blob/master/src/plugins/auto)
- [CPU plugin](https://github.com/openvinotoolkit/openvino/blob/master/src/plugins/intel_cpu)
- [GPU plugin](https://github.com/openvinotoolkit/openvino/blob/master/src/plugins/intel_gpu)
- [NPU plugin](https://github.com/openvinotoolkit/openvino/blob/master/src/plugins/intel_npu)
- [Hetero plugin](https://github.com/openvinotoolkit/openvino/blob/master/src/plugins/hetero)
- [Template plugin](https://github.com/openvinotoolkit/openvino/tree/master/src/plugins/template)
- [Auto plugin](https://github.com/openvinotoolkit/openvino/blob/releases/2024/6/src/plugins/auto)
- [CPU plugin](https://github.com/openvinotoolkit/openvino/blob/releases/2024/6/src/plugins/intel_cpu)
- [GPU plugin](https://github.com/openvinotoolkit/openvino/blob/releases/2024/6/src/plugins/intel_gpu)
- [NPU plugin](https://github.com/openvinotoolkit/openvino/blob/releases/2024/6/src/plugins/intel_npu)
- [Hetero plugin](https://github.com/openvinotoolkit/openvino/blob/releases/2024/6/src/plugins/hetero)
- [Template plugin](https://github.com/openvinotoolkit/openvino/tree/releases/2024/6/src/plugins/template)

##### Tools
- [Benchmark Tool](https://github.com/openvinotoolkit/openvino/tree/master/tools/benchmark_tool)
- [OpenVINO Model Converter](https://github.com/openvinotoolkit/openvino/tree/master/tools/ovc)
- [Benchmark Tool](https://github.com/openvinotoolkit/openvino/tree/releases/2024/6/tools/benchmark_tool)
- [OpenVINO Model Converter](https://github.com/openvinotoolkit/openvino/tree/releases/2024/6/tools/ovc)

##### Others
- [Documentation](https://github.com/openvinotoolkit/openvino/blob/master/CONTRIBUTING_DOCS.md)
- [Documentation](https://github.com/openvinotoolkit/openvino/blob/releases/2024/6/CONTRIBUTING_DOCS.md)

### 3. Start working on your Good First Issue

Expand All @@ -152,7 +152,7 @@ questions in the channel dedicated to Good First Issue support.

### 4. Submit a PR with your changes

Follow our [Good Pull Request guidelines](https://github.com/openvinotoolkit/openvino/blob/master/CONTRIBUTING_PR.md). Please remember about [linking your Pull Request to the issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#manually-linking-a-pull-request-to-an-issue-using-the-pull-request-sidebar) it addresses.
Follow our [Good Pull Request guidelines](https://github.com/openvinotoolkit/openvino/blob/releases/2024/6/CONTRIBUTING_PR.md). Please remember about [linking your Pull Request to the issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#manually-linking-a-pull-request-to-an-issue-using-the-pull-request-sidebar) it addresses.

### 5. Wait for a review

Expand Down
40 changes: 20 additions & 20 deletions CONTRIBUTING_PR.md
Original file line number Diff line number Diff line change
@@ -1,53 +1,53 @@
# How to Prepare a Good PR

OpenVINO is an open-source project and you can contribute to its code directly.
To do so, follow these guidelines for creating Pull Requests, so that your
OpenVINO is an open-source project and you can contribute to its code directly.
To do so, follow these guidelines for creating Pull Requests, so that your
changes get the highest chance of being merged.


## General Rules of a Good Pull Request

* Create your own fork of the repository and use it to create PRs.
* Create your own fork of the repository and use it to create PRs.
Avoid creating change branches in the main repository.
* Choose a proper branch for your work and create your own branch based on it.
* Give your branches, commits, and Pull Requests meaningful names and descriptions.
It helps to track changes later. If your changes cover a particular component,
* Choose a proper branch for your work and create your own branch based on it.
* Give your branches, commits, and Pull Requests meaningful names and descriptions.
It helps to track changes later. If your changes cover a particular component,
you can indicate it in the PR name as a prefix, for example: ``[DOCS] PR name``.
* Follow the [OpenVINO code style guide](https://github.com/openvinotoolkit/openvino/blob/master/docs/dev/coding_style.md).
* Make your PRs small - each PR should address one issue. Remove all changes
* Follow the [OpenVINO code style guide](https://github.com/openvinotoolkit/openvino/blob/releases/2024/6/docs/dev/coding_style.md).
* Make your PRs small - each PR should address one issue. Remove all changes
unrelated to the PR.
* [Link your Pull Request to an issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#manually-linking-a-pull-request-to-an-issue-using-the-pull-request-sidebar) if it addresses one.
* Document your contribution! If your changes may impact how the user works with
OpenVINO, provide the information in proper articles. You can do it yourself,
OpenVINO, provide the information in proper articles. You can do it yourself,
or contact one of OpenVINO documentation contributors to work together on
developing the right content.
developing the right content.
* For Work In Progress, or checking test results early, use a Draft PR.


## Ensure Change Quality

Your pull request will be automatically tested by OpenVINO™'s pre-commit and marked
as "green" if it is ready for merging. If any builders fail, the status is "red,"
you need to fix the issues listed in console logs. Any change to the PR branch will
Your pull request will be automatically tested by OpenVINO™'s pre-commit and marked
as "green" if it is ready for merging. If any builders fail, the status is "red,"
you need to fix the issues listed in console logs. Any change to the PR branch will
automatically trigger the checks, so you don't need to recreate the PR, Just wait
for the updated results.
for the updated results.

Regardless of the automated tests, you should ensure the quality of your changes:

* Test your changes locally:
* Make sure to double-check your code.
* Run tests locally to identify and fix potential issues (execute test binaries
* Make sure to double-check your code.
* Run tests locally to identify and fix potential issues (execute test binaries
from the artifacts directory, e.g. ``<source dir>/bin/intel64/Release/ieFuncTests``)
* Before creating a PR, make sure that your branch is up to date with the latest
state of the branch you want to contribute to (e.g. git fetch upstream && git
* Before creating a PR, make sure that your branch is up to date with the latest
state of the branch you want to contribute to (e.g. git fetch upstream && git
merge upstream/master).


## Branching Policy

* The "master" branch is used for development and constitutes the base for each new release.
* Each OpenVINO release has its own branch: ``releases/<year>/<release number>``.
* The final release each year is considered a Long Term Support version,
* The final release each year is considered a Long Term Support version,
which means it remains active.
* Contributions are accepted only by active branches, which are:
* the "master" branch for future releases,
Expand All @@ -57,7 +57,7 @@ Regardless of the automated tests, you should ensure the quality of your changes

## Need Additional Help? Check these Articles

* [How to create a fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo)
* [How to create a fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo)
* [Install Git](https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup)
* If you want to add a new sample, please have a look at the Guide for contributing
to C++/C/Python OV samples and add the license statement at the top of new files for
Expand Down
2 changes: 1 addition & 1 deletion docs/articles_en/about-openvino.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ To learn about the main properties of OpenVINO, see the :doc:`Key Features <abou
Architecture
##############################################################

To learn more about how OpenVINO works, read the Developer documentation on its `architecture <https://github.com/openvinotoolkit/openvino/blob/master/src/docs/architecture.md>`__ and `core components <https://github.com/openvinotoolkit/openvino/blob/master/src/README.md>`__.
To learn more about how OpenVINO works, read the Developer documentation on its `architecture <https://github.com/openvinotoolkit/openvino/blob/releases/2024/6/src/docs/architecture.md>`__ and `core components <https://github.com/openvinotoolkit/openvino/blob/releases/2024/6/src/README.md>`__.

OpenVINO Ecosystem
##############################################################
Expand Down
14 changes: 7 additions & 7 deletions docs/articles_en/about-openvino/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ you can always ask if you can help.

Choose one of the issues reported in
`GitHub Issue Tracker <https://github.com/openvinotoolkit/openvino/issues>`__ and
`create a Pull Request <https://github.com/openvinotoolkit/openvino/blob/master/CONTRIBUTING_PR.md>`__
`create a Pull Request <https://github.com/openvinotoolkit/openvino/blob/releases/2024/6/CONTRIBUTING_PR.md>`__
(PR) addressing it.

If you find a new bug and want to fix it, you should still
Expand Down Expand Up @@ -96,17 +96,17 @@ can see how to develop a new plugin for it in the
#####################################

OpenVINO user documentation is built from several sources, mainly the files in
the `docs/articles_en <https://github.com/openvinotoolkit/openvino/tree/master/docs/articles_en>`__
the `docs/articles_en <https://github.com/openvinotoolkit/openvino/tree/releases/2024/6/docs/articles_en>`__
folder, using `Sphinx <https://www.sphinx-doc.org/>`__ and the
`reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`__
markup language.

OpenVINO `developer documentation <https://github.com/openvinotoolkit/openvino/tree/master/docs/dev>`__
is available only in markdown in the `docs/dev <https://github.com/openvinotoolkit/openvino/tree/master/docs/dev>`__
OpenVINO `developer documentation <https://github.com/openvinotoolkit/openvino/tree/releases/2024/6/docs/dev>`__
is available only in markdown in the `docs/dev <https://github.com/openvinotoolkit/openvino/tree/releases/2024/6/docs/dev>`__
folder.

To edit docs, consider using the Editor’s
`guide <https://github.com/openvinotoolkit/openvino/blob/master/CONTRIBUTING_DOCS.md>`__
`guide <https://github.com/openvinotoolkit/openvino/blob/releases/2024/6/CONTRIBUTING_DOCS.md>`__
and contacting `documentation maintainers <https://github.com/orgs/openvinotoolkit/teams/openvino-docs-maintainers>`__,
who will help you with information architecture and formatting, as well as
review, adjust, and merge the PR.
Expand Down Expand Up @@ -155,15 +155,15 @@ you can help someone.
.. note::

By contributing to the OpenVINO project, you agree that your contributions
will be licensed under `the terms of the OpenVINO repository <https://github.com/openvinotoolkit/openvino/blob/master/LICENSE>`__.
will be licensed under `the terms of the OpenVINO repository <https://github.com/openvinotoolkit/openvino/blob/releases/2024/6/LICENSE>`__.


Additional Resources
#####################

- :doc:`Code Contribution Guide <./contributing/code-contribution-guide>`
- Choose a `"Good First Issue" <https://github.com/orgs/openvinotoolkit/projects/3>`__.
- Learn more about `OpenVINO architecture <https://github.com/openvinotoolkit/openvino/blob/master/src/docs/architecture.md>`__.
- Learn more about `OpenVINO architecture <https://github.com/openvinotoolkit/openvino/blob/releases/2024/6/src/docs/architecture.md>`__.
- Check out a `blog post on contributing to OpenVINO <https://medium.com/openvino-toolkit/how-to-contribute-to-an-ai-open-source-project-c741f48e009e>`__.
- Visit `Intel DevHub Discord server <https://discord.gg/7pVRxUwdWG>`__ to join
discussions and talk to OpenVINO developers.
Loading

0 comments on commit 0497ab9

Please sign in to comment.