docs: URL parameter for configuring remotes #2531
Conversation
Signed-off-by: dkwon17 <dakwon@redhat.com>
dkwon17
requested review from
rkratky,
themr0c,
max-cx and
a team
as code owners
|
Click here to review and test in web IDE: |
|
🎊 Navigate the preview: https://63d244fee3215c27e6c97459--eclipse-che-docs-pr.netlify.app 🎊 |
|
Click here to review and test in web IDE: |
-525C86?logo=eclipse-che&labelColor=red){kind=icon}
|
@max-cx could you please review? |
modules/end-user-guide/pages/url-parameter-for-configuring-project-remotes.adoc
Outdated
Show resolved
Hide resolved
modules/end-user-guide/pages/url-parameter-for-configuring-project-remotes.adoc
Outdated
Show resolved
Hide resolved
modules/end-user-guide/pages/url-parameter-for-configuring-project-remotes.adoc
Outdated
Show resolved
Hide resolved
modules/end-user-guide/pages/url-parameter-for-configuring-project-remotes.adoc
Outdated
Show resolved
Hide resolved
…ject-remotes.adoc Co-authored-by: Nick Boldt <nboldt@redhat.com>
…ject-remotes.adoc Co-authored-by: Nick Boldt <nboldt@redhat.com>
…ject-remotes.adoc Co-authored-by: Nick Boldt <nboldt@redhat.com>
Signed-off-by: dkwon17 <dakwon@redhat.com>
Signed-off-by: dkwon17 <dakwon@redhat.com>
|
@max-cx can we merge the PR now? |
|
Also, I'd like to suggest documenting the other way of doing this (without specifying the remote names) as an admonition like TIP. Please correct me if I am wrong, but my current understanding is that explicitly specifying the names of the additional remotes manually by the user offers more flexibility in terms of which remote becomes the origin and is checked out, which might cover more use cases. If that is true, then that would be the number one choice in the docs. And I wouldn't recommend offering readers multiple ways of doing the same thing as separate and parallel sections in the docs. |
Review and proposed edit of eclipse-che#2531
|
@max-cx yes, documenting the other way of doing this as an admonition/TIP sounds good to me |
modules/end-user-guide/pages/url-parameter-for-additional-remotes.adoc
Outdated
Show resolved
Hide resolved
* docs: URL parameter for configuring remotes Signed-off-by: dkwon17 <dakwon@redhat.com> * Update modules/end-user-guide/pages/url-parameter-for-configuring-project-remotes.adoc Co-authored-by: Nick Boldt <nboldt@redhat.com> * Update modules/end-user-guide/pages/url-parameter-for-configuring-project-remotes.adoc Co-authored-by: Nick Boldt <nboldt@redhat.com> * Update modules/end-user-guide/pages/url-parameter-for-configuring-project-remotes.adoc Co-authored-by: Nick Boldt <nboldt@redhat.com> * Small wording change, add xref Signed-off-by: dkwon17 <dakwon@redhat.com> * Remove <1> Signed-off-by: dkwon17 <dakwon@redhat.com> * initial edits * Update modules/end-user-guide/pages/url-parameter-for-additional-remotes.adoc Signed-off-by: dkwon17 <dakwon@redhat.com> Co-authored-by: Nick Boldt <nboldt@redhat.com> Co-authored-by: Max Leonov <mleonov@redhat.com>
Signed-off-by: dkwon17 dakwon@redhat.com
What does this pull request change?
Adds a
URL parameter for configuring project remotessection in the user guide.What issues does this pull request fix or reference?
This PR is to document the feature added by this PR: eclipse-che/che-dashboard#691
Specify the version of the product this pull request applies to
Che 7.59
(This feature was Backported to Che 7.58, therefore can be available for DS 3.4)
mainand cherry-pick to7.58Pull Request checklist
The author and the reviewers validate the content of this pull request with the following checklist, in addition to the automated tests.
Validate language on files added or modifiedstep reports no vale warnings.