Help us learn about your current experience with the documentation.
Take the survey.
Contribute code with GitpodNow for the fun part. Let’s edit some code.
In this example, I found some UI text I’d like to change. In the upper-right corner in GitLab, I selected my avatar and then Preferences. I want to change Syntax highlighting theme
to Code syntax highlighting theme
:
This tutorial is designed to be a general introduction to contributing to the GitLab project and is not an example of a change that should be submitted for review.
Create a new branch for your changes:
Select master
in the status bar, then from the Select a branch or tag to checkout box, select Create new branch and enter a name for the new branch.
If your code change addresses an issue, start the branch name with the issue number.
The examples in this doc use a new branch called ui-updates
.
Search the repository for the string Syntax highlighting theme
:
Select the app/views/profiles/preferences/show.html.haml
file.
Update the string to Code syntax highlighting theme
.
Save your changes.
Use the IDE Terminal tab to commit the changes:
git commit -m "Update UI text
Standardizing the text on this page so
that each area uses consistent language."
Follow the GitLab commit message guidelines.
Push the changes to the new branch:
git push --set-upstream origin ui-updates
You can create a merge request with the code change, or continue to update the translation files.
English UI strings are localized into many languages. These strings are saved in a .pot
file, which must be regenerated any time you update UI text.
To automatically regenerate the localization file:
Ensure you are in the gitlab-development-kit/gitlab
directory.
Run the following command:
tooling/bin/gettext_extractor locale/gitlab.pot
The .pot
file will be generated in the /locale
directory.
Now, in the gitlab-development-kit/gitlab
directory, if you type git status
you should have both files listed:
modified: app/views/profiles/preferences/show.html.haml
modified: locale/gitlab.pot
Commit and push the changes.
Create a merge request or continue to update the documentation.
For more information about localization, see internationalization.
Update the documentationDocumentation for GitLab is published on https://docs.gitlab.com. When you add or update a feature, you must update the documentation as well.
To find the documentation for a feature, the easiest thing is to search the documentation site. In this case, the setting is described on this documentation page:
https://docs.gitlab.com/ee/user/profile/preferences.html
The URL shows you the location of the file in the /doc
directory. In this case, the location is:
doc/user/profile/preferences.md
Go to this location in your local gitlab
repository and update the .md
file and any related images.
Now when you run git status
, you should have something like:
modified: app/views/profiles/preferences/show.html.haml
modified: doc/user/profile/img/profile-preferences-syntax-themes.png
modified: doc/user/profile/preferences.md
modified: locale/gitlab.pot
Commit and push the changes.
Create a merge request or continue to update the documentation.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4