included odo yaml samples in devfile authoring docs #53
Conversation
jc-berger
changed the title
|
@robin-owen: 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. |
There was a problem hiding this comment.
/lgtm
The changes themselves look good. Having said that, I don't think it fully addresses devfile/api#312. I think the goal is eventually having something similar to the table from the odo doc which is more concise and easier to digest on a high level as a quick reference. What we have on the author's guide is more detailed and will have difficulty fitting into a table. Maybe we'll link off from that quick reference to the author's guide if we find there is extra info useful to the user on the author's guide.
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: elsony, jc-berger, 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 |
5 participants
Fixes #312
See the similar PR #42 for previous discussion on this work.
I looked at the devfile properties content on the odo page. I then streamlined its devfile code samples into our authoring stacks docs. Thus far, I've only done a handful of the docs to ensure this is what we want as we aim to utilize devfile specific content from odo.
I know we discussed our devfile docs having a similar layout to the odo docs. I looked at the markdown file of the odo page, and it seems that odo gets its tables and split screen layout by having one huge doc. Unlike our authoring stacks which are multiple docs. Something to think about as we continue the work on our layout.