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.

Sign up for GitHub

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

Add a note about gitconfig username and email automatic update #2692

Merged
merged 7 commits into from
Mar 25, 2024
Merged

Add a note about gitconfig username and email automatic update #2692

Changes from 4 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
a79dc3d
Add a note about gitconfig username and email automatic update
vinokurig Feb 22, 2024
f6f2794
fixup! Add a note about gitconfig username and email automatic update
vinokurig Feb 22, 2024
72c9d85
fixup! Add a note about gitconfig username and email automatic update
vinokurig Feb 22, 2024
4719d89
fixup! Add a note about gitconfig username and email automatic update
vinokurig Feb 22, 2024
f4cf3d9
Update modules/end-user-guide/pages/mounting-git-configuration.adoc
vinokurig Feb 28, 2024
16e2b4f
Merge branch 'main' of github.com:eclipse-che/che-docs into che-22828
vinokurig Mar 7, 2024
8b6e301
fixup! Add a note about gitconfig username and email automatic update
vinokurig Mar 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions modules/end-user-guide/pages/mounting-git-configuration.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,11 @@ metadata:
controller.devfile.io/mount-as: subpath
controller.devfile.io/mount-path: /etc/
data:
gitconfig: "[user] \n name = __<git_user_name>__ \n email = __<git_user_email>__" <2>
gitconfig: <gitconfig content> <2>
----
+
<1> A user namespace. Visit `pass:c,a,q[{prod-url}]/api/kubernetes/namespace` to get your {prod-short} user namespace as `name`.
<2> Your Git user name and email.
<2> The content of your gitconfig file content.

. Apply the ConfigMap.
+
Expand All @@ -46,6 +46,11 @@ __<ConfigMap_prepared_in_step_1>__
EOF
----

[NOTE]
Copy link
Member

Choose a reason for hiding this comment

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

Let's put the note at the top of the procedure, before pre-requirements

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've changed the configmap block to not to specify just username and email but generalise the gitconfig content:

screenshot-0 0 0 0_4000-2024 02 22-16_31_27

With this change I think the note suits here more as it specifies that the general gitconfig content can be updated automatically.

Copy link
Member

Choose a reason for hiding this comment

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

@vinokurig this NOTE should be placed at the very beginning, just after the title Mounting Git configuration

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@ibuziuk done

====
The `user.name` and `user.email` fields can be set automatically to the `gitconfig` content from a git provider, connected to {prod-short} by a xref:using-a-git-provider-access-token.adoc[Git-provider access token] or a token generated via OAuth. The related data must be set in the provider's user profile page.
vinokurig marked this conversation as resolved.
Show resolved Hide resolved
====

.Verification

. xref:starting-a-workspace-from-a-git-repository-url.adoc[Start a new workspace by using the URL of a remote Git repository] that the Git provider hosts.
Expand Down
Loading