Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Readme changes #20818

Merged
merged 60 commits into from
Apr 25, 2024
Merged
Show file tree
Hide file tree
Changes from 54 commits
Commits
Show all changes
60 commits
Select commit Hold shift + click to select a range
c7323ad
initial commit
tsavina Oct 27, 2023
8ec988d
add links
tsavina Oct 30, 2023
d176b9c
try to collapse section
tsavina Oct 30, 2023
a19407e
merge installation and getting started
tsavina Oct 30, 2023
c65c3be
try different headers
tsavina Oct 30, 2023
72d4df2
tutorials section
tsavina Oct 30, 2023
5dbfddc
update products using OV
tsavina Oct 30, 2023
bdece07
installation section change
tsavina Oct 31, 2023
a86e716
last part change
tsavina Nov 1, 2023
cb45b36
fix link
tsavina Nov 9, 2023
717ad44
remove gna
tsavina Feb 9, 2024
2ff22b3
move matrix
tsavina Feb 21, 2024
000e13f
change documentation section
tsavina Feb 21, 2024
4892be8
change content table
tsavina Feb 22, 2024
a1809bf
change intro
tsavina Feb 26, 2024
4ae144c
links fix
tsavina Feb 26, 2024
da3739b
change supported products section
tsavina Feb 26, 2024
ff81f25
change intro
tsavina Feb 26, 2024
50a3f74
get started change
tsavina Feb 26, 2024
49913ac
change GS
tsavina Feb 27, 2024
79b30aa
Merge branch 'master' into readme_changes
tsavina Feb 27, 2024
0133f51
add genAI
tsavina Feb 27, 2024
63cb261
fix format
tsavina Feb 27, 2024
839d05a
fix format
tsavina Feb 27, 2024
61fe31d
fix format optimum
tsavina Feb 27, 2024
2fcdb79
fix format optimum
tsavina Feb 27, 2024
c2279df
wording change
tsavina Feb 28, 2024
d06ea5c
Merge branch 'master' into readme_changes
tsavina Feb 28, 2024
cdb0875
update ref
tsavina Mar 1, 2024
90902b1
Merge branch 'readme_changes' of https://github.com/tsavina/openvino …
tsavina Mar 1, 2024
7fb1d0a
move components to dev docs
tsavina Mar 5, 2024
7aeb4ea
fix comments
tsavina Mar 7, 2024
c51cb09
rewording
tsavina Mar 7, 2024
ad685d7
rewording
tsavina Mar 7, 2024
2f18411
remove list of products
tsavina Mar 11, 2024
2905f47
update links
tsavina Mar 11, 2024
31b0882
update readme
tsavina Mar 11, 2024
8b28437
changes pt2
tsavina Mar 11, 2024
2ffc776
fix typo
tsavina Mar 11, 2024
aae583f
fix references
tsavina Mar 11, 2024
8557687
small wording changes
tsavina Mar 11, 2024
d4efd37
rm additional file
tsavina Mar 11, 2024
23d43a6
links fixes
tsavina Mar 11, 2024
747c7c2
Merge branch 'master' into readme_changes
tsavina Mar 11, 2024
5944236
add license
tsavina Mar 12, 2024
8fcfc9d
Merge branch 'readme_changes' of https://github.com/tsavina/openvino …
tsavina Mar 12, 2024
cca9468
address comments
tsavina Mar 21, 2024
04994e3
add code snippets
tsavina Apr 11, 2024
a27963d
Merge branch 'master' into readme_changes
tsavina Apr 11, 2024
44cf9ff
Update README.md
rkazants Apr 14, 2024
70f9325
Update README.md
rkazants Apr 14, 2024
1f9ed83
Update README.md
rkazants Apr 14, 2024
0bae813
Update README.md
rkazants Apr 14, 2024
2fa9d75
Update README.md
rkazants Apr 14, 2024
88ab772
change notebooks branch
tsavina Apr 18, 2024
2e4c2e4
Merge branch 'readme_changes' of https://github.com/tsavina/openvino …
tsavina Apr 18, 2024
5b55b3c
update notebooks branch
tsavina Apr 18, 2024
ef710ad
Merge branch 'master' into readme_changes
tsavina Apr 23, 2024
e128c63
address comments
tsavina Apr 25, 2024
1c5166b
fix conflict
tsavina Apr 25, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
87 changes: 47 additions & 40 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

