i12974 - two new docs:... #737

nickboldt · 2019-06-21T18:14:09Z

i12974 - two new docs: creating-starting-workspaces.html (workspace from sample) and ide-projects.html (workspace from code import)

Change-Id: I183a9752e9b6dc7b3496fa5595eef4646759c663
Signed-off-by: nickboldt [email protected]

nickboldt · 2019-06-21T22:00:46Z

Ready for review @rkratky @l0rd @slemeur

nickboldt · 2019-06-25T16:03:05Z

Two problems:

a) the screenshots should be redone once we remove the che 6 stacks that shouldn't be listed (I'll do this next, now that Che 7 nightly has fixed this): FIXED, but a few will need to be redone again once eclipse-che/che#13665 is done

b) there's no mention of the command palette for running git clone from the menus (vs. from the commandline in the ws/dev terminal): FIXED.

rkratky · 2019-06-26T08:16:08Z

Thanks for the PR, @nickboldt. I'll review the content when you say it's ready. One nitpick for future reference: When possible, please, use the already prepared template files. In this case, those were:

(The entire doc outline, as seen at https://github.com/eclipse/che-docs/issues/712, is already in the repo.)

Two reasons, mainly:

We like to use file names and anchor IDs that are consistent with topic titles to make navigation in the source code easier.
The structure of the outline has been acked by Mario, so we want to stick to it, unless there's a compelling reason to change it. And if there is, the prepopulated files should be removed in favor of the new ones, and the #712 issue updated.

l0rd

This is a really good article. Well written and easy to read. Some parts of it reference legacy stacks (based on stacks.json) that are deprecated since RC 2 and should be updated.

src/main/pages/che-7/hands-on-guidance/proc_creating-a-workspace-from-code-sample.adoc

src/main/pages/che-7/overview/assembly_creating-starting-workspaces.adoc

...-7/hands-on-guidance/proc_creating-a-workspace-by-importing-source-code-of-your-project.adoc

src/main/pages/che-7/overview/assembly_ide-projects.adoc

nickboldt · 2019-07-02T16:49:43Z

Current status:

One remaining comment for @l0rd to approve/reject
some content blocked by Update projects widget in Create New Workspace Panel che#13665 (look for TODO markers in the source)
otherwise good enough to review & merge IMHO.

src/main/pages/che-7/hands-on-guidance/proc_configuring-a-che-workspace-using-a-devfile.adoc

...-7/hands-on-guidance/proc_creating-a-workspace-by-importing-source-code-of-your-project.adoc

src/main/pages/che-7/hands-on-guidance/proc_configuring-a-che-workspace-using-a-devfile.adoc

...-7/hands-on-guidance/proc_creating-a-workspace-by-importing-source-code-of-your-project.adoc

src/main/pages/che-7/hands-on-guidance/proc_creating-a-workspace-from-code-sample.adoc

supriya-bharadwaj · 2019-07-05T16:08:14Z

Hi, @nickboldt . I have reviewed the content and made some suggestions. I think I have reviewed it all, but in case I haven't, I'll review the rest of it tomorrow. Thanks! :)

src/main/pages/che-7/hands-on-guidance/proc_creating-a-workspace-from-code-sample.adoc

...-7/hands-on-guidance/proc_creating-a-workspace-by-importing-source-code-of-your-project.adoc

src/main/pages/che-7/hands-on-guidance/proc_configuring-a-che-workspace-using-a-devfile.adoc

src/main/pages/che-7/hands-on-guidance/proc_creating-a-workspace-from-code-sample.adoc

nickboldt · 2019-07-12T19:14:02Z

I hope I've applied fixes for all the suggestions from Robert and Supriya. Ready for the next review.

New files changed since the last version of this PR:

src/main/pages/che-7/overview/proc_running-che-locally.adoc - fixed links under the Next steps after deploying and starting Che section
src/main/pages/che-7/end-user-guide/proc_developing-che-theia-plug-ins-using-che.adoc - since you've decided that User Dashboard should be replaced with just Dashboard, I've also replaced "Che Dashboard" -> Dashboard
src/main/pages/che-7/overview/assembly_che-quick-starts.adoc - "Che Dashboard" -> Dashboard
src/main/pages/che-7/end-user-guide/con_che-theia-plug-in-concept-in-detail.adoc - "Che Dashboard" -> Dashboard

