Skip to content
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

docs: user onboarding, starting a new workspace, URL parameters #2252

Merged
merged 35 commits into from
Apr 13, 2022

Conversation

max-cx
Copy link
Contributor

@max-cx max-cx commented Mar 29, 2022

What does this pull request change

This is the reworked master branch version of #2227.

What issues does this pull request fix or reference

Specify the version of the product this pull request applies to

Pull request checklist

The author and the reviewers validate the content of this pull request with the following checklist, in addition to the automated tests.

  • Any procedure:
    • Successfully tested.
  • Any page or link rename:
  • Builds on Eclipse Che hosted by Red Hat.
  • the Validate language on files added or modified step reports no vale warnings.

@max-cx max-cx requested review from rkratky and themr0c as code owners March 29, 2022 08:50
@github-actions
Copy link

Click here to review and test in web IDE: Contribute

@benoitf benoitf self-requested a review March 29, 2022 10:00
@max-cx max-cx changed the title procedures: user onboarding, starting a new workspace, URL parameters docs: user onboarding, starting a new workspace, URL parameters Mar 29, 2022
@max-cx
Copy link
Contributor Author

max-cx commented Apr 7, 2022

@benoitf, i'm sorry about your disappointment.

This image can only be added to the docs as an example because it contains a specific repository and a unique choice of optional parameters.

To use the image in the docs, we would need to replace che-host with a real-life URL to make the example consistent and complete.
Then, we'd probably need to make a downstream version of the image and use a different font as well to make it in line with the downstream docs.
On the one hand, I wouldn't want to bother you with editing this image when I needed this to be done.
On the other hand, I myself don't perceive the advantages of using an image here and making the editing effort.
Also, if there are any future changes on this topic, any contributor to the docs repo can quickly and easily update the adoc files without having to discard the image or figure out how to edit the image or produce a new one.

I really appreciate your effort that you put into the blog post, but I'd also like to avoid the complications of using images in the docs where images may not be irreplaceable like in this particular context.

@benoitf
Copy link
Contributor

benoitf commented Apr 7, 2022

@max-cx the image is generated using that link https://excalidraw.com/#json=Z4gT6H3GoZwJkfvVCajad,Qtltwy9uKpQOtosF8mh00g

so no need to bother people, it's easy to update :-)

@max-cx
Copy link
Contributor Author

max-cx commented Apr 7, 2022

@benoitf, I like it, thanks for sharing!

I've tried it. See for yourself, the URL is too long for an image when used in the docs.
So the letters become too small even before adding a real-world hostname, which will make it even longer and smaller:

image

Compare it to what I have now:

image

Copy link

@rkratky rkratky left a comment

Choose a reason for hiding this comment

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

@max-cx, review with a few changes submitted.

max-cx and others added 7 commits April 8, 2022 17:22
Co-authored-by: Robert Krátký <rkratky@redhat.com>
…lone-of-a-git-repository.adoc

Co-authored-by: Robert Krátký <rkratky@redhat.com>
…lone-of-a-git-repository.adoc

Co-authored-by: Robert Krátký <rkratky@redhat.com>
…for-starting-a-new-workspace.adoc

Co-authored-by: Robert Krátký <rkratky@redhat.com>
…lone-of-a-git-repository.adoc

Co-authored-by: Robert Krátký <rkratky@redhat.com>
@themr0c themr0c deleted the branch eclipse-che:master April 11, 2022 12:17
@themr0c themr0c closed this Apr 11, 2022
@themr0c
Copy link
Contributor

themr0c commented Apr 11, 2022

I apologize for the erroneous closing. My mistake.

@themr0c themr0c reopened this Apr 11, 2022
@rkratky rkratky merged commit bf67767 into eclipse-che:master Apr 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants