diff --git a/modules/end-user-guide/nav.adoc b/modules/end-user-guide/nav.adoc index 52d70e9ea3..e3f4375339 100644 --- a/modules/end-user-guide/nav.adoc +++ b/modules/end-user-guide/nav.adoc @@ -14,6 +14,7 @@ *** xref:url-parameter-for-the-devfile-file-name.adoc[] *** xref:url-parameter-for-the-devfile-file-path.adoc[] *** xref:url-parameter-for-the-workspace-storage.adoc[] +*** xref:url-parameter-for-additional-remotes.adoc[] ** xref:basic-actions-you-can-perform-on-a-workspace.adoc[] ** xref:authenticating-to-a-git-server-from-a-workspace.adoc[] * xref:customizing-workspace-components.adoc[] diff --git a/modules/end-user-guide/pages/optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc b/modules/end-user-guide/pages/optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc index b36101885e..90478cd183 100644 --- a/modules/end-user-guide/pages/optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc +++ b/modules/end-user-guide/pages/optional-parameters-for-the-urls-for-starting-a-new-workspace.adoc @@ -15,3 +15,4 @@ When you start a new workspace, {prod-short} configures the workspace according * xref:url-parameter-for-the-devfile-file-name.adoc[] * xref:url-parameter-for-the-devfile-file-path.adoc[] * xref:url-parameter-for-the-workspace-storage.adoc[] +* xref:url-parameter-for-additional-remotes.adoc[] diff --git a/modules/end-user-guide/pages/url-parameter-for-additional-remotes.adoc b/modules/end-user-guide/pages/url-parameter-for-additional-remotes.adoc new file mode 100644 index 0000000000..394b3f7936 --- /dev/null +++ b/modules/end-user-guide/pages/url-parameter-for-additional-remotes.adoc @@ -0,0 +1,27 @@ +:_content-type: CONCEPT +:description: URL parameter for additional remotes +:keywords: additional-remote, more-remotes, configure-remote, remotes-parameter +:navtitle: URL parameter for additional remotes +:page-aliases: + +[id="url-parameter-for-additional-remotes"] += URL parameter for additional remotes + +When you visit a URL for starting a new workspace, {prod-short} configures the `origin` remote to be the Git repository that you specified with `#` after the FQDN URL of your organization’s {prod-short} instance. + +The URL parameter for cloning and configuring additional remotes for the workspace is `remotes=`: + +[source,subs="+quotes,+attributes,+macros"] +---- +pass:c,a,q[{prod-url}]#____?remotes={{____,____},{____,____},{____,____},...} +---- + +[IMPORTANT] +==== + +* If you do not enter the name `origin` for any of the additional remotes, the remote from ____ will be cloned and named `origin` by default, and its expected branch will be checked out automatically. + +* If you enter the name `origin` for one of the additional remotes, its default branch will be checked out automatically, but the remote from ____ will NOT be cloned for the workspace. + +==== +