Legacy stacks are no longer referenced in screenshots or text.

src/main/pages/che-7/hands-on-guidance/proc_configuring-a-che-workspace-using-a-devfile.adoc

supriya-bharadwaj · 2019-07-08T11:08:07Z

src/main/pages/che-7/hands-on-guidance/proc_configuring-a-che-workspace-using-a-devfile.adoc

+
+==== Creating a workspace from a devfile
+
+. Commit a `devfile.yaml` into the root of your git repo.


src/main/pages/che-7/hands-on-guidance/proc_configuring-a-che-workspace-using-a-devfile.adoc

...-7/hands-on-guidance/proc_creating-a-workspace-by-importing-source-code-of-your-project.adoc

src/main/pages/che-7/hands-on-guidance/proc_creating-a-workspace-from-code-sample.adoc

…rom sample) and ide-projects.html (workspace from code import) Change-Id: I183a9752e9b6dc7b3496fa5595eef4646759c663 Signed-off-by: nickboldt <[email protected]> move files into correct path; add missing section re: command palette for git clone Change-Id: I1b0dd74a32acbb30f05dd67cc85bc6a3a8d78a99 Signed-off-by: nickboldt <[email protected]> apply fixes to copy remove dupe files replace/remove images Change-Id: I10632cbb7b1a1d7ec8d96b469f50073934046e3c Signed-off-by: nickboldt <[email protected]> add TODOs for after eclipse-che/che#13665 is done; tweak copy Change-Id: I4209eecf2a6e5ef33f7901571792ab35e0611186 Signed-off-by: nickboldt <[email protected]> more tweaks to copy Change-Id: I33bf5d21b3a6a0bffc9a1d6929b83720d5d99ae8 Signed-off-by: nickboldt <[email protected]> Update src/main/pages/che-7/hands-on-guidance/proc_creating-a-workspace-by-importing-source-code-of-your-project.adoc Co-Authored-By: supriya <[email protected]> Update src/main/pages/che-7/hands-on-guidance/proc_creating-a-workspace-by-importing-source-code-of-your-project.adoc Co-Authored-By: supriya <[email protected]> Update src/main/pages/che-7/hands-on-guidance/proc_creating-a-workspace-by-importing-source-code-of-your-project.adoc Co-Authored-By: supriya <[email protected]> Update src/main/pages/che-7/hands-on-guidance/proc_creating-a-workspace-by-importing-source-code-of-your-project.adoc Co-Authored-By: supriya <[email protected]> Update src/main/pages/che-7/hands-on-guidance/proc_creating-a-workspace-by-importing-source-code-of-your-project.adoc Co-Authored-By: supriya <[email protected]> Update src/main/pages/che-7/hands-on-guidance/proc_creating-a-workspace-by-importing-source-code-of-your-project.adoc Co-Authored-By: supriya <[email protected]> Update src/main/pages/che-7/hands-on-guidance/proc_creating-a-workspace-by-importing-source-code-of-your-project.adoc Co-Authored-By: supriya <[email protected]> Update src/main/pages/che-7/hands-on-guidance/proc_creating-a-workspace-by-importing-source-code-of-your-project.adoc Co-Authored-By: supriya <[email protected]> Update src/main/pages/che-7/hands-on-guidance/proc_creating-a-workspace-by-importing-source-code-of-your-project.adoc Co-Authored-By: supriya <[email protected]> Update src/main/pages/che-7/hands-on-guidance/proc_creating-a-workspace-by-importing-source-code-of-your-project.adoc Co-Authored-By: supriya <[email protected]> Update src/main/pages/che-7/hands-on-guidance/proc_configuring-a-che-workspace-using-a-devfile.adoc Co-Authored-By: supriya <[email protected]> Update src/main/pages/che-7/hands-on-guidance/proc_creating-a-workspace-by-importing-source-code-of-your-project.adoc Co-Authored-By: supriya <[email protected]> Update src/main/pages/che-7/hands-on-guidance/proc_creating-a-workspace-by-importing-source-code-of-your-project.adoc Co-Authored-By: supriya <[email protected]> Update src/main/pages/che-7/hands-on-guidance/proc_configuring-a-che-workspace-using-a-devfile.adoc Co-Authored-By: supriya <[email protected]> Update src/main/pages/che-7/hands-on-guidance/proc_configuring-a-che-workspace-using-a-devfile.adoc Co-Authored-By: supriya <[email protected]> Update src/main/pages/che-7/hands-on-guidance/proc_configuring-a-che-workspace-using-a-devfile.adoc Co-Authored-By: supriya <[email protected]> Update src/main/pages/che-7/hands-on-guidance/proc_creating-a-workspace-by-importing-source-code-of-your-project.adoc Co-Authored-By: supriya <[email protected]> tweak copy and fix missing link: Change-Id: I77efe65b49497427b00d30a248c8f25f3fbe2989 Signed-off-by: nickboldt <[email protected]> fix case of Devfile tab Change-Id: Ifba180d4f49d311a445e4620d317643988844aae Signed-off-by: nickboldt <[email protected]> tweak copy re: devfiles and Che 6 Change-Id: Ibd3f1b620af9653e65b32029d318f0c9575c97f9 Signed-off-by: nickboldt <[email protected]> replace 'User Dashboard' with Dashboard (even though that's the name for it in the che-6 docs) Change-Id: I4f2b63f44e197a1b353326ab2cfc104b19f8473a Signed-off-by: nickboldt <[email protected]> move note into an admonition block Change-Id: I480250b164aea2c5bc7ac5a86256b8b64e540e84 Signed-off-by: nickboldt <[email protected]> misc fixes from Robert and Supriya's feedback Change-Id: I73db1489b2ffc4b9fae2176fb33381cb65f972f9 Signed-off-by: nickboldt <[email protected]> more copy tweaks and link fixes Change-Id: I8dbee4941c72030d13b1c0c4f501616e9eb180f7 Signed-off-by: nickboldt <[email protected]> fix links to non-existant pages Change-Id: Iaf5d2cc74100967b263e27b19c20eecfc21a0e31 Signed-off-by: nickboldt <[email protected]> add bullets to lists of steps Change-Id: I0dd95aeb7f9c1be72ae79d74bd2c254e6a97768a Signed-off-by: nickboldt <[email protected]> fix some links and some formatting Change-Id: I9c6c1020da72232950174b025c68791cd44af125 Signed-off-by: nickboldt <[email protected]> replace 'Che Dashboard' with Dashboard Change-Id: I4c42cff108312834e91e28da974778f41c0b7c9d Signed-off-by: nickboldt <[email protected]> minor tweaks from Supriya's latest review Change-Id: Ifa113598bbbc457aca2d07a1dff819a28b9c271c Signed-off-by: nickboldt <[email protected]> remove more 'you can...' instances Change-Id: Id8a4541df17a92913db1e52a8f11cae885854b77 Signed-off-by: nickboldt <[email protected]> more copy edits from Supriya Change-Id: I26d7823152dd806cc2606e22d0895317214c1894 Signed-off-by: nickboldt <[email protected]>

nickboldt · 2019-07-15T19:43:53Z

I've included Supriya's feedback from 11 hrs ago and force pushed a new PR. Good enough to merge now?

rkratky · 2019-07-17T00:51:02Z

@nickboldt, the force-push took away the possibility for me to approve. It's +1 from me, but @slemeur needs to approve in order to allow merging.

nickboldt requested review from rkratky and slemeur as code owners June 21, 2019 18:14

nickboldt force-pushed the i12974 branch 3 times, most recently from 5cbc31a to 23655d2 Compare June 21, 2019 21:57

l0rd mentioned this pull request Jun 21, 2019

Che 7 doc for GA eclipse-che/che#12974

Closed

15 tasks

l0rd mentioned this pull request Jun 27, 2019

Che 7.0.0 Endgame Plan eclipse-che/che#13637

Closed

85 tasks

che-bot added the status/code-review label Jun 27, 2019

nickboldt force-pushed the i12974 branch from 23655d2 to 8be5d15 Compare June 27, 2019 13:41

nickboldt requested a review from l0rd June 28, 2019 10:23

l0rd previously requested changes Jun 28, 2019

View reviewed changes

nickboldt force-pushed the i12974 branch from 8be5d15 to 8994cf9 Compare July 2, 2019 15:45

nickboldt requested a review from l0rd July 2, 2019 16:50

supriya-bharadwaj suggested changes Jul 5, 2019

View reviewed changes

rkratky reviewed Jul 5, 2019

View reviewed changes

src/main/pages/che-7/hands-on-guidance/proc_configuring-a-che-workspace-using-a-devfile.adoc Show resolved Hide resolved

supriya-bharadwaj suggested changes Jul 5, 2019

View reviewed changes

supriya-bharadwaj reviewed Jul 5, 2019

View reviewed changes

nickboldt commented Jul 5, 2019

View reviewed changes

src/main/pages/che-7/hands-on-guidance/proc_creating-a-workspace-from-code-sample.adoc Show resolved Hide resolved

nickboldt commented Jul 5, 2019

View reviewed changes

...-7/hands-on-guidance/proc_creating-a-workspace-by-importing-source-code-of-your-project.adoc Show resolved Hide resolved

nickboldt commented Jul 5, 2019

View reviewed changes

src/main/pages/che-7/hands-on-guidance/proc_configuring-a-che-workspace-using-a-devfile.adoc Show resolved Hide resolved

nickboldt commented Jul 5, 2019

View reviewed changes

src/main/pages/che-7/hands-on-guidance/proc_configuring-a-che-workspace-using-a-devfile.adoc Show resolved Hide resolved

nickboldt commented Jul 5, 2019

View reviewed changes

src/main/pages/che-7/hands-on-guidance/proc_configuring-a-che-workspace-using-a-devfile.adoc Show resolved Hide resolved

rkratky reviewed Jul 6, 2019

View reviewed changes

src/main/pages/che-7/hands-on-guidance/proc_creating-a-workspace-from-code-sample.adoc Outdated Show resolved Hide resolved

nickboldt force-pushed the i12974 branch 2 times, most recently from 4b2434e to 1148877 Compare July 12, 2019 19:09

supriya-bharadwaj reviewed Jul 15, 2019

View reviewed changes

nickboldt force-pushed the i12974 branch from 89b6264 to 48e6f05 Compare July 15, 2019 19:43

slemeur approved these changes Jul 17, 2019

View reviewed changes

rkratky merged commit d7c1763 into eclipse-che:master Jul 18, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

i12974 - two new docs:... #737

i12974 - two new docs:... #737

nickboldt commented Jun 21, 2019

nickboldt commented Jun 21, 2019

nickboldt commented Jun 25, 2019 •

edited

Loading

rkratky commented Jun 26, 2019

l0rd left a comment

nickboldt commented Jul 2, 2019 •

edited

Loading

supriya-bharadwaj commented Jul 5, 2019

nickboldt commented Jul 12, 2019 •

edited

Loading

supriya-bharadwaj Jul 8, 2019

nickboldt commented Jul 15, 2019

rkratky commented Jul 17, 2019


		==== Creating a workspace from a devfile

		. Commit a `devfile.yaml` into the root of your git repo.

i12974 - two new docs:... #737

i12974 - two new docs:... #737

Conversation

nickboldt commented Jun 21, 2019

nickboldt commented Jun 21, 2019

nickboldt commented Jun 25, 2019 • edited Loading

rkratky commented Jun 26, 2019

l0rd left a comment

Choose a reason for hiding this comment

nickboldt commented Jul 2, 2019 • edited Loading

supriya-bharadwaj commented Jul 5, 2019

nickboldt commented Jul 12, 2019 • edited Loading

supriya-bharadwaj Jul 8, 2019

Choose a reason for hiding this comment

nickboldt commented Jul 15, 2019

rkratky commented Jul 17, 2019

nickboldt commented Jun 25, 2019 •

edited

Loading

nickboldt commented Jul 2, 2019 •

edited

Loading

nickboldt commented Jul 12, 2019 •

edited

Loading