Skip to content

include multi-stack version setup in registry guide #154

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

Merged
merged 3 commits into from
May 4, 2022

Conversation

yangcao77
Copy link
Contributor

Signed-off-by: Stephanie [email protected]

For issue devfile/api#810

update the registry guide to include setup for multiple stack versions in a registry.
(The design doc is https://docs.google.com/document/d/1_eXbAV1eKetKKu_FHGRw6kUUiUhcp7j1gB0uUrG0WF8/edit?usp=sharing)

added pages for adding a stack.yaml file, for creating a stack. updated existing index schema page.

@github-actions
Copy link

github-actions bot commented May 2, 2022

Click here to review and test in web IDE: Contribute

@github-actions
Copy link

github-actions bot commented May 2, 2022

⚡️ Deploying PR Preview...

@yangcao77 yangcao77 requested review from HarshCasper and jc-berger May 2, 2022 20:03
| The stack version.
| `versions`
| `version[]`
| The information of each stack/sample version.
Copy link
Contributor

Choose a reason for hiding this comment

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

IBM SG doesn't want us to use / Simply say, The information of each stack or sample version.


| `type`
| `DevfileType`
| The type of a devfile that currently supports stacks and samples.
| The type: stack/sample.
Copy link
Contributor

Choose a reason for hiding this comment

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

To be consisted with all the other phrasing, I would remove the colon.

Does it make just as much sense to say, The type of a stack or sample.

= Creating a Devfile stack

[role="_abstract"]
Create a devfile stack to package into the devfile registry.
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we include a value or purpose behind creating a devfile stack to package into the registry?

Like, Create a devfile stack to package into the devfile registry so you can <state value.>

Would this work?:

Create a devfile stack to package into the devfile registry so you can quickly access, share, and duplicate your different stacks for your various projects.


.Procedure

. Create a stack folder with a name matches the stack name, for example, `java-wildfly/`.
Copy link
Contributor

@jc-berger jc-berger May 4, 2022

Choose a reason for hiding this comment

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

Create a stack folder with a name that matches the stack name, for example, java-wildfly/.

Copy link
Contributor

@jc-berger jc-berger May 4, 2022

Choose a reason for hiding this comment

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

I think it reads better with the that included.

Copy link
Contributor

@jc-berger jc-berger left a comment

Choose a reason for hiding this comment

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

/lgtm

@openshift-ci
Copy link

openshift-ci bot commented May 4, 2022

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: jc-berger, yangcao77

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

@yangcao77
Copy link
Contributor Author

The errors from CI are for docs whose content were not updated. The error from the new added doc is suggesting to change yaml to YAML, which does not make sense in the content. e.g. stack.yaml
Merging as a result.

@yangcao77 yangcao77 merged commit 9a1ac08 into devfile:master May 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants