che-docs #715 Adding documentation for Hosted Che #729

ibuziuk · 2019-06-12T10:18:24Z

Signed-off-by: Ilya Buziuk ibuziuk@redhat.com

What does this PR do?

Adding documentation for Hosted Che

What issues does this PR fix or reference?

#715

themr0c

Hello @ibuziuk, what do you think of the proposed suggestions?

src/main/pages/che-7/overview/assembly_hosted-che.adoc

ibuziuk · 2019-07-05T15:51:19Z

@rkratky @supriya-bharadwaj @themr0c PR is ready for review

l0rd · 2019-07-07T21:21:14Z

src/main/pages/che-7/overview/assembly_hosted-che.adoc


-[id='related-information-{context}']
-== Related information
+NOTE: In order to use push the source code to GitHub from IDE you will need to generate SSH keys using the link:https://github.com/eclipse/che-theia/tree/master/plugins/ssh-plugin[SSH Plug-in] and upload the public key to your GitHub account (`Settings` -> `SSH and GPG keys` -> `New SSH key`) 


There should be a section dedicated to this topic (c.f. the section in che-docs and the google doc for the draft ). I would rather add a link to that doc here.

l0rd · 2019-07-07T21:23:18Z

src/main/pages/che-7/overview/assembly_hosted-che.adoc


-:context: {parent-context-of-hosted-che}
+Frequently Asked Questions (FAQs) and Troubleshooting can be found on the following link:https://github.com/redhat-developer/rh-che/blob/master/FAQ.adoc[link].


We are centralizing all the issues/README/wiki to eclipse/che. Wouldn't make sense to move the hosted-che FAQ to eclipse/che as well?

good point 👍

l0rd

Really really good. Concise and clear. I have added a couple of comment but these are really minor stuff so I am ok to merge even with the current PR content.

ibuziuk · 2019-07-08T09:10:36Z

@l0rd thank you for review - have added a link to "Configuring your VCS credentials for your workspaces" + moved FAQ / Troubleshooting to the doc. Once PR is merged and Hosted Che docs will be available we would also need to update the link in the UD footer - redhat-developer/rh-che#1479

Katka92

Good job! 👍

themr0c · 2019-07-08T14:55:06Z

@l0rd What is exactly the plan for the Hosted Che FAQ?

regroup it with the current Hosted Che doc in the repository https://github.com/eclipse/che-docs to make it available in https://www.eclipse.org/che/docs/che-7/index.html. In other word we need to integrate here all FAQ entries currently in https://github.com/redhat-developer/rh-che/blob/master/FAQ.adoc.
regroup it with issues/README/wiki to the repository in https://github.com/eclipse/che. In other words remove FAQ entries from current PR?

ibuziuk · 2019-07-08T15:07:50Z

I will let @l0rd to comment but for me it does not make sense to Have Hosted Che docs in the https://github.com/eclipse/che wiki. I personally would really like to have all the Hosted Che docs consolidated in one place (including FAQ) and get rid of the https://github.com/redhat-developer/rh-che/blob/master/FAQ.adoc from the Downstream repo.

l0rd · 2019-07-08T17:02:18Z

I think there should be consistency. If we have upstream Che FAQ in the eclipse/che wiki we should have hosted Che FAQ in that same wiki as well. Or we can move both in che-docs. But it should be consistent.

rkratky · 2019-07-09T06:22:48Z

@l0rd, I agree about consistency, but I think that what you're suggesting actually makes things more confusing and inconsistent. What would make sense from the perspective of a user who doesn't know about our internal discussions and processes, is to have an FAQ doc in the repo to which it belongs. Putting Hosted Che FAQ to the upstream Eclipse Che repo is not intuitive.

Upstream Che is an Eclipse Foundation project. Hosted Che is a Red Hat product. Just as we don't put CRW docs into the Eclipse Che repo, we shouldn't, in my opinion, do it with Hosted Che.

ibuziuk · 2019-07-09T06:33:58Z

Upstream Che is an Eclipse Foundation project. Hosted Che is a Red Hat product. Just as we don't put CRW docs into the Eclipse Che repo, we shouldn't, in my opinion, do it with Hosted Che.

I also think that putting Hosted Che FAQ [1] to upstream would be more confusing. However, Hosted Che FAQ bits are not part of the Che 7 GA endgame plan. So, I would propose for now:

leave Hosted Che FAQ in the rh-che repo [1] as it was originally implemented as part of the Need to add additional "FAQ" link to the UD which would point to the adoc in the rh-che repo redhat-developer/rh-che#1287
In the Hosted Che docs have a link to this FAQ as was originally done in this PR:

[id='faq']
== Frequently Asked Questions (FAQs) and Troubleshooting
Frequently Asked Questions (FAQs) and Troubleshooting can be found on the following link:https://github.com/redhat-developer/rh-che/blob/master/FAQ.adoc[link].

After GA release we could reconsider what would be the best place for FAQ.
@rkratky @l0rd wdyt?

[1] https://github.com/redhat-developer/rh-che/blob/master/FAQ.adoc

rkratky · 2019-07-09T06:40:12Z

+1 @ibuziuk

l0rd · 2019-07-09T07:36:25Z

Currently on Che community website there are direct links to hosted Che. On Che community documentation there are direct links to hosted Che as well. If we want to be consistent with what you are proposing we should move those links away from upstream because, as you said, hosted Che is a Red Hat product and we should separate community and downstream or user and contributors will be confused. However we are pushing for presenting hosted Che as the place to go and try upstream Che (not CodeReady Workspaces). We are pushing to make upstream and hosted Che based on the same identical (community) codebase. We are considering deprecating rh-che GitHub repository. I believe the latter is the right direction for us today (unification). But I understand and find reasonable the first approach as well (separation). But on both cases we need to be consistent.

…

On Tue, Jul 9, 2019, 08:40 Robert Kratky ***@***.***> wrote: +1 @ibuziuk <https://github.com/ibuziuk> — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#729>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAEUF34ZPNALK3RQHC4GLPDP6QXFBANCNFSM4HXHO46A> .

l0rd · 2019-07-09T08:44:56Z

Anyway +1 to merge this PR as it is and open an issue/question to discuss where the hosted-che FAQ should be located.

ibuziuk · 2019-07-09T08:56:21Z

@l0rd sounds good, I have updated FAQ related issue redhat-developer/rh-che#1479 accordingly

themr0c

I aggregated suggestions in https://github.com/ibuziuk/che-docs/pull/1/files, I will remove my flood and suggestions from here, and I apologize for the flood.

ibuziuk · 2019-07-09T10:13:25Z

@rkratky will let you review first ;-) ^

ibuziuk · 2019-07-11T11:47:35Z

@rkratky @themr0c is it expected that all the images but one getting-started-devfile.png have been removed ?

ibuziuk · 2019-07-11T11:49:50Z

Creating a worskpace from the user dashboard
This section describes how to create a workspace from the user dashboard in Hosted Che.

Prerequisites
Existing Hosted Che account. See Registering to Hosted Che.

Link Registering to Hosted Che. is broken

themr0c · 2019-07-11T12:10:50Z

@ibuziuk Yes I removed most images and replaced them with a textual description which should last longer.

ibuziuk · 2019-07-11T12:11:17Z

@themr0c most = all but one ?

themr0c · 2019-07-11T12:33:56Z

Yes, screenshots that are at the end of the procedure are fine.

Co-Authored-By: Fabrice Flore-Thébault <ffloreth@redhat.com> Robert Kratky <rkratky@redhat.com> Signed-off-by: Ilya Buziuk <ibuziuk@redhat.com>

ibuziuk · 2019-07-11T13:12:05Z

@themr0c PR is https://github.com/ibuziuk/che-docs/pull/1/files merged and all the changes are squashed in 1 commit.

@rkratky waiting for your final approval before merging to master

ibuziuk force-pushed the che-docs-715 branch from 9783d52 to 2c944ef Compare June 12, 2019 10:41

ibuziuk mentioned this pull request Jun 12, 2019

Che 7 GA: Need to create docs for "Hosted Che" section redhat-developer/rh-che#1423

Closed

l0rd mentioned this pull request Jun 13, 2019

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

Closed

15 tasks

themr0c reviewed Jun 25, 2019

View reviewed changes

l0rd mentioned this pull request Jun 27, 2019

Che 7.0.0 Endgame Plan eclipse-che/che#13637

Closed

85 tasks

che-bot added status/code-review kind/docs labels Jun 27, 2019

ibuziuk force-pushed the che-docs-715 branch 2 times, most recently from a24c111 to 0754410 Compare July 1, 2019 14:59

ibuziuk force-pushed the che-docs-715 branch 3 times, most recently from d53dfc7 to 75ff493 Compare July 5, 2019 15:48

ibuziuk requested a review from rkratky July 5, 2019 15:49

ibuziuk marked this pull request as ready for review July 5, 2019 15:49

ibuziuk requested a review from slemeur as a code owner July 5, 2019 15:49

l0rd reviewed Jul 7, 2019

View reviewed changes

l0rd approved these changes Jul 7, 2019

View reviewed changes

ibuziuk mentioned this pull request Jul 8, 2019

Need to find a better home for Hosted Che FAQ redhat-developer/rh-che#1479

Closed

Katka92 approved these changes Jul 8, 2019

View reviewed changes

themr0c reviewed Jul 9, 2019

View reviewed changes

che-docs #715 Adding documentation for Hosted Che

27c0f1d

Co-Authored-By: Fabrice Flore-Thébault <ffloreth@redhat.com> Robert Kratky <rkratky@redhat.com> Signed-off-by: Ilya Buziuk <ibuziuk@redhat.com>

ibuziuk force-pushed the che-docs-715 branch from 9a18cda to 27c0f1d Compare July 11, 2019 13:09

themr0c approved these changes Jul 11, 2019

View reviewed changes

rkratky approved these changes Jul 11, 2019

View reviewed changes

ibuziuk merged commit 9842296 into eclipse-che:master Jul 11, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

che-docs #715 Adding documentation for Hosted Che #729

che-docs #715 Adding documentation for Hosted Che #729

ibuziuk commented Jun 12, 2019

themr0c left a comment

ibuziuk commented Jul 5, 2019

l0rd Jul 7, 2019

ibuziuk Jul 8, 2019

l0rd Jul 7, 2019

ibuziuk Jul 8, 2019

l0rd left a comment

ibuziuk commented Jul 8, 2019 •

edited

Loading

Katka92 left a comment

themr0c commented Jul 8, 2019

ibuziuk commented Jul 8, 2019 •

edited

Loading

l0rd commented Jul 8, 2019

rkratky commented Jul 9, 2019

ibuziuk commented Jul 9, 2019

rkratky commented Jul 9, 2019

l0rd commented Jul 9, 2019 via email

l0rd commented Jul 9, 2019

ibuziuk commented Jul 9, 2019

themr0c left a comment

ibuziuk commented Jul 9, 2019

ibuziuk commented Jul 11, 2019

ibuziuk commented Jul 11, 2019

themr0c commented Jul 11, 2019

ibuziuk commented Jul 11, 2019

themr0c commented Jul 11, 2019

ibuziuk commented Jul 11, 2019


		:context: {parent-context-of-hosted-che}
		Frequently Asked Questions (FAQs) and Troubleshooting can be found on the following link:https://github.com/redhat-developer/rh-che/blob/master/FAQ.adoc[link].

che-docs #715 Adding documentation for Hosted Che #729

che-docs #715 Adding documentation for Hosted Che #729

Conversation

ibuziuk commented Jun 12, 2019

What does this PR do?

What issues does this PR fix or reference?

themr0c left a comment

Choose a reason for hiding this comment

ibuziuk commented Jul 5, 2019

l0rd Jul 7, 2019

Choose a reason for hiding this comment

ibuziuk Jul 8, 2019

Choose a reason for hiding this comment

l0rd Jul 7, 2019

Choose a reason for hiding this comment

ibuziuk Jul 8, 2019

Choose a reason for hiding this comment

l0rd left a comment

Choose a reason for hiding this comment

ibuziuk commented Jul 8, 2019 • edited Loading

Katka92 left a comment

Choose a reason for hiding this comment

themr0c commented Jul 8, 2019

ibuziuk commented Jul 8, 2019 • edited Loading

l0rd commented Jul 8, 2019

rkratky commented Jul 9, 2019

ibuziuk commented Jul 9, 2019

rkratky commented Jul 9, 2019

l0rd commented Jul 9, 2019 via email

l0rd commented Jul 9, 2019

ibuziuk commented Jul 9, 2019

themr0c left a comment

Choose a reason for hiding this comment

ibuziuk commented Jul 9, 2019

ibuziuk commented Jul 11, 2019

ibuziuk commented Jul 11, 2019

themr0c commented Jul 11, 2019

ibuziuk commented Jul 11, 2019

themr0c commented Jul 11, 2019

ibuziuk commented Jul 11, 2019

ibuziuk commented Jul 8, 2019 •

edited

Loading

ibuziuk commented Jul 8, 2019 •

edited

Loading