-
Notifications
You must be signed in to change notification settings - Fork 32
included odo lists throughout authoring stack docs #78
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
included odo lists throughout authoring stack docs #78
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this PR supposed to be the complete changes for the migration from odo doc? I ask that since this PR doesn't seem to capture all info from the existing odo doc. Take the event for example: https://odo.dev/file-reference/#prestartobject. It has a detailed description for each of the event objects and we don't have that in here.
docs/modules/user-guide/partials/proc_adding-schema-version-to-a-devfile.adoc
Outdated
Show resolved
Hide resolved
docs/modules/user-guide/partials/proc_adding-a-name-to-a-devfile.adoc
Outdated
Show resolved
Hide resolved
Adding @kadel to the review list since this is supposed to be a replacement for part of the odo doc. |
docs/modules/user-guide/partials/proc_adding-commands-to-a-devfile.adoc
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is good start. Basic structure makes sense.
We will have to improve field description to make it more useful, but that can be done separately and primarily in schema itself
docs/modules/user-guide/partials/proc_adding-components-to-a-devfile.adoc
Show resolved
Hide resolved
docs/modules/user-guide/partials/proc_adding-components-to-a-devfile.adoc
Outdated
Show resolved
Hide resolved
docs/modules/user-guide/partials/proc_adding-components-to-a-devfile.adoc
Outdated
Show resolved
Hide resolved
docs/modules/user-guide/partials/proc_adding-event-bindings.adoc
Outdated
Show resolved
Hide resolved
docs/modules/user-guide/partials/proc_adding-projects-to-a-devfile.adoc
Outdated
Show resolved
Hide resolved
docs/modules/user-guide/partials/proc_adding-projects-to-a-devfile.adoc
Outdated
Show resolved
Hide resolved
docs/modules/user-guide/partials/proc_adding-projects-to-a-devfile.adoc
Outdated
Show resolved
Hide resolved
docs/modules/user-guide/partials/proc_adding-projects-to-a-devfile.adoc
Outdated
Show resolved
Hide resolved
Thanks @elsony for the feedback. I'll make a new commit, addressing these changes, tomorrow! |
I've left some comments open to direct the final dev review. If the dev review thinks it looks good to merge, please go ahead and do so, thanks! |
docs/modules/user-guide/partials/proc_adding-components-to-a-devfile.adoc
Outdated
Show resolved
Hide resolved
docs/modules/user-guide/partials/proc_adding-projects-to-a-devfile.adoc
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We are getting very close. Just a couple of minor changes.
docs/modules/user-guide/partials/proc_adding-projects-to-a-devfile.adoc
Outdated
Show resolved
Hide resolved
docs/modules/user-guide/partials/proc_adding-projects-to-a-devfile.adoc
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/lgtm
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: elsony, jc-berger, kadel 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 |
Fixes #312.
As a reference, I'm taking content the tables from odo tables and including them throughout the authoring stacks docs.
See the conversation in PR #69 where we thought that including the odo tables throughout the authoring stacks might be better than creating an entirely new doc.