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

Clarify and divide README #103

Merged
merged 1 commit into from
Sep 8, 2022
Merged

Clarify and divide README #103

merged 1 commit into from
Sep 8, 2022

Conversation

nikimanoledaki
Copy link
Contributor

@nikimanoledaki nikimanoledaki commented Sep 7, 2022

What this PR does / why we need it:

This PR:

  • Clarifies and divides the README into logical sections to help a new user understand what the project, specification, library, and CLI are about.
  • Adds a link to the CNCF Code of Conduct in a .md file.
  • Moves documentation links to ocm-spec so that we can make that the SoT (not ocm/docs).

Which issue(s) this PR fixes:
Fixes part of #98

Special notes for your reviewer:

After the conversation on docs, I split the work that I was doing with editing the docs to do it in 2 PRs. The other changes are being moved to the ocm-spec repository rather than the ocm repository.

Note: This is just one iteration of adding to the README and we will iterate on it further.

Release note:

@nikimanoledaki nikimanoledaki added area/documentation Documentation related area/community Community related labels Sep 7, 2022
@nikimanoledaki nikimanoledaki requested a review from a team as a code owner September 7, 2022 14:57
@gardener-robot
Copy link
Contributor

@nikimanoledaki Thank you for your contribution.

@gardener-robot gardener-robot added the size/s Small label Sep 7, 2022
@nikimanoledaki nikimanoledaki merged commit c6a7c60 into main Sep 8, 2022
@mandelsoft mandelsoft deleted the update-readme branch December 21, 2022 15:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/community Community related area/documentation Documentation related size/s Small
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants