Remove trailing whitespace in docs
Remove unneeded trailing whitespace in lines in /development /ci /api and /administration docs.
This commit is contained in:
Marcel Amirault
Achilleas Pipinellis
parent
2b4521c165
commit
143872fa52
23 changed files with 136 additions and 142 deletions
|
|
@ -696,12 +696,11 @@ project or branch name. Special characters can include:
|
|||
- Trailing hyphen/dash
|
||||
- Double hyphen/dash
|
||||
|
||||
To get around this, you can [change the group path](../user/group/index.md#changing-a-groups-path),
|
||||
[change the project path](../user/project/settings/index.md#renaming-a-repository) or change the
|
||||
branch name. Another option is to create a [push rule](../push_rules/push_rules.html) to prevent
|
||||
To get around this, you can [change the group path](../user/group/index.md#changing-a-groups-path),
|
||||
[change the project path](../user/project/settings/index.md#renaming-a-repository) or change the
|
||||
branch name. Another option is to create a [push rule](../push_rules/push_rules.html) to prevent
|
||||
this at the instance level.
|
||||
|
||||
|
||||
[ce-18239]: https://gitlab.com/gitlab-org/gitlab-ce/issues/18239
|
||||
[docker-insecure-self-signed]: https://docs.docker.com/registry/insecure/#use-self-signed-certificates
|
||||
[reconfigure gitlab]: restart_gitlab.md#omnibus-gitlab-reconfigure
|
||||
|
|
|
|||
|
|
@ -30,7 +30,7 @@ To bring the former **primary** node up to date:
|
|||
`sudo systemctl enable gitlab-runsvdir`. For CentOS 6, you need to install
|
||||
the GitLab instance from scratch and set it up as a **secondary** node by
|
||||
following [Setup instructions][setup-geo]. In this case, you don't need to follow the next step.
|
||||
|
||||
|
||||
NOTE: **Note:** If you [changed the DNS records](index.md#step-4-optional-updating-the-primary-domain-dns-record)
|
||||
for this node during disaster recovery procedure you may need to [block
|
||||
all the writes to this node](planned_failover.md#prevent-updates-to-the-primary-node)
|
||||
|
|
|
|||
|
|
@ -187,7 +187,7 @@ access to the **primary** node during the maintenance window.
|
|||
before it is completed will cause the work to be lost.
|
||||
1. On the **primary** node, navigate to **Admin Area > Geo** and wait for the
|
||||
following conditions to be true of the **secondary** node you are failing over to:
|
||||
|
||||
|
||||
- All replication meters to each 100% replicated, 0% failures.
|
||||
- All verification meters reach 100% verified, 0% failures.
|
||||
- Database replication lag is 0ms.
|
||||
|
|
|
|||
|
|
@ -116,7 +116,7 @@ There is an [issue where support is being discussed](https://gitlab.com/gitlab-o
|
|||
by default. However, Geo requires the **secondary** node to be able to
|
||||
connect to the **primary** node's database. For this reason, we need the address of
|
||||
each node.
|
||||
|
||||
|
||||
NOTE: **Note:** For external PostgreSQL instances, see [additional instructions](external_database.md).
|
||||
|
||||
If you are using a cloud provider, you can lookup the addresses for each
|
||||
|
|
@ -424,22 +424,22 @@ data before running `pg_basebackup`.
|
|||
|
||||
- If PostgreSQL is listening on a non-standard port, add `--port=` as well.
|
||||
- If your database is too large to be transferred in 30 minutes, you will need
|
||||
to increase the timeout, e.g., `--backup-timeout=3600` if you expect the
|
||||
initial replication to take under an hour.
|
||||
- Pass `--sslmode=disable` to skip PostgreSQL TLS authentication altogether
|
||||
(e.g., you know the network path is secure, or you are using a site-to-site
|
||||
VPN). This is **not** safe over the public Internet!
|
||||
- You can read more details about each `sslmode` in the
|
||||
[PostgreSQL documentation][pg-docs-ssl];
|
||||
the instructions above are carefully written to ensure protection against
|
||||
both passive eavesdroppers and active "man-in-the-middle" attackers.
|
||||
- Change the `--slot-name` to the name of the replication slot
|
||||
to be used on the **primary** database. The script will attempt to create the
|
||||
replication slot automatically if it does not exist.
|
||||
- If you're repurposing an old server into a Geo **secondary** node, you'll need to
|
||||
add `--force` to the command line.
|
||||
- When not in a production machine you can disable backup step if you
|
||||
really sure this is what you want by adding `--skip-backup`
|
||||
to increase the timeout, e.g., `--backup-timeout=3600` if you expect the
|
||||
initial replication to take under an hour.
|
||||
- Pass `--sslmode=disable` to skip PostgreSQL TLS authentication altogether
|
||||
(e.g., you know the network path is secure, or you are using a site-to-site
|
||||
VPN). This is **not** safe over the public Internet!
|
||||
- You can read more details about each `sslmode` in the
|
||||
[PostgreSQL documentation][pg-docs-ssl];
|
||||
the instructions above are carefully written to ensure protection against
|
||||
both passive eavesdroppers and active "man-in-the-middle" attackers.
|
||||
- Change the `--slot-name` to the name of the replication slot
|
||||
to be used on the **primary** database. The script will attempt to create the
|
||||
replication slot automatically if it does not exist.
|
||||
- If you're repurposing an old server into a Geo **secondary** node, you'll need to
|
||||
add `--force` to the command line.
|
||||
- When not in a production machine you can disable backup step if you
|
||||
really sure this is what you want by adding `--skip-backup`
|
||||
|
||||
The replication process is now complete.
|
||||
|
||||
|
|
|
|||
|
|
@ -19,10 +19,10 @@ Once removed from the Geo admin page, you must stop and uninstall the **secondar
|
|||
```bash
|
||||
# Stop gitlab and remove its supervision process
|
||||
sudo gitlab-ctl uninstall
|
||||
|
||||
|
||||
# Debian/Ubuntu
|
||||
sudo dpkg --remove gitlab-ee
|
||||
|
||||
|
||||
# Redhat/Centos
|
||||
sudo rpm --erase gitlab-ee
|
||||
```
|
||||
|
|
@ -32,9 +32,9 @@ Once GitLab has been uninstalled from the **secondary** node, the replication sl
|
|||
1. On the **primary** node, start a PostgreSQL console session:
|
||||
|
||||
```bash
|
||||
sudo gitlab-psql
|
||||
sudo gitlab-psql
|
||||
```
|
||||
|
||||
|
||||
NOTE: **Note:**
|
||||
Using `gitlab-rails dbconsole` will not work, because managing replication slots requires superuser permissions.
|
||||
|
||||
|
|
@ -43,9 +43,9 @@ Once GitLab has been uninstalled from the **secondary** node, the replication sl
|
|||
```sql
|
||||
SELECT * FROM pg_replication_slots;
|
||||
```
|
||||
|
||||
|
||||
1. Remove the replication slot for the **secondary** node:
|
||||
|
||||
```sql
|
||||
SELECT pg_drop_replication_slot('<name_of_slot>');
|
||||
```
|
||||
```
|
||||
|
|
|
|||
|
|
@ -162,14 +162,14 @@ contention due to certain workloads.
|
|||
|
||||
- **Status:** Work-in-progress
|
||||
- **Supported Users (approximate):** 10,000
|
||||
- **Related Issues:** [gitlab-com/support/support-team-meta#1513](https://gitlab.com/gitlab-com/support/support-team-meta/issues/1513),
|
||||
- **Related Issues:** [gitlab-com/support/support-team-meta#1513](https://gitlab.com/gitlab-com/support/support-team-meta/issues/1513),
|
||||
[gitlab-org/quality/team-tasks#110](https://gitlab.com/gitlab-org/quality/team-tasks/issues/110)
|
||||
|
||||
The Support and Quality teams are in the process of building and performance testing
|
||||
an environment that will support about 10,000 users. The specifications below
|
||||
are a work-in-progress representation of the work so far. Quality will be
|
||||
certifying this environment in FY20-Q2. The specifications may be adjusted
|
||||
prior to certification based on performance testing.
|
||||
are a work-in-progress representation of the work so far. Quality will be
|
||||
certifying this environment in FY20-Q2. The specifications may be adjusted
|
||||
prior to certification based on performance testing.
|
||||
|
||||
- 3 PostgreSQL - 4 CPU, 8GB RAM per node
|
||||
- 1 PgBouncer - 2 CPU, 4GB RAM
|
||||
|
|
@ -211,4 +211,3 @@ separately:
|
|||
1. [Configure the GitLab application servers](gitlab.md)
|
||||
1. [Configure the load balancers](load_balancer.md)
|
||||
1. [Monitoring node (Prometheus and Grafana)](monitoring_node.md)
|
||||
|
||||
|
|
|
|||
|
|
@ -41,9 +41,9 @@ detail below.
|
|||
- Every session URL that is created has an authorization header that needs to be sent, to establish a `wss` connection.
|
||||
- The session URL is not exposed to the users in any way. GitLab holds all the state internally and proxies accordingly.
|
||||
|
||||
## Enabling and disabling terminal support
|
||||
## Enabling and disabling terminal support
|
||||
|
||||
NOTE: **Note:** AWS Elastic Load Balancers (ELBs) do not support web sockets.
|
||||
NOTE: **Note:** AWS Elastic Load Balancers (ELBs) do not support web sockets.
|
||||
AWS Application Load Balancers (ALBs) must be used if you want web terminals
|
||||
to work. See [AWS Elastic Load Balancing Product Comparison](https://aws.amazon.com/elasticloadbalancing/features/#compare)
|
||||
for more information.
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
## Git housekeeping
|
||||
|
||||
There are few tasks you can run to schedule a git housekeeping to start at the
|
||||
There are few tasks you can run to schedule a git housekeeping to start at the
|
||||
next repository sync in a **Secondary node**:
|
||||
|
||||
### Incremental Repack
|
||||
|
|
@ -23,7 +23,7 @@ sudo -u git -H bundle exec rake geo:git:housekeeping:incremental_repack RAILS_EN
|
|||
|
||||
### Full Repack
|
||||
|
||||
This is equivalent of running `git repack -d -A --pack-kept-objects` on a
|
||||
This is equivalent of running `git repack -d -A --pack-kept-objects` on a
|
||||
_bare_ repository which will optionally, write a reachability bitmap index
|
||||
when this is enabled in GitLab.
|
||||
|
||||
|
|
|
|||
|
|
@ -2,14 +2,14 @@
|
|||
|
||||
>**Note:**
|
||||
>
|
||||
> - [Introduced][ce-3050] in GitLab 8.9.
|
||||
> - Importing will not be possible if the import instance version is lower
|
||||
> than that of the exporter.
|
||||
> - For existing installations, the project import option has to be enabled in
|
||||
> application settings (`/admin/application_settings`) under 'Import sources'.
|
||||
> - The exports are stored in a temporary [shared directory][tmp] and are deleted
|
||||
> every 24 hours by a specific worker.
|
||||
> - ImportExport can use object storage automatically starting from GitLab 11.3
|
||||
> - [Introduced][ce-3050] in GitLab 8.9.
|
||||
> - Importing will not be possible if the import instance version is lower
|
||||
> than that of the exporter.
|
||||
> - For existing installations, the project import option has to be enabled in
|
||||
> application settings (`/admin/application_settings`) under 'Import sources'.
|
||||
> - The exports are stored in a temporary [shared directory][tmp] and are deleted
|
||||
> every 24 hours by a specific worker.
|
||||
> - ImportExport can use object storage automatically starting from GitLab 11.3
|
||||
|
||||
The GitLab Import/Export version can be checked by using:
|
||||
|
||||
|
|
|
|||
|
|
@ -1,17 +1,17 @@
|
|||
# Repository Storage Rake Tasks
|
||||
|
||||
This is a collection of rake tasks you can use to help you list and migrate
|
||||
existing projects and attachments associated with it from Legacy storage to
|
||||
This is a collection of rake tasks you can use to help you list and migrate
|
||||
existing projects and attachments associated with it from Legacy storage to
|
||||
the new Hashed storage type.
|
||||
|
||||
You can read more about the storage types [here][storage-types].
|
||||
|
||||
## Migrate existing projects to Hashed storage
|
||||
|
||||
Before migrating your existing projects, you should
|
||||
Before migrating your existing projects, you should
|
||||
[enable hashed storage][storage-migration] for the new projects as well.
|
||||
|
||||
This task will schedule all your existing projects and attachments associated with it to be migrated to the
|
||||
This task will schedule all your existing projects and attachments associated with it to be migrated to the
|
||||
**Hashed** storage type:
|
||||
|
||||
**Omnibus Installation**
|
||||
|
|
@ -30,15 +30,15 @@ They both also accept a range as environment variable:
|
|||
|
||||
```bash
|
||||
# to migrate any non migrated project from ID 20 to 50.
|
||||
export ID_FROM=20
|
||||
export ID_FROM=20
|
||||
export ID_TO=50
|
||||
```
|
||||
|
||||
You can monitor the progress in the **Admin Area > Monitoring > Background Jobs** page.
|
||||
There is a specific Queue you can watch to see how long it will take to finish:
|
||||
There is a specific Queue you can watch to see how long it will take to finish:
|
||||
`hashed_storage:hashed_storage_project_migrate`
|
||||
|
||||
After it reaches zero, you can confirm every project has been migrated by running the commands bellow.
|
||||
After it reaches zero, you can confirm every project has been migrated by running the commands bellow.
|
||||
If you find it necessary, you can run this migration script again to schedule missing projects.
|
||||
|
||||
Any error or warning will be logged in Sidekiq's log file.
|
||||
|
|
@ -55,7 +55,7 @@ If you need to rollback the storage migration for any reason, you can follow the
|
|||
|
||||
NOTE: **Note:** Hashed Storage will be required in future version of GitLab.
|
||||
|
||||
To prevent new projects from being created in the Hashed storage,
|
||||
To prevent new projects from being created in the Hashed storage,
|
||||
you need to undo the [enable hashed storage][storage-migration] changes.
|
||||
|
||||
This task will schedule all your existing projects and associated attachments to be rolled back to the
|
||||
|
|
@ -77,15 +77,14 @@ Both commands accept a range as environment variable:
|
|||
|
||||
```bash
|
||||
# to rollback any migrated project from ID 20 to 50.
|
||||
export ID_FROM=20
|
||||
export ID_FROM=20
|
||||
export ID_TO=50
|
||||
```
|
||||
|
||||
You can monitor the progress in the **Admin Area > Monitoring > Background Jobs** page.
|
||||
On the **Queues** tab, you can watch the `hashed_storage:hashed_storage_project_rollback` queue to see how long the process will take to finish.
|
||||
|
||||
|
||||
After it reaches zero, you can confirm every project has been rolled back by running the commands bellow.
|
||||
After it reaches zero, you can confirm every project has been rolled back by running the commands bellow.
|
||||
If some projects weren't rolled back, you can run this rollback script again to schedule further rollbacks.
|
||||
|
||||
Any error or warning will be logged in Sidekiq's log file.
|
||||
|
|
@ -106,7 +105,7 @@ sudo gitlab-rake gitlab:storage:legacy_projects
|
|||
sudo -u git -H bundle exec rake gitlab:storage:legacy_projects RAILS_ENV=production
|
||||
```
|
||||
|
||||
------
|
||||
---
|
||||
|
||||
To list projects using **Legacy** storage:
|
||||
|
||||
|
|
@ -139,7 +138,7 @@ sudo gitlab-rake gitlab:storage:hashed_projects
|
|||
sudo -u git -H bundle exec rake gitlab:storage:hashed_projects RAILS_ENV=production
|
||||
```
|
||||
|
||||
------
|
||||
---
|
||||
|
||||
To list projects using **Hashed** storage:
|
||||
|
||||
|
|
@ -171,7 +170,7 @@ sudo gitlab-rake gitlab:storage:legacy_attachments
|
|||
sudo -u git -H bundle exec rake gitlab:storage:legacy_attachments RAILS_ENV=production
|
||||
```
|
||||
|
||||
------
|
||||
---
|
||||
|
||||
To list project attachments using **Legacy** storage:
|
||||
|
||||
|
|
@ -203,7 +202,7 @@ sudo gitlab-rake gitlab:storage:hashed_attachments
|
|||
sudo -u git -H bundle exec rake gitlab:storage:hashed_attachments RAILS_ENV=production
|
||||
```
|
||||
|
||||
------
|
||||
---
|
||||
|
||||
To list project attachments using **Hashed** storage:
|
||||
|
||||
|
|
|
|||
|
|
@ -43,7 +43,7 @@ Example response:
|
|||
"ae1d9fb46aa2b07ee9836d49862ec4e2c46fbbba"
|
||||
],
|
||||
"committed_date": "2018-09-20T09:26:24.000-07:00",
|
||||
"authored_date": "2018-09-20T09:26:24.000-07:00",
|
||||
"authored_date": "2018-09-20T09:26:24.000-07:00",
|
||||
"status": null
|
||||
}
|
||||
```
|
||||
|
|
|
|||
|
|
@ -595,7 +595,7 @@ Example responses
|
|||
|
||||
## User counts
|
||||
|
||||
Get the counts (same as in top right menu) of the currently signed in user.
|
||||
Get the counts (same as in top right menu) of the currently signed in user.
|
||||
|
||||
| Attribute | Type | Description |
|
||||
| --------- | ---- | ----------- |
|
||||
|
|
|
|||
|
|
@ -79,10 +79,10 @@ image: java:8
|
|||
stages:
|
||||
- build
|
||||
- deploy
|
||||
|
||||
|
||||
before_script:
|
||||
- chmod +x mvnw
|
||||
|
||||
|
||||
build:
|
||||
stage: build
|
||||
script: ./mvnw package
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ type: tutorial
|
|||
|
||||
This guide covers basic building instructions for PHP projects.
|
||||
|
||||
Two testing scenarios are covered: using the Docker executor and
|
||||
Two testing scenarios are covered: using the Docker executor and
|
||||
using the Shell executor.
|
||||
|
||||
## Test PHP projects using the Docker executor
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ type: reference
|
|||
|
||||
Interactive web terminals give the user access to a terminal in GitLab for
|
||||
running one-off commands for their CI pipeline. Since this is giving the user
|
||||
shell access to the environment where [GitLab Runner](https://docs.gitlab.com/runner/)
|
||||
shell access to the environment where [GitLab Runner](https://docs.gitlab.com/runner/)
|
||||
is deployed, some [security precautions](../../administration/integration/terminal.md#security) were
|
||||
taken to protect the users.
|
||||
|
||||
|
|
@ -62,4 +62,3 @@ close the terminal window.
|
|||
## Interactive Web Terminals for the Web IDE **(ULTIMATE ONLY)**
|
||||
|
||||
Read the Web IDE docs to learn how to run [Interactive Terminals through the Web IDE](../../user/project/web_ide/index.md).
|
||||
|
||||
|
|
|
|||
|
|
@ -70,7 +70,7 @@ template1=# CREATE USER runner WITH PASSWORD '$password' CREATEDB;
|
|||
```
|
||||
|
||||
*__Note:__ Notice that we created the user with the privilege to be able to
|
||||
create databases (`CREATEDB`). In the following steps we will create a database
|
||||
create databases (`CREATEDB`). In the following steps we will create a database
|
||||
explicitly for that user but having that privilege can be useful if in your
|
||||
testing framework you have tools that drop and create databases.*
|
||||
|
||||
|
|
|
|||
|
|
@ -58,9 +58,9 @@ issue is labeled with a subject label corresponding to your expertise.
|
|||
|
||||
Subject labels are always all-lowercase.
|
||||
|
||||
## Team labels
|
||||
## Team labels
|
||||
|
||||
**Important**: Most of the team labels will be soon deprecated in favor of [Group labels](#group-labels).
|
||||
**Important**: Most of the team labels will be soon deprecated in favor of [Group labels](#group-labels).
|
||||
|
||||
Team labels specify what team is responsible for this issue.
|
||||
Assigning a team label makes sure issues get the attention of the appropriate
|
||||
|
|
@ -98,7 +98,6 @@ indicate if an issue needs backend work, frontend work, or both.
|
|||
Team labels are always capitalized so that they show up as the first label for
|
||||
any issue.
|
||||
|
||||
|
||||
## Stage labels
|
||||
|
||||
Stage labels specify which [DevOps stage][devops-stages] the issue belongs to.
|
||||
|
|
@ -141,43 +140,42 @@ Group labels specify which [groups][structure-groups] the issue belongs to.
|
|||
|
||||
The current group labels are:
|
||||
|
||||
* ~"group::access"
|
||||
* ~"group::measure"
|
||||
* ~"group::source code"
|
||||
* ~"group::knowledge"
|
||||
* ~"group::editor"
|
||||
* ~"group::gitaly"
|
||||
* ~"group::gitter"
|
||||
* ~"group::team planning"
|
||||
* ~"group::enterprise planning"
|
||||
* ~"group::certify"
|
||||
* ~"group::ci and runner"
|
||||
* ~"group::testing"
|
||||
* ~"group::package"
|
||||
* ~"group::progressive delivery"
|
||||
* ~"group::release management"
|
||||
* ~"group::autodevops and kubernetes"
|
||||
* ~"group::serverless and paas"
|
||||
* ~"group::apm"
|
||||
* ~"group::health"
|
||||
* ~"group::static analysis"
|
||||
* ~"group::dynamic analysis"
|
||||
* ~"group::software composition analysis"
|
||||
* ~"group::runtime application security"
|
||||
* ~"group::threat management"
|
||||
* ~"group::application infrastructure security"
|
||||
* ~"group::activation"
|
||||
* ~"group::adoption"
|
||||
* ~"group::upsell"
|
||||
* ~"group::retention"
|
||||
* ~"group::fulfillment"
|
||||
* ~"group::telemetry"
|
||||
* ~"group::distribution"
|
||||
* ~"group::geo"
|
||||
* ~"group::memory"
|
||||
* ~"group::ecosystem"
|
||||
- ~"group::access"
|
||||
- ~"group::measure"
|
||||
- ~"group::source code"
|
||||
- ~"group::knowledge"
|
||||
- ~"group::editor"
|
||||
- ~"group::gitaly"
|
||||
- ~"group::gitter"
|
||||
- ~"group::team planning"
|
||||
- ~"group::enterprise planning"
|
||||
- ~"group::certify"
|
||||
- ~"group::ci and runner"
|
||||
- ~"group::testing"
|
||||
- ~"group::package"
|
||||
- ~"group::progressive delivery"
|
||||
- ~"group::release management"
|
||||
- ~"group::autodevops and kubernetes"
|
||||
- ~"group::serverless and paas"
|
||||
- ~"group::apm"
|
||||
- ~"group::health"
|
||||
- ~"group::static analysis"
|
||||
- ~"group::dynamic analysis"
|
||||
- ~"group::software composition analysis"
|
||||
- ~"group::runtime application security"
|
||||
- ~"group::threat management"
|
||||
- ~"group::application infrastructure security"
|
||||
- ~"group::activation"
|
||||
- ~"group::adoption"
|
||||
- ~"group::upsell"
|
||||
- ~"group::retention"
|
||||
- ~"group::fulfillment"
|
||||
- ~"group::telemetry"
|
||||
- ~"group::distribution"
|
||||
- ~"group::geo"
|
||||
- ~"group::memory"
|
||||
- ~"group::ecosystem"
|
||||
|
||||
|
||||
These labels are [scoped labels](../../user/project/labels.md#scoped-labels-premium)
|
||||
and thus are mutually exclusive.
|
||||
|
||||
|
|
@ -192,15 +190,15 @@ can be applied to a single issue. You can find the groups listed in the
|
|||
|
||||
The current department labels are:
|
||||
|
||||
* ~UX
|
||||
* ~Quality
|
||||
- ~UX
|
||||
- ~Quality
|
||||
|
||||
## Specialization labels
|
||||
|
||||
These labels narrow the [specialization](https://about.gitlab.com/company/team/structure/#specialist) on a unit of work.
|
||||
|
||||
* ~frontend
|
||||
* ~backend
|
||||
- ~frontend
|
||||
- ~backend
|
||||
|
||||
## Release Scoping labels
|
||||
|
||||
|
|
@ -248,9 +246,9 @@ There can be multiple facets of the impact. The below is a guideline.
|
|||
If a bug seems to fall between two severity labels, assign it to the higher-severity label.
|
||||
|
||||
- Example(s) of ~S1
|
||||
- Data corruption/loss.
|
||||
- Data corruption/loss.
|
||||
- Security breach.
|
||||
- Unable to create an issue or merge request.
|
||||
- Unable to create an issue or merge request.
|
||||
- Unable to add a comment or discussion to the issue or merge request.
|
||||
- Example(s) of ~S2
|
||||
- Cannot submit changes through the web IDE but the commandline works.
|
||||
|
|
|
|||
|
|
@ -6,5 +6,5 @@ description: Learn the processes for contributing to GitLab's documentation.
|
|||
|
||||
Documentation workflows at GitLab differ depending on the reason for the change:
|
||||
|
||||
- [Documentation process for feature changes](feature-change-workflow.md) - The documentation is being created or updated as part of the development and release of a new or enhanced feature. This process involves the developer of the feature (who includes new/updated documentation files as part of the same merge request containing the feature's code) and also involves the product manager and technical writer who are listed for the feature's [DevOps stage](https://about.gitlab.com/handbook/product/categories/#devops-stages).
|
||||
- [Documentation process for feature changes](feature-change-workflow.md) - The documentation is being created or updated as part of the development and release of a new or enhanced feature. This process involves the developer of the feature (who includes new/updated documentation files as part of the same merge request containing the feature's code) and also involves the product manager and technical writer who are listed for the feature's [DevOps stage](https://about.gitlab.com/handbook/product/categories/#devops-stages).
|
||||
- [Documentation improvement workflow](improvement-workflow.md) - All documentation additions not associated with a feature release. Documentation is being created or updated to improve accuracy, completeness, ease of use, or any reason other than a feature change. Anyone (and everyone) can contribute a merge request for this type of change at any time.
|
||||
|
|
|
|||
|
|
@ -106,32 +106,31 @@ are very appreciative of the work done by translators and proofreaders!
|
|||
1. Contribute translations to GitLab. See instructions for
|
||||
[translating GitLab](translation.md).
|
||||
|
||||
Translating GitLab is a community effort that requires team work and
|
||||
attention to detail. Proofreaders play an important role helping new
|
||||
contributors, and ensuring the consistency and quality of translations.
|
||||
Your conduct and contributions as a translator should reflect this before
|
||||
requesting to be a proofreader.
|
||||
Translating GitLab is a community effort that requires team work and
|
||||
attention to detail. Proofreaders play an important role helping new
|
||||
contributors, and ensuring the consistency and quality of translations.
|
||||
Your conduct and contributions as a translator should reflect this before
|
||||
requesting to be a proofreader.
|
||||
|
||||
1. Request proofreader permissions by opening a merge request to add yourself
|
||||
to the list of proofreaders.
|
||||
|
||||
Open the [proofreader.md source file][proofreader-src] and click **Edit**.
|
||||
Open the [proofreader.md source file][proofreader-src] and click **Edit**.
|
||||
|
||||
Add your language in alphabetical order, and add yourself to the list
|
||||
including:
|
||||
- name
|
||||
- link to your GitLab profile
|
||||
- link to your CrowdIn profile
|
||||
Add your language in alphabetical order, and add yourself to the list
|
||||
including:
|
||||
- name
|
||||
- link to your GitLab profile
|
||||
- link to your CrowdIn profile
|
||||
|
||||
In the merge request description, please include links to any projects you
|
||||
have previously translated.
|
||||
In the merge request description, please include links to any projects you
|
||||
have previously translated.
|
||||
|
||||
1. Your request to become a proofreader will be considered on the merits of
|
||||
your previous translations by [GitLab team members](https://about.gitlab.com/team/)
|
||||
or [Core team members](https://about.gitlab.com/core-team/) who are fluent in
|
||||
the language or current proofreaders.
|
||||
- When a request is made for the first proofreader for a language and there are no [GitLab team members](https://about.gitlab.com/team/)
|
||||
or [Core team members](https://about.gitlab.com/core-team/) who speak the language, we will request links to previous translation work in other communities or projects.
|
||||
|
||||
or [Core team members](https://about.gitlab.com/core-team/) who speak the language, we will request links to previous translation work in other communities or projects.
|
||||
|
||||
[proofreader-src]: https://gitlab.com/gitlab-org/gitlab-ce/blob/master/doc/development/i18n/proofreader.md
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ Our code is automatically formatted with [Prettier](https://prettier.io) to foll
|
|||
|
||||
## Editor
|
||||
|
||||
The easiest way to include prettier in your workflow is by setting up your preferred editor (all major editors are supported) accordingly. We suggest setting up prettier to run automatically when each file is saved. Find [here](https://prettier.io/docs/en/editors.html) the best way to set it up in your preferred editor.
|
||||
The easiest way to include prettier in your workflow is by setting up your preferred editor (all major editors are supported) accordingly. We suggest setting up prettier to run automatically when each file is saved. Find [here](https://prettier.io/docs/en/editors.html) the best way to set it up in your preferred editor.
|
||||
|
||||
Please take care that you only let Prettier format the same file types as the global Yarn script does (.js, .vue, and .scss). In VSCode by example you can easily exclude file formats in your settings file:
|
||||
|
||||
|
|
@ -28,6 +28,7 @@ Updates all currently staged files (based on `git diff`) with Prettier and saves
|
|||
```
|
||||
yarn prettier-staged
|
||||
```
|
||||
|
||||
Checks all currently staged files (based on `git diff`) with Prettier and log which files would need manual updating to the console.
|
||||
|
||||
```
|
||||
|
|
|
|||
|
|
@ -148,7 +148,7 @@ Once you decided where to put [test environment orchestration scenarios] and
|
|||
the [GitLab QA orchestrator README][gitlab-qa-readme], and [the already existing
|
||||
instance-level scenarios][instance-level scenarios].
|
||||
|
||||
Continued reading:
|
||||
Continued reading:
|
||||
|
||||
- [Quick Start Guide](quick_start_guide.md)
|
||||
- [Style Guide](style_guide.md)
|
||||
|
|
|
|||
|
|
@ -63,17 +63,17 @@ We follow a simple formula roughly based on hungarian notation.
|
|||
- `_checkbox`
|
||||
- `_radio`
|
||||
- `_content`
|
||||
|
||||
|
||||
*Note: This list is a work in progress. This list will eventually be the end-all enumeration of all available types.
|
||||
I.e., any element that does not end with something in this list is bad form.*
|
||||
|
||||
|
||||
#### Examples
|
||||
|
||||
**Good**
|
||||
|
||||
```ruby
|
||||
view '...' do
|
||||
element :edit_button
|
||||
element :edit_button
|
||||
element :notes_tab
|
||||
element :squash_checkbox
|
||||
element :username_field
|
||||
|
|
@ -84,15 +84,15 @@ end
|
|||
**Bad**
|
||||
|
||||
```ruby
|
||||
view '...' do
|
||||
view '...' do
|
||||
# `_confirmation` should be `_field`. what sort of confirmation? a checkbox confirmation? no real way to disambiguate.
|
||||
# an appropriate replacement would be `element :password_confirmation_field`
|
||||
element :password_confirmation
|
||||
|
||||
# `clone_options` is too vague. If it's a dropdown menu, it should be `clone_dropdown`.
|
||||
# `clone_options` is too vague. If it's a dropdown menu, it should be `clone_dropdown`.
|
||||
# If it's a checkbox, it should be `clone_checkbox`
|
||||
element :clone_options
|
||||
|
||||
|
||||
# how is this url being displayed? is it a textbox? a simple span?
|
||||
element :ssh_clone_url
|
||||
end
|
||||
|
|
|
|||
|
|
@ -501,17 +501,17 @@ The following are examples of tests that work for both Karma and Jest:
|
|||
it('makes a request', () => {
|
||||
const responseBody = getJSONFixture('some/fixture.json'); // loads spec/javascripts/fixtures/some/fixture.json
|
||||
axiosMock.onGet(endpoint).reply(200, responseBody);
|
||||
|
||||
|
||||
myButton.click();
|
||||
|
||||
|
||||
// ...
|
||||
});
|
||||
|
||||
it('uses some HTML element', () => {
|
||||
loadFixtures('some/page.html'); // loads spec/javascripts/fixtures/some/page.html and adds it to the DOM
|
||||
|
||||
|
||||
const element = document.getElementById('#my-id');
|
||||
|
||||
|
||||
// ...
|
||||
});
|
||||
```
|
||||
|
|
|
|||
Loading…
Reference in a new issue