## How to contribute to the OpenVINO project

OpenVINO™ is always looking for opportunities to improve and your contributions
play a big role in this process. There are several ways you can make the
OpenVINO™ is always looking for opportunities to improve and your contributions
play a big role in this process. There are several ways you can make the
product better.

# Table of Contents
Expand All @@ -15,85 +15,85 @@ product better.

### Provide Feedback

* **Report bugs / issues**
If you experience faulty behavior in OpenVINO or its components, you can
* **Report bugs / issues**
If you experience faulty behavior in OpenVINO or its components, you can
[create a new issue](https://github.com/openvinotoolkit/openvino/issues)
in the GitHub issue tracker.
in the GitHub issue tracker.

* **Propose new features / improvements**
* **Propose new features / improvements**
If you have a suggestion for improving OpenVINO or want to share your ideas, you can open a new
[GitHub Discussion](https://github.com/openvinotoolkit/openvino/discussions).
If your idea is already well defined, you can also create a
[GitHub Discussion](https://github.com/openvinotoolkit/openvino/discussions).
If your idea is already well defined, you can also create a
[Feature Request Issue](https://github.com/openvinotoolkit/openvino/issues/new?assignees=octocat&labels=enhancement%2Cfeature&projects=&template=feature_request.yml&title=%5BFeature+Request%5D%3A+)
In both cases, provide a detailed description, including use cases, benefits, and potential challenges.
If your points are especially well aligned with the product vision, they will be included in the
[development roadmap](./ROADMAP.md).
If your points are especially well aligned with the product vision, they will be included in the
development roadmap.
User feedback is crucial for OpenVINO development and even if your input is not immediately prioritized,
it may be used at a later time or undertaken by the community, regardless of the official roadmap.


### Contribute Code Changes

* **Fix Bugs or Develop New Features**
If you want to help improving OpenVINO, choose one of the issues reported in
[GitHub Issue Tracker](https://github.com/openvinotoolkit/openvino/issues) and
[create a Pull Request](./CONTRIBUTING_PR.md) addressing it. Consider one of the
tasks listed as [first-time contributions](https://github.com/orgs/openvinotoolkit/projects/3).
If the feature you want to develop is more complex or not well defined by the reporter,
it is always a good idea to [discuss it](https://github.com/openvinotoolkit/openvino/discussions)
* **Fix Bugs or Develop New Features**
If you want to help improving OpenVINO, choose one of the issues reported in
[GitHub Issue Tracker](https://github.com/openvinotoolkit/openvino/issues) and
[create a Pull Request](./CONTRIBUTING_PR.md) addressing it. If you want to start with something simple,
check out the [first-time contributions section](#3-start-working-on-your-good-first-issue).
If the feature you want to develop is more complex or not well defined by the reporter,
it is always a good idea to [discuss it](https://github.com/openvinotoolkit/openvino/discussions)
with OpenVINO developers first. Before creating a new PR, check if nobody is already
working on it. In such a case, you may still help, having aligned with the other developer.

Importantly, always check if the change hasn't been implemented before you start working on it!
You can build OpenVINO using the latest master branch and make sure that it still needs your
changes. Also, do not address issues that only affect older non-LTS releases, like 2022.2.

* **Develop a New Device Plugin**
* **Develop a New Device Plugin**
Since the market of computing devices is constantly evolving, OpenVINO is always open to extending
its support for new hardware. If you want to run inference on a device that is currently not supported,
you can see how to develop a new plugin for it in the
its support for new hardware. If you want to run inference on a device that is currently not supported,
you can see how to develop a new plugin for it in the
[Plugin Developer Guide](https://docs.openvino.ai/canonical/openvino_docs_ie_plugin_dg_overview.html).


### Improve documentation

* **OpenVINO developer documentation** is contained entirely in this repository, under the
* **OpenVINO developer documentation** is contained entirely in this repository, under the
[./docs/dev](https://github.com/openvinotoolkit/openvino/tree/master/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
these documents. Use the files maintained in this repository only for editing purposes.
* **User documentation** is built from several sources and published at
[docs.openvino.ai](https://docs.openvino.ai/), which is the recommended place for reading
these documents. Use the files maintained in this repository only for editing purposes.

* The easiest way to help with documentation is to review it and provide feedback on the
existing articles. Whether you notice a mistake, see the possibility of improving the text,
or think more information should be added, you can reach out to any of the documentation
* The easiest way to help with documentation is to review it and provide feedback on the
existing articles. Whether you notice a mistake, see the possibility of improving the text,
or think more information should be added, you can reach out to any of the documentation
contributors to discuss the potential changes.

You can also create a Pull Request directly, following the [editor's guide](./CONTRIBUTING_DOCS.md).


### Promote and Support OpenVINO

* **Popularize OpenVINO**
Articles, tutorials, blog posts, demos, videos, and any other involvement
in the OpenVINO community is always a welcome contribution. If you discuss
* **Popularize OpenVINO**
Articles, tutorials, blog posts, demos, videos, and any other involvement
in the OpenVINO community is always a welcome contribution. If you discuss
or present OpenVINO on various social platforms, you are raising awareness
of the product among A.I. enthusiasts and enabling other people to discover
the toolkit. Feel free to reach out to OpenVINO developers if you need help
with making such community-based content.

* **Help Other Community Members**
If you are an experienced OpenVINO user and want to help, you can always
share your expertise with the community. Check GitHub Discussions and
Issues to see if you can help someone.
* **Help Other Community Members**
If you are an experienced OpenVINO user and want to help, you can always
share your expertise with the community. Check GitHub Discussions and
Issues to see if you can help someone.

## Technical guide

This section lists all the necessary steps required to set up your environment, build OpenVINO locally, and run tests for specific components. It's a perfect place to start when you have just picked a Good First Issue and are wondering how to start working on it.

Keep in mind that we are here to help - **do not hesitate to ask the development team if something is not clear**. Such questions allow us to keep improving our documentation.

### 1. Prerequisites
### 1. Prerequisites
Copy link
Contributor

@moslex moslex Apr 25, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


You can start with the following links:
- [What is OpenVINO?](https://github.com/openvinotoolkit/openvino#what-is-openvino-toolkit)
Expand Down Expand Up @@ -140,7 +140,14 @@ Choose the component your Good First Issue is related to. You can run tests to m

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

Use the issue description and locally built OpenVINO to complete the task. Remember that you can always ask users tagged in the "Contact points" section for help! You can also visit [Intel DevHub Discord server](https://discord.gg/7pVRxUwdWG) and ask questions in the channel dedicated to Good First Issue support.
To start contributing, pick a task from the [Good First Issues board](https://github.com/orgs/openvinotoolkit/projects/3).

To be assigned to an issue, simply leave a comment with the `.take` command in the selected issue.
Use the issue description and build OpenVINO locally to complete the task.

You can always ask users tagged in the "Contact points" section for help!
Visit [Intel DevHub Discord server](https://discord.gg/7pVRxUwdWG) and ask
questions in the channel dedicated to Good First Issue support.

### 4. Submit a PR with your changes

Expand All @@ -152,5 +159,5 @@ We'll make sure to review your Pull Request as soon as possible and provide you

## License

By contributing to the OpenVINO project, you agree that your contributions will be
By contributing to the OpenVINO project, you agree that your contributions will be
licensed under the terms stated in the [LICENSE](./LICENSE) file.
Loading
Loading