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] Add a single-point starter guide for contributors #21322

Merged
merged 11 commits into from
Dec 14, 2023

Conversation

p-wysocki
Copy link
Contributor

@p-wysocki p-wysocki commented Nov 27, 2023

Details:

  • Add a single point of entry into OpenVINO documentation
  • The document guides new OpenVINO contributors from cloning the repository all the way to submitting a Pull Request
  • The links allow for quick access to all (?) important documentation starting points for each component

TODO

  • I believe we should simplify CONTRIBUTING.md, CONTRIBUTING_ROADMAP.md, get_started.md and so on, preferably merge into one
  • "Roadmap" may be a confusing name, this document may require name change

Tickets:

  • N/A

@p-wysocki p-wysocki added WIP work in progress do_not_review labels Nov 27, 2023
@p-wysocki p-wysocki requested review from a team as code owners November 27, 2023 15:55
@github-actions github-actions bot added category: CI OpenVINO public CI category: docs OpenVINO documentation labels Nov 27, 2023

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 up to keep improving our documentation.

## 1. Prerequisites
Copy link

Choose a reason for hiding this comment

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

Would it make sense to also provide short tutorial/link on how to use git? It doesn't need to be external one, we can redirect to our internal one -- something similar to this: https://numpy.org/doc/stable/dev/index.html#development-process-summary

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good point, from what I've seen a great deal of contributors are not familiar with working with forks. I'll think about how to deal with that, a guide on working with many remotes and forking tailored specifically for OV might be a good idea.

CONTRIBUTING_ROADMAP.md Outdated Show resolved Hide resolved
Copy link
Contributor

@mitruska mitruska left a comment

Choose a reason for hiding this comment

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

As we discussed, it's worth to consider a FAQ (Frequently Asked Questions) section.
It could be supported by links to the already existing useful comments from reviewers/maintainers for issues, where such question was already resolved.

Copy link
Contributor

@kblaszczak-intel kblaszczak-intel left a comment

Choose a reason for hiding this comment

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

That is a very cool addition! I've added tiny language adjustments but they are barely relevant.

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
p-wysocki and others added 7 commits December 13, 2023 16:47
Co-authored-by: Karol Blaszczak <[email protected]>
Co-authored-by: Karol Blaszczak <[email protected]>
Co-authored-by: Karol Blaszczak <[email protected]>
Co-authored-by: Karol Blaszczak <[email protected]>
Co-authored-by: Karol Blaszczak <[email protected]>
Co-authored-by: Karol Blaszczak <[email protected]>
@p-wysocki p-wysocki removed WIP work in progress do_not_review labels Dec 13, 2023
@p-wysocki p-wysocki changed the title [Docs][WIP] Add a single-point starter guide for contributors [Docs] Add a single-point starter guide for contributors Dec 13, 2023
@p-wysocki
Copy link
Contributor Author

@jiwaszki @mitruska I'll address your suggestions in a separate PR, I really want to merge this one ASAP. Just letting you know that I did not forget about them. :)

@jiwaszki jiwaszki enabled auto-merge (squash) December 13, 2023 15:54
@mlukasze
Copy link
Contributor

please add ticket ID which you will use to follow up

@p-wysocki
Copy link
Contributor Author

@mlukasze done.

As we discussed, it's worth to consider a FAQ (Frequently Asked Questions) section.
It could be supported by links to the already existing useful comments from reviewers/maintainers for issues, where such question was already resolved.

Continued in 127561.

Would it make sense to also provide short tutorial/link on how to use git?

Continued in 127562.

@jiwaszki jiwaszki merged commit f4b2f95 into openvinotoolkit:master Dec 14, 2023
63 checks passed
@p-wysocki p-wysocki deleted the gfi_guide branch December 14, 2023 16:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
category: CI OpenVINO public CI category: docs OpenVINO documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants