Add a note about gitconfig username and email automatic update #2692
Conversation
|
Click here to review and test in web IDE: |
-525C86?logo=eclipse-che&labelColor=red){kind=icon}
|
🎊 Navigate the preview: https://65ef0b67beb394509caf613d--eclipse-che-docs-pr.netlify.app 🎊 |
| @@ -46,6 +46,11 @@ __<ConfigMap_prepared_in_step_1>__ | |||
| EOF | |||
| ---- | |||
|
|
|||
| [NOTE] | |||
| ==== | |||
| The `user.name` and `user.email` fields can be set automatically from a git provider, connected to {prod-short} by a xref:using-a-git-provider-access-token.adoc[Git-provider access token]. The related data must be set in the provider's user profile page. | |||
There was a problem hiding this comment.
is it supported for all providers?
There was a problem hiding this comment.
it is not only about access token, but also Git OAuth
There was a problem hiding this comment.
It is not related directly to Git OAuth, the idea is to have a token secret either generated by Git OAuth, or manually created PAT secret. So the token documentation reference covers both cases.
There was a problem hiding this comment.
well, but it is linked with https://eclipse.dev/che/docs/stable/end-user-guide/using-a-git-provider-access-token/ that talks about PAT which is misleading
There was a problem hiding this comment.
Mentioned the OAuth source as well.
| @@ -46,6 +46,11 @@ __<ConfigMap_prepared_in_step_1>__ | |||
| EOF | |||
| ---- | |||
|
|
|||
| [NOTE] | |||
There was a problem hiding this comment.
Let's put the note at the top of the procedure, before pre-requirements
There was a problem hiding this comment.
I've changed the configmap block to not to specify just username and email but generalise the gitconfig content:
With this change I think the note suits here more as it specifies that the general gitconfig content can be updated automatically.
There was a problem hiding this comment.
@vinokurig this NOTE should be placed at the very beginning, just after the title Mounting Git configuration
|
@deerskindoll we are good to merge |
What does this pull request change?
Add a note about gitconfig username and email automatic update:
What issues does this pull request fix or reference?
fixes eclipse-che/che#22828
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.
Validate language on files added or modifiedstep reports no vale warnings.