added devfile component changes #147
Conversation
|
🎊 Navigate the preview: https://devfile-docs-147.surge.sh 🎊 |
|
Click here to review and test in web IDE: |
There was a problem hiding this comment.
This PR fixes the problems reported in devfile/api#758 (comment) but I think we should consider reorganizing the tables. For example, we have tables for the container and volume components but we're missing a table for the Kubernetes/Openshift component. Rather than have the tables listed in one page, maybe we can move them to their respective topics?
i.e. Container attributes and all its sub-attributes listed under Adding a container component to a devfile, Kubernetes/Openshift attributes listed under Adding a Kubernetes or OpenShift component to a devfile, etc
Keep in mind, some attributes are common across multiple components such as the endpoint object so we can have the table on one page and have a URL link so it can be referred to from other pages.
Let me know if I should open up another issue since this may be a lot of work.
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-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-components-to-a-devfile.adoc
Outdated
Show resolved
Hide resolved
…evfile.adoc Co-authored-by: Brian Burt <[email protected]>
…evfile.adoc Co-authored-by: Brian Burt <[email protected]>
…evfile.adoc Co-authored-by: Brian Burt <[email protected]>
…evfile.adoc Co-authored-by: Brian Burt <[email protected]>
…evfile.adoc Co-authored-by: Brian Burt <[email protected]>
|
@kim-tsao good idea. Think we can merge this PR, open a new issue, then do the heavier work for that issue? Don't want this PR to take too long, especially since we're currently transitioning writers. |
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-components-to-a-devfile.adoc
Outdated
Show resolved
Hide resolved
…evfile.adoc Co-authored-by: Rolfe Dlugy-Hegwer <[email protected]>
docs/modules/user-guide/partials/proc_adding-components-to-a-devfile.adoc
Show resolved
Hide resolved
|
@max-cx: changing LGTM is restricted to collaborators In response to this:
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. |
|
@rkratky ready for your review, thanks |
There was a problem hiding this comment.
Hi @jc-berger. It looks like you might have missed this "whether or not" issue: #147 (comment)
|
@rolfedh: changing LGTM is restricted to collaborators In response to this:
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. |
|
@rolfedh I think I committed your suggestion, do you see otherwise? I see in the commit history it's been changed, and I confirmed locally. See the attached screenshots
|
Sorry. I must have been looking at outdated information. Approved. |
|
@rolfedh: changing LGTM is restricted to collaborators In response to this: 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. |
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: jc-berger, kim-tsao, max-cx, rkratky, rolfedh 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: devfile/api#758
Direct link to preview: https://devfile-docs-147.surge.sh/devfile/2.2.0/user-guide/adding-components-to-a-devfile/
Added the necessary additions to the tables for devfile components. Please let me know what you think!