created file adding volume component and details of openshift component #132
Conversation
… of adding kubernetes component
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: jc-berger 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 |
|
🎊 PR Preview has been successfully built and deployed to https://devfile-docs-preview-pr-132.surge.sh 🎊 |
| = Adding `volume` components to a devfile | ||
|
|
||
| [role="_abstract"] | ||
| Use volume components in order to share files among container components, making it easier to collaborate with other teams during the development process. |
There was a problem hiding this comment.
I wanted to give a why they'd care about sharing files across container components. What do y'all think of this why I care statement at the end of this abstract?
There was a problem hiding this comment.
This is very good information to provide. It speaks directly to the user story.
| + | ||
| .A minimal `volume` component | ||
| [source,yaml] | ||
| ---- |
There was a problem hiding this comment.
Specifically for devs, please verify the accuracy and correctness of this source yaml :)
docs/modules/user-guide/pages/adding-kubernetes--or-openshift-component-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
.../modules/user-guide/partials/proc_adding-kubernetes-or-openshift-component-to-a-devfile.adoc
Outdated
Show resolved
Hide resolved
docs/modules/user-guide/partials/proc_adding-volume-components.adoc
Outdated
Show resolved
Hide resolved
docs/modules/user-guide/partials/proc_adding-volume-components.adoc
Outdated
Show resolved
Hide resolved
|
|
||
| * Define a component using the type `volume`. | ||
| + | ||
| .A minimal `volume` component |
There was a problem hiding this comment.
Is this example the user's primary source of information about volume components? If so, you might want to cover any volume-related attributes in this example or topic, for example, by using callouts. Otherwise, consider providing a cross-reference to the reference topic where this information is available.
There was a problem hiding this comment.
Okay to use monospaced fonts in headings?
There was a problem hiding this comment.
Dev review: do you have suggestion to add to to this yaml sample to address Rolfe's points above?
| = Adding a volume component to a devfile | ||
|
|
||
| [role="_abstract"] | ||
| You can use a volume component in order to share files among container components, making it easier to collaborate with other teams during the development process. |
There was a problem hiding this comment.
IBM SG: For In order to, "Use "to" in most cases to avoid wordiness."
There was a problem hiding this comment.
Hi, @jake Berger. I was revisiting this PR and realized I missed something important during my peer review. The content talks about adding a component to a devfile, but omits the effect of this action in OpenShift, and then describes the benefit. I'd recommend something more like:
| You can use a volume component in order to share files among container components, making it easier to collaborate with other teams during the development process. | |
| To create a <name the type of volume> in your shared <location of volume>, you can add a volume component to your devfile. This <type of volume> makes it easier for teams to share files and collaborate with each other during the development process. |
WDYT?
There was a problem hiding this comment.
A similar approach might also apply to docs/modules/user-guide/partials/proc_adding-a-kubernetes-or-openshift-component-to-a-devfile.adoc
There was a problem hiding this comment.
Devs, I think Rolfe's suggestion is good, but I honestly wouldn't be able to say what type of component it is. Could any of you give an idea to expand our abstract more?
docs/modules/user-guide/partials/proc_adding-a-volume-component-to-a-devfile.adoc
Show resolved
Hide resolved
There was a problem hiding this comment.
Hi @jc-berger: Nice work! I have left some suggestions. PTAL. Thanks!
...odules/user-guide/partials/proc_adding-a-kubernetes-or-openshift-component-to-a-devfile.adoc
Show resolved
Hide resolved
docs/modules/user-guide/partials/proc_adding-a-container-component-to-a-devfile.adoc
Show resolved
Hide resolved
...odules/user-guide/partials/proc_adding-a-kubernetes-or-openshift-component-to-a-devfile.adoc
Outdated
Show resolved
Hide resolved
docs/modules/user-guide/partials/proc_adding-a-volume-component-to-a-devfile.adoc
Outdated
Show resolved
Hide resolved
docs/modules/user-guide/partials/proc_adding-a-volume-component-to-a-devfile.adoc
Show resolved
Hide resolved
docs/modules/user-guide/partials/proc_adding-a-volume-component-to-a-devfile.adoc
Outdated
Show resolved
Hide resolved
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
Show resolved
Hide resolved
|
@Srivaralakshmi: 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. |
|
|
||
| [role="_abstract"] | ||
| This section describes how to add either a `kubernetes` or `openshfit` component to a devfile. You can apply configurations to your devfile with `kubernetes` or `openshift` components. | ||
| You can add either a `kubernetes` or `openshfit` component to a devfile. Doing so enables you to configure your devfile to your unique development needs. |
| . Provide the content through the `uri` or `inlined` property. | ||
| + | ||
| .Adding `openshift` component using the `uri` property | ||
| .Adding a `openshift` component using the `uri` property |
| . For each component, define an unique value for the mandatory `name` attribute. | ||
|
|
||
| . For each component, define a mandatory type of one of the following types: `kubernetes`, `container` or `volume`. | ||
| . For each component, define a mandatory type of one of the following types: `kubernetes`, `container`, or `volume`. |
There was a problem hiding this comment.
we should include openshift as one of the components in this list
|
closing this PR and continuing the work and conversation in this similar, but updated, PR: #135 |
4 participants
Fixes devfile/api#260