diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/administration/housekeeping.md | 26 | ||||
-rw-r--r-- | doc/api/groups.md | 2 | ||||
-rw-r--r-- | doc/api/settings.md | 1 | ||||
-rw-r--r-- | doc/development/changelog.md | 15 | ||||
-rw-r--r-- | doc/development/ux_guide/basics.md | 7 | ||||
-rw-r--r-- | doc/development/ux_guide/components.md | 13 | ||||
-rw-r--r-- | doc/development/ux_guide/img/color-textprimary.png | bin | 0 -> 2553 bytes | |||
-rw-r--r-- | doc/development/ux_guide/img/color-textsecondary.png | bin | 0 -> 2956 bytes | |||
-rw-r--r-- | doc/development/ux_guide/img/components-searchbox.png | bin | 0 -> 5292 bytes | |||
-rw-r--r-- | doc/development/ux_guide/img/components-searchboxscoped.png | bin | 0 -> 9668 bytes | |||
-rw-r--r-- | doc/workflow/importing/import_projects_from_gitea.md | 5 |
11 files changed, 52 insertions, 17 deletions
diff --git a/doc/administration/housekeeping.md b/doc/administration/housekeeping.md index f846c06ca42..bb621b788f1 100644 --- a/doc/administration/housekeeping.md +++ b/doc/administration/housekeeping.md @@ -12,13 +12,24 @@ to turn it off, go to **Admin area > Settings** ## Manual housekeeping -The housekeeping function runs `git gc` ([man page][man]) on the current -project Git repository. +The housekeeping function will run a `repack` or `gc` depending on the +"Automatic Git repository housekeeping" settings configured in **Admin area > Settings** -`git gc` runs a number of housekeeping tasks, such as compressing file -revisions (to reduce disk space and increase performance) and removing -unreachable objects which may have been created from prior invocations of -`git add`. +For example in the following scenario a `git repack -d` will be executed: + ++ Project: pushes since gc counter (`pushes_since_gc`) = `10` ++ Git GC period = `200` ++ Full repack period = `50` + +When the `pushes_since_gc` value is 50 a `repack -A -d --pack-kept-objects` will run, similarly when +the `pushes_since_gc` value is 200 a `git gc` will be run. + ++ `git gc` ([man page][man-gc]) runs a number of housekeeping tasks, +such as compressing filerevisions (to reduce disk space and increase performance) +and removing unreachable objects which may have been created from prior invocations of +`git add`. + ++ `git repack` ([man page][man-repack]) re-organize existing packs into a single, more efficient pack. You can find this option under your **[Project] > Edit Project**. @@ -27,4 +38,5 @@ You can find this option under your **[Project] > Edit Project**. ![Housekeeping settings](img/housekeeping_settings.png) [ce-2371]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/2371 "Housekeeping merge request" -[man]: https://www.kernel.org/pub/software/scm/git/docs/git-gc.html "git gc man page" +[man-gc]: https://www.kernel.org/pub/software/scm/git/docs/git-gc.html "git gc man page" +[man-repack]: https://www.kernel.org/pub/software/scm/git/docs/git-repack.html
\ No newline at end of file diff --git a/doc/api/groups.md b/doc/api/groups.md index bc737bff8ee..f7807390e68 100644 --- a/doc/api/groups.md +++ b/doc/api/groups.md @@ -335,7 +335,7 @@ POST /groups/:id/projects/:project_id Parameters: - `id` (required) - The ID or path of a group -- `project_id` (required) - The ID of a project +- `project_id` (required) - The ID or path of a project ## Update group diff --git a/doc/api/settings.md b/doc/api/settings.md index 218546aafea..0bd38a6e664 100644 --- a/doc/api/settings.md +++ b/doc/api/settings.md @@ -79,6 +79,7 @@ PUT /application/settings | `enabled_git_access_protocol` | string | no | Enabled protocols for Git access. Allowed values are: `ssh`, `http`, and `nil` to allow both protocols. | | `koding_enabled` | boolean | no | Enable Koding integration. Default is `false`. | | `koding_url` | string | yes (if `koding_enabled` is `true`) | The Koding instance URL for integration. | +| `disabled_oauth_sign_in_sources` | Array of strings | no | Disabled OAuth sign-in sources | ```bash curl --request PUT --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/application/settings?signup_enabled=false&default_project_visibility=1 diff --git a/doc/development/changelog.md b/doc/development/changelog.md index 6a97fae9cac..c71858c6a24 100644 --- a/doc/development/changelog.md +++ b/doc/development/changelog.md @@ -40,6 +40,15 @@ Its simplest usage is to provide the value for `title`: ```text $ bin/changelog 'Hey DZ, I added a feature to GitLab!' +``` + +The entry filename is based on the name of the current Git branch. If you run +the command above on a branch called `feature/hey-dz`, it will generate a +`changelogs/unreleased/feature-hey-dz.yml` file. + +The command will output the path of the generated file and its contents: + +```text create changelogs/unreleased/my-feature.yml --- title: Hey DZ, I added a feature to GitLab! @@ -47,10 +56,6 @@ merge_request: author: ``` -The entry filename is based on the name of the current Git branch. If you run -the command above on a branch called `feature/hey-dz`, it will generate a -`changelogs/unreleased/feature-hey-dz.yml` file. - ### Arguments | Argument | Shorthand | Purpose | @@ -139,7 +144,7 @@ Use the **`--git-username`** or **`-u`** argument to automatically fill in the $ git config user.name Jane Doe -$ bin/changelog --u 'Hey DZ, I added a feature to GitLab!' +$ bin/changelog -u 'Hey DZ, I added a feature to GitLab!' create changelogs/unreleased/feature-hey-dz.yml --- title: Hey DZ, I added a feature to GitLab! diff --git a/doc/development/ux_guide/basics.md b/doc/development/ux_guide/basics.md index 76ec7fd466b..259b214bd59 100644 --- a/doc/development/ux_guide/basics.md +++ b/doc/development/ux_guide/basics.md @@ -58,6 +58,13 @@ GitLab uses Font Awesome icons throughout our interface. | ![Red](img/color-red.png) | Closed | Delete and other destructive commands | | ![Grey](img/color-grey.png) | Neutral | Neutral secondary commands | +### Text colors + +||| +| :---: | :--- | +| ![Text primary](img/color-textprimary.png) | Used for primary body text, such as issue description and comment | +| ![Text secondary](img/color-textsecondary.png) | Used for secondary body text, such as username and date | + > TODO: Establish a perspective for color in terms of our personality and rationalize with Marketing usage. --- diff --git a/doc/development/ux_guide/components.md b/doc/development/ux_guide/components.md index 28383ad7dfc..706bb180912 100644 --- a/doc/development/ux_guide/components.md +++ b/doc/development/ux_guide/components.md @@ -12,6 +12,7 @@ * [Panels](#panels) * [Alerts](#alerts) * [Forms](#forms) +* [Search box](#search-box) * [File holders](#file-holders) * [Data formats](#data-formats) @@ -215,6 +216,18 @@ Horizontal form (`form.horizontal-form`) with label rendered inline with input. --- +## Search box + +Search boxes across GitLab have a consistent rest, active and text entered state. When text isn't entered in the box, there should be a magnifying glass right aligned with the input field. When text is entered, the magnifying glass should become a x, allowing users to clear their text. + +![Search box](img/components-searchbox.png) + +If needed, we indicate the scope of the search in the search box. + +![Scoped Search box](img/components-searchboxscoped.png) + +--- + ## File holders A file holder (`.file-holder`) is used to show the contents of a file inline on a page of GitLab. diff --git a/doc/development/ux_guide/img/color-textprimary.png b/doc/development/ux_guide/img/color-textprimary.png Binary files differnew file mode 100644 index 00000000000..90f2821f0cf --- /dev/null +++ b/doc/development/ux_guide/img/color-textprimary.png diff --git a/doc/development/ux_guide/img/color-textsecondary.png b/doc/development/ux_guide/img/color-textsecondary.png Binary files differnew file mode 100644 index 00000000000..61cb8a13c45 --- /dev/null +++ b/doc/development/ux_guide/img/color-textsecondary.png diff --git a/doc/development/ux_guide/img/components-searchbox.png b/doc/development/ux_guide/img/components-searchbox.png Binary files differnew file mode 100644 index 00000000000..a25189296ba --- /dev/null +++ b/doc/development/ux_guide/img/components-searchbox.png diff --git a/doc/development/ux_guide/img/components-searchboxscoped.png b/doc/development/ux_guide/img/components-searchboxscoped.png Binary files differnew file mode 100644 index 00000000000..b116d714848 --- /dev/null +++ b/doc/development/ux_guide/img/components-searchboxscoped.png diff --git a/doc/workflow/importing/import_projects_from_gitea.md b/doc/workflow/importing/import_projects_from_gitea.md index 936cee89f45..f5746a0fb31 100644 --- a/doc/workflow/importing/import_projects_from_gitea.md +++ b/doc/workflow/importing/import_projects_from_gitea.md @@ -5,8 +5,7 @@ Import your projects from Gitea to GitLab with minimal effort. ## Overview >**Note:** -As of Gitea `v1.0.0`, issue & pull-request comments cannot be imported! This is -a [known issue][issue-401] that should be fixed in a near-future. +This requires Gitea `v1.0.0` or newer. - At its current state, Gitea importer can import: - the repository description (GitLab 8.15+) @@ -76,5 +75,3 @@ If you want, you can import all your Gitea projects in one go by hitting You can also choose a different name for the project and a different namespace, if you have the privileges to do so. - -[issue-401]: https://github.com/go-gitea/gitea/issues/401 |