Skip to content

Modified docs to adhere to schema_1st PR #43

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 3 commits into from
Apr 1, 2021
Merged

Modified docs to adhere to schema_1st PR #43

merged 3 commits into from
Apr 1, 2021

Conversation

jc-berger
Copy link
Contributor

@jc-berger jc-berger commented Mar 1, 2021 •
edited
Loading

For Jira #2557.

See related GitHub issues:

For this PR, I've only gone through our authoring stacks docs. I cross-walked these docs to the schema to make these docs better align with the schema.

Tagging @rkratky for your awareness. I've notified Kevin as well. Thanks :)

@jc-berger jc-berger added the documentation Improvements or additions to documentation label Mar 1, 2021
@jc-berger jc-berger self-assigned this Mar 1, 2021
This was referenced Mar 1, 2021
Closed
Closed
@jc-berger
Copy link
Contributor Author

Please note, given the fact this PR already has 9 docs with changes, I'm going to make several PRs to resolve the issue of our content not aligning with the schema. By making several PRs, there will be less docs for each PR, hence, quickening the review process and making it easier.

rkratky
rkratky reviewed Mar 3, 2021
View reviewed changes
Copy link

@rkratky rkratky left a comment

Choose a reason for hiding this comment

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

A couple of nitpicks.

@jc-berger jc-berger changed the title WIP: modified docs to adhere to schema WIP: modified docs to adhere to schema_1st PR Mar 3, 2021
maysunfaisal
maysunfaisal requested changes Mar 4, 2021
View reviewed changes
Copy link
Member

@maysunfaisal maysunfaisal left a comment

Choose a reason for hiding this comment

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

I've gone thru each of the docs and made some comments as per the original issue.

For reference, we should confirm the yaml snippets and/or properties against the devfile v2 schema which can be found at https://docs.devfile.io/devfile/2.0.0/user-guide/api-reference.html

@jc-berger
Copy link
Contributor Author

jc-berger commented Mar 11, 2021 •
edited
Loading

Thanks, @maysunfaisal, for the new content. I've set up a new commit. @elsony, would you be able to take a look at the docs, adding kubernetes component to a devfile and adding plugin component to a devfile? Looking at the schema, these docs received larger changes than the other. We'd like a second opinion on the relevancy of the revised versions, thanks!

@jc-berger jc-berger mentioned this pull request Mar 12, 2021
Closed
maysunfaisal
maysunfaisal requested changes Mar 15, 2021
View reviewed changes
@maysunfaisal maysunfaisal mentioned this pull request Mar 15, 2021
Merged
@jc-berger
Copy link
Contributor Author

Thanks, @maysunfaisal, for the awesome review on this PR and the other related ones. I've made a new commit for this PR more content and yaml changes and will address your review for the other PRs tomorrow. Many thanks!

maysunfaisal
maysunfaisal reviewed Mar 19, 2021
View reviewed changes
Copy link
Member

@maysunfaisal maysunfaisal left a comment

Choose a reason for hiding this comment

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

2 changes and we should be good to merge this

maysunfaisal
maysunfaisal approved these changes Mar 22, 2021
View reviewed changes
Copy link
Member

@maysunfaisal maysunfaisal left a comment

Choose a reason for hiding this comment

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

lgtm

rolfedh
rolfedh reviewed Mar 22, 2021
View reviewed changes
rolfedh
rolfedh reviewed Mar 22, 2021
View reviewed changes
@openshift-ci-robot
Copy link

New changes are detected. LGTM label has been removed.

@jc-berger
Copy link
Contributor Author

New commit is up, if the doc review looks good, please give it the LGTM label.

kowen-rh
kowen-rh reviewed Mar 24, 2021
View reviewed changes
kowen-rh
kowen-rh reviewed Mar 24, 2021
View reviewed changes
@jc-berger
Copy link
Contributor Author

@robin-owen, thanks for the review, especially for help identifying what can be deferred for the moment. I kept those conversations unresolved so I can make note, then I'll resolve them. I also responded to your comments to help with your second look at what I addressed. Thanks!

@openshift-ci-robot
Copy link

@robin-owen: changing LGTM is restricted to collaborators

In response to this:

LGTM. 👍

Thanks, @jc-berger!

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

kowen-rh
kowen-rh approved these changes Mar 24, 2021
View reviewed changes
Copy link
Contributor

@kowen-rh kowen-rh left a comment

Choose a reason for hiding this comment

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

LGTM. 👍

Thanks, @jc-berger!

@openshift-ci-robot
Copy link

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: jc-berger, maysunfaisal, robin-owen

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@jc-berger jc-berger mentioned this pull request Mar 25, 2021
Merged
@jc-berger
modified docs to adhere to schema
dbab2e0 
more content changes to align with schema

more source.yaml changes to align with schema

more changes to yamls

tweaks to yamls. more changes to come

major change to adding kubernetes doc. changed yaml for event bindings doc

more content and yaml changes

minor tweaks and adjusted tab spacing in yaml

addressed doc review comments

more language review

fixed capitalization error
@jc-berger jc-berger changed the title WIP: modified docs to adhere to schema_1st PR Modified docs to adhere to schema_1st PR Mar 25, 2021
rkratky
rkratky reviewed Mar 30, 2021
View reviewed changes
@rkratky rkratky merged commit 3bbf559 into devfile:master Apr 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@themr0c themr0c themr0c left review comments

@rolfedh rolfedh rolfedh left review comments

@rkratky rkratky rkratky left review comments

@yangcao77 yangcao77 yangcao77 left review comments

@maysunfaisal maysunfaisal maysunfaisal approved these changes

@kowen-rh kowen-rh kowen-rh approved these changes

Assignees

@maysunfaisal maysunfaisal

@jc-berger jc-berger

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Inconsistent devfile docs wrt schema 2.x.x Errors in devfile 2.0.0 documentation Git attributes tag, commitId, and branch
8 participants
@jc-berger @openshift-ci-robot @themr0c @rolfedh @rkratky @yangcao77 @maysunfaisal @kowen-rh