Add quick start guides for new adopters #87

michael-valdron · 2023-04-19T02:16:00Z

What does this PR do / why we need it

Create quick start guides for writing devfiles using odo v3 and Eclipse Che. This is to give the new adopter a practical exercise for learning how to write a simple devfile.

Additional changes

A recent update to the hotReloadCapable attribute description in the spec has updated the comments in the spec models

Which issue(s) does this PR fix

Fixes #?

fixes devfile/api#1057

PR acceptance criteria

Unit Tests
E2E Tests
Documentation
Update the sidebar if there is a new file added or an existing filename is changed

How to test changes / Special notes to the reviewer

nx-cloud · 2023-04-19T02:16:03Z

☁️ Nx Cloud Report

Attention: This version of the Nx Cloud GitHub bot will cease to function on July 1st, 2023. An organization admin can update your integration here.

CI is running/has finished running commands for commit e52a584. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch

✅ Successfully ran 5 targets

Sent with 💌 from NxCloud.

libs/docs/src/navigation/2.2.0-alpha.yaml

maysunfaisal · 2023-05-02T14:10:49Z

Might be a good idea to provide link to Sandbox and also instructions to Che setup

libs/docs/src/docs/2.1.0/helloworld-example-che.md

libs/docs/src/docs/no-version/helloworld-example-odo.md

libs/docs/src/navigation/2.1.0.yaml

michael-valdron · 2023-05-03T20:36:06Z

Waiting on reviews from members of odo and Eclipse Che teams.

libs/docs/src/docs/no-version/quickstart-odo.md

kadel · 2023-05-04T07:46:02Z

libs/docs/src/docs/no-version/quickstart-odo.md

+4. Create a devfile with the filename `.devfile.yaml`. Add the [`schemaVersion`](./devfile-schema#schema-version) field with the desired devfile specification version to use
+
+    ```yaml {% filename=".devfile.yaml" %}
+    schemaVersion: <version>


if we are showing snippets of the devfile content, it might be better to make it easier for users and include the actually version

if we are showing snippets of the devfile content, it might be better to make it easier for users and include the actually version

It will include the actual schema version, <version> is a placeholder for printing the selected schema version dynamically in that spot. So if you load the site under the 2.2.0 doc pages, <version> will be replaced by 2.2.0.

oh, did not know that. That is really smart 👍

libs/docs/src/docs/no-version/quickstart-odo.md

amisevsk

In general, the Eclipse Che portion is somewhat out of date with current/upcoming releases. I'll share this PR with the team for more detailed review.

libs/docs/src/docs/2.1.0/quickstart-che.md

amisevsk · 2023-05-08T17:05:17Z

libs/docs/src/docs/2.1.0/quickstart-che.md

+5. Go to 'Edit the workspace' and view the devfile. The devfile should be populated with content similar to the following
+    - The `schemaVersion` of the devfile should be left to what Eclipse Che supports, currently `2.1.0`
+    - The `metadata.namespace` field is the target namespace your project will be deployed in, for our current intent and purposes this can be left alone


This step will not work in Eclipse Che -- eclipse-che/che#22115. I believe the plan going forward is to allow editing the devfile from within the workspace itself (using the Code editor, for example) but I'm not 100% sure of the status of this feature.

Also, to add, Che currently uses devfile 2.2.0 schema -- the display in the edit page is a bug.

This step will not work in Eclipse Che -- eclipse/che#22115. I believe the plan going forward is to allow editing the devfile from within the workspace itself (using the Code editor, for example) but I'm not 100% sure of the status of this feature.

Also, to add, Che currently uses devfile 2.2.0 schema -- the display in the edit page is a bug.

Thanks for your review @amisevsk!

Seems like the version of Eclipse Che under Red Hat Dev Spaces is an older version that is still on devfile spec 2.1.0, I will need to write up revised draft for the current 2.1.0 guide as well as a new guide under 2.2.0 to cover the up to date content: devfile/api#1057 (comment)

Seems like the version of Eclipse Che under Red Hat Dev Spaces is an older version that is still on devfile spec 2.1.0, I will need to write up revised draft for the current 2.1.0 guide as well as a new guide under 2.2.0 to cover the up to date content: devfile/api#1057 (comment)

Update: devfile/api#1057 (comment)

Update: devfile/api#1057 (comment)

@amisevsk I need a review of the recent changes when you are able to, thank you.

Signed-off-by: Michael Valdron <[email protected]>

libs/docs/src/docs/2.2.0/quickstart-che.md

libs/docs/src/docs/2.1.0/quickstart-sandbox.md

l0rd

@michael-valdron the Devfile with Eclipse Che getting started article is really nice 👏

container component revisions: * rename 'runtime' to 'dev-tooling' * change image tag 'ubi8-latest' to 'latest' Co-authored-by: Mario Loriedo <[email protected]> Signed-off-by: Michael Valdron <[email protected]>

expand description of `universal-developer-image` to add more context to why Eclipse Che uses it Co-authored-by: Mario Loriedo <[email protected]> Signed-off-by: Michael Valdron <[email protected]>

reword opening to defining commands in Eclipse Che to improve clarity of why it is done Co-authored-by: Mario Loriedo <[email protected]> Signed-off-by: Michael Valdron <[email protected]>

revise 'id' description to not refer to it as a 'label' to avoid confusion with the 'label' field Co-authored-by: Mario Loriedo <[email protected]> Signed-off-by: Michael Valdron <[email protected]>

remove incorrect note about execution order of commands, Eclipse Che executes commands individually with the user manually triggering them Co-authored-by: Mario Loriedo <[email protected]> Signed-off-by: Michael Valdron <[email protected]>

Signed-off-by: Michael Valdron <[email protected]>

…it replaced with a guide from the Eclipse Che documentation for getting started with 'Eclipse Che hosted by Red Hat' Signed-off-by: Michael Valdron <[email protected]>

Signed-off-by: Michael Valdron <[email protected]>

l0rd

👏 LGTM

…the new developer persona. Signed-off-by: Michael Valdron <[email protected]>

openshift-ci · 2023-05-26T18:20:36Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: kadel, l0rd, michael-valdron, mike-hoang

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [mike-hoang]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

openshift-ci bot added the do-not-merge/work-in-progress label Apr 19, 2023

michael-valdron mentioned this pull request Apr 19, 2023

Add concrete "hello world" example to App Developer getting started guide devfile/api#1057

Closed

michael-valdron force-pushed the helloworld-example-doc branch 2 times, most recently from 1a4628e to 49a821f Compare April 27, 2023 21:01

michael-valdron changed the title ~~[WIP]Add hello world example guide for new adopters~~ Add hello world example guide for new adopters Apr 27, 2023

michael-valdron marked this pull request as ready for review April 27, 2023 21:02

openshift-ci bot removed the do-not-merge/work-in-progress label Apr 27, 2023

openshift-ci bot requested review from elsony and maysunfaisal April 27, 2023 21:02

michael-valdron requested a review from mike-hoang April 27, 2023 21:02

kim-tsao reviewed May 2, 2023

View reviewed changes

libs/docs/src/navigation/2.2.0-alpha.yaml Outdated Show resolved Hide resolved

mike-hoang reviewed May 2, 2023

View reviewed changes

michael-valdron force-pushed the helloworld-example-doc branch from 0a41523 to 0c38652 Compare May 2, 2023 15:40

michael-valdron changed the title ~~Add hello world example guide for new adopters~~ Add quick start guides for new adopters May 3, 2023

michael-valdron requested a review from mike-hoang May 3, 2023 20:34

mike-hoang approved these changes May 3, 2023

View reviewed changes

openshift-ci bot assigned mike-hoang May 3, 2023

openshift-ci bot added lgtm approved labels May 3, 2023

kadel reviewed May 4, 2023

View reviewed changes

libs/docs/src/docs/no-version/quickstart-odo.md Outdated Show resolved Hide resolved

kadel reviewed May 4, 2023

View reviewed changes

libs/docs/src/docs/no-version/quickstart-odo.md Outdated Show resolved Hide resolved

kadel reviewed May 4, 2023

View reviewed changes

libs/docs/src/docs/no-version/quickstart-odo.md Outdated Show resolved Hide resolved

kadel reviewed May 4, 2023

View reviewed changes

libs/docs/src/docs/no-version/quickstart-odo.md Outdated Show resolved Hide resolved

openshift-ci bot removed the lgtm label May 4, 2023

michael-valdron requested a review from kadel May 4, 2023 20:11

amisevsk reviewed May 8, 2023

View reviewed changes

rewrite for using a local devfile within Eclipse Che

cf7efdc

Signed-off-by: Michael Valdron <[email protected]>

michael-valdron changed the title ~~[WIP]Add quick start guides for new adopters~~ Add quick start guides for new adopters May 16, 2023

michael-valdron marked this pull request as ready for review May 16, 2023 06:39

openshift-ci bot removed the do-not-merge/work-in-progress label May 16, 2023

openshift-ci bot requested a review from johnmcollier May 16, 2023 06:39

michael-valdron requested a review from amisevsk May 16, 2023 06:39

l0rd requested changes May 23, 2023

View reviewed changes

openshift-ci bot assigned l0rd May 23, 2023

l0rd reviewed May 23, 2023

View reviewed changes

michael-valdron and others added 4 commits May 24, 2023 15:30

Update libs/docs/src/docs/2.2.0/quickstart-che.md

1b66511

container component revisions: * rename 'runtime' to 'dev-tooling' * change image tag 'ubi8-latest' to 'latest' Co-authored-by: Mario Loriedo <[email protected]> Signed-off-by: Michael Valdron <[email protected]>

Update libs/docs/src/docs/2.2.0/quickstart-che.md

e72797a

expand description of `universal-developer-image` to add more context to why Eclipse Che uses it Co-authored-by: Mario Loriedo <[email protected]> Signed-off-by: Michael Valdron <[email protected]>

Update libs/docs/src/docs/2.2.0/quickstart-che.md

b29a2a5

reword opening to defining commands in Eclipse Che to improve clarity of why it is done Co-authored-by: Mario Loriedo <[email protected]> Signed-off-by: Michael Valdron <[email protected]>

Update libs/docs/src/docs/2.2.0/quickstart-che.md

56389c9

revise 'id' description to not refer to it as a 'label' to avoid confusion with the 'label' field Co-authored-by: Mario Loriedo <[email protected]> Signed-off-by: Michael Valdron <[email protected]>

michael-valdron force-pushed the helloworld-example-doc branch from 8dea25a to 1e6a67f Compare May 24, 2023 19:33

michael-valdron and others added 4 commits May 24, 2023 15:55

reword the item instructing schema version use for Eclipse Che

289d950

Signed-off-by: Michael Valdron <[email protected]>

removes quick start guide for OpenShift Dev Spaces and references of …

f9713cc

…it replaced with a guide from the Eclipse Che documentation for getting started with 'Eclipse Che hosted by Red Hat' Signed-off-by: Michael Valdron <[email protected]>

add Quick start with Eclipse Che guide under all versions.

f526fdd

Signed-off-by: Michael Valdron <[email protected]>

michael-valdron force-pushed the helloworld-example-doc branch from 93d43b2 to f526fdd Compare May 24, 2023 19:57

michael-valdron requested a review from l0rd May 24, 2023 20:00

l0rd approved these changes May 24, 2023

View reviewed changes

openshift-ci bot added the lgtm label May 24, 2023

l0rd reviewed May 24, 2023

View reviewed changes

references to the quick start guides added to other pages related to …

e52a584

…the new developer persona. Signed-off-by: Michael Valdron <[email protected]>

openshift-ci bot removed the lgtm label May 26, 2023

michael-valdron requested a review from mike-hoang May 26, 2023 18:18

mike-hoang approved these changes May 26, 2023

View reviewed changes

openshift-ci bot added the lgtm label May 26, 2023

michael-valdron merged commit ca17714 into devfile:main May 26, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add quick start guides for new adopters #87

Add quick start guides for new adopters #87

michael-valdron commented Apr 19, 2023 •

edited

Loading

nx-cloud bot commented Apr 19, 2023 •

edited

Loading

maysunfaisal commented May 2, 2023

michael-valdron commented May 3, 2023

kadel May 4, 2023

michael-valdron May 4, 2023

kadel May 10, 2023

amisevsk left a comment

amisevsk May 8, 2023

michael-valdron May 8, 2023

michael-valdron May 10, 2023

michael-valdron May 16, 2023

l0rd left a comment

l0rd left a comment

openshift-ci bot commented May 26, 2023

Add quick start guides for new adopters #87

Add quick start guides for new adopters #87

Conversation

michael-valdron commented Apr 19, 2023 • edited Loading

What does this PR do / why we need it

Which issue(s) does this PR fix

PR acceptance criteria

How to test changes / Special notes to the reviewer

nx-cloud bot commented Apr 19, 2023 • edited Loading

☁️ Nx Cloud Report

maysunfaisal commented May 2, 2023

michael-valdron commented May 3, 2023

kadel May 4, 2023

Choose a reason for hiding this comment

michael-valdron May 4, 2023

Choose a reason for hiding this comment

kadel May 10, 2023

Choose a reason for hiding this comment

amisevsk left a comment

Choose a reason for hiding this comment

amisevsk May 8, 2023

Choose a reason for hiding this comment

michael-valdron May 8, 2023

Choose a reason for hiding this comment

michael-valdron May 10, 2023

Choose a reason for hiding this comment

michael-valdron May 16, 2023

Choose a reason for hiding this comment

l0rd left a comment

Choose a reason for hiding this comment

l0rd left a comment

Choose a reason for hiding this comment

openshift-ci bot commented May 26, 2023

michael-valdron commented Apr 19, 2023 •

edited

Loading

nx-cloud bot commented Apr 19, 2023 •

edited

Loading