Skip to content
Snippets Groups Projects
Commit c1d314ea authored by Achilleas Pipinellis's avatar Achilleas Pipinellis
Browse files

Merge branch 'docs-dollar-signs' into 'master'

Start linting for unneeded dollar signs

See merge request gitlab-org/gitlab-ce!32803
parents a52dbbbc 78d09e3e
No related branches found
No related tags found
No related merge requests found
Loading
Loading
@@ -8,7 +8,6 @@
"style": "dash"
},
"line-length": false,
"commands-show-output": false,
"no-duplicate-header": {
"allow_different_nesting": true
},
Loading
Loading
Loading
Loading
@@ -99,7 +99,7 @@ automatically.
Its simplest usage is to provide the value for `title`:
 
```text
$ bin/changelog 'Hey DZ, I added a feature to GitLab!'
bin/changelog 'Hey DZ, I added a feature to GitLab!'
```
 
At this point the script would ask you to select the category of the change (mapped to the `type` field in the entry):
Loading
Loading
Loading
Loading
@@ -27,7 +27,7 @@ no overhead at all.
To enable `GITLAB_TRACING`, a valid _"configuration-string"_ value should be set, with a URL-like
form:
 
```console
```sh
GITLAB_TRACING=opentracing://<driver>?<param_name>=<param_value>&<param_name_2>=<param_value_2>
```
 
Loading
Loading
@@ -90,7 +90,7 @@ documentation](https://www.jaegertracing.io/docs/1.9/getting-started/).
If you have Docker available, the easier approach to running the Jaeger all-in-one is through
Docker, using the following command:
 
```console
```sh
$ docker run \
--rm \
-e COLLECTOR_ZIPKIN_HTTP_PORT=9411 \
Loading
Loading
@@ -121,8 +121,8 @@ appropriate configuration string.
 
**TL;DR:** If you are running everything on the same host, use the following value:
 
```console
$ export GITLAB_TRACING="opentracing://jaeger?http_endpoint=http%3A%2F%2Flocalhost%3A14268%2Fapi%2Ftraces&sampler=const&sampler_param=1"
```sh
export GITLAB_TRACING="opentracing://jaeger?http_endpoint=http%3A%2F%2Flocalhost%3A14268%2Fapi%2Ftraces&sampler=const&sampler_param=1"
```
 
This configuration string uses the Jaeger driver `opentracing://jaeger` with the following options:
Loading
Loading
@@ -152,7 +152,7 @@ application.
 
When `GITLAB_TRACING` is configured properly, the application will log this on startup:
 
```console
```sh
13:41:53 gitlab-workhorse.1 | 2019/02/12 13:41:53 Tracing enabled
...
13:41:54 gitaly.1 | 2019/02/12 13:41:54 Tracing enabled
Loading
Loading
@@ -161,7 +161,7 @@ When `GITLAB_TRACING` is configured properly, the application will log this on s
 
If `GITLAB_TRACING` is not configured correctly, this will also be logged:
 
```console
```sh
13:43:45 gitaly.1 | 2019/02/12 13:43:45 skipping tracing configuration step: tracer: unable to load driver mytracer
```
 
Loading
Loading
Loading
Loading
@@ -81,9 +81,7 @@ If you're using Pry you can use the `$` command to display the source code of a
method (along with its source location), this is easier than running the above
Ruby code. In case of the above snippet you'd run the following:
 
```
$ Banzai::Renderer.render
```
- `$ Banzai::Renderer.render`
 
This will print out something along the lines of:
 
Loading
Loading
Loading
Loading
@@ -123,7 +123,7 @@ Keeping that in mind, to create a profile, identify (or create) a spec that
exercises the troublesome code path, then run it using the `bin/rspec-stackprof`
helper, e.g.:
 
```
```sh
$ LIMIT=10 bin/rspec-stackprof spec/policies/project_policy_spec.rb
8/8 |====== 100 ======>| Time: 00:00:18
 
Loading
Loading
@@ -157,22 +157,22 @@ it calls, were being executed.
 
To create a graphical view of the call stack:
 
```shell
$ stackprof tmp/project_policy_spec.rb.dump --graphviz > project_policy_spec.dot
$ dot -Tsvg project_policy_spec.dot > project_policy_spec.svg
```sh
stackprof tmp/project_policy_spec.rb.dump --graphviz > project_policy_spec.dot
dot -Tsvg project_policy_spec.dot > project_policy_spec.svg
```
 
To load the profile in [kcachegrind](https://kcachegrind.github.io/):
 
```
$ stackprof tmp/project_policy_spec.dump --callgrind > project_policy_spec.callgrind
$ kcachegrind project_policy_spec.callgrind # Linux
$ qcachegrind project_policy_spec.callgrind # Mac
```sh
stackprof tmp/project_policy_spec.dump --callgrind > project_policy_spec.callgrind
kcachegrind project_policy_spec.callgrind # Linux
qcachegrind project_policy_spec.callgrind # Mac
```
 
It may be useful to zoom in on a specific method, e.g.:
 
```
```sh
$ stackprof tmp/project_policy_spec.rb.dump --method warm_asset_cache
TestEnv#warm_asset_cache (/Users/lupine/dev/gitlab.com/gitlab-org/gitlab-development-kit/gitlab/spec/support/test_env.rb:164)
samples: 0 self (0.0%) / 6288 total (36.9%)
Loading
Loading
@@ -225,9 +225,9 @@ may have changed over time.
 
To activate profiling in your local environment, run the following:
 
```
$ export RSPEC_PROFILING=yes
$ rake rspec_profiling:install
```sh
export RSPEC_PROFILING=yes
rake rspec_profiling:install
```
 
This creates an SQLite3 database in `tmp/rspec_profiling`, into which statistics
Loading
Loading
@@ -237,7 +237,7 @@ variable set.
Ad-hoc investigation of the collected results can be performed in an interactive
shell:
 
```
```sh
$ rake rspec_profiling:console
irb(main):001:0> results.count
=> 231
Loading
Loading
Loading
Loading
@@ -47,14 +47,14 @@ to avoid getting this error, you need to remove all instances of the
 
**Omnibus Installation**
 
```
$ sudo gitlab-rails runner "Service.where(type: ['JenkinsService', 'JenkinsDeprecatedService', 'GithubService']).delete_all"
```sh
sudo gitlab-rails runner "Service.where(type: ['JenkinsService', 'JenkinsDeprecatedService', 'GithubService']).delete_all"
```
 
**Source Installation**
 
```
$ bundle exec rails runner "Service.where(type: ['JenkinsService', 'JenkinsDeprecatedService', 'GithubService']).delete_all" production
```sh
bundle exec rails runner "Service.where(type: ['JenkinsService', 'JenkinsDeprecatedService', 'GithubService']).delete_all" production
```
 
### Variables environment scopes
Loading
Loading
@@ -89,10 +89,10 @@ To downgrade a source installation, you need to replace the current remote of
your GitLab installation with the Community Edition's remote, fetch the latest
changes, and checkout the latest stable branch:
 
```
$ git remote set-url origin git@gitlab.com:gitlab-org/gitlab-ce.git
$ git fetch --all
$ git checkout 8-x-stable
```sh
git remote set-url origin git@gitlab.com:gitlab-org/gitlab-ce.git
git fetch --all
git checkout 8-x-stable
```
 
Remember to follow the correct [update guides](../update/README.md) to make
Loading
Loading
Loading
Loading
@@ -225,7 +225,7 @@ First, we will create a new project to host our application. You can do this
either by running the CLI client:
 
```bash
$ oc new-project gitlab
oc new-project gitlab
```
 
or by using the web interface:
Loading
Loading
Loading
Loading
@@ -158,7 +158,7 @@ For installation from source:
You will also need to disable Git SSL verification on the server hosting GitLab.
 
```
$ git config --global http.sslVerify false
git config --global http.sslVerify false
```
 
For the changes to take effect, [reconfigure GitLab] if you installed
Loading
Loading
Loading
Loading
@@ -42,17 +42,17 @@ If you are using an installation from source, replace `/var/opt/gitlab/` with `/
 
#### Omnibus Installation
 
```
$ sudo gitlab-rake gitlab:import:repos['/var/opt/gitlab/git-data/repository-import-<date>']
```sh
sudo gitlab-rake gitlab:import:repos['/var/opt/gitlab/git-data/repository-import-<date>']
```
 
#### Installation from source
 
Before running this command you need to change the directory to where your GitLab installation is located:
 
```
$ cd /home/git/gitlab
$ sudo -u git -H bundle exec rake gitlab:import:repos['/var/opt/gitlab/git-data/repository-import-<date>'] RAILS_ENV=production
```sh
cd /home/git/gitlab
sudo -u git -H bundle exec rake gitlab:import:repos['/var/opt/gitlab/git-data/repository-import-<date>'] RAILS_ENV=production
```
 
#### Example output
Loading
Loading
Loading
Loading
@@ -53,9 +53,9 @@ write in the `.gitlab-ci.yml` the script you want to run so
GitLab Runner will do it for you. It looks more complicated than it
is. What you need to tell the Runner:
 
```
$ gem install jekyll
$ jekyll build
```sh
gem install jekyll
jekyll build
```
 
### Script
Loading
Loading
Loading
Loading
@@ -134,13 +134,13 @@ There are two ways to manually do the same thing as automatic uploading (describ
 
**Option 1: rake task**
 
```
$ rake gitlab:lfs:migrate
```sh
rake gitlab:lfs:migrate
```
 
**Option 2: rails console**
 
```
```sh
$ sudo gitlab-rails console # Login to rails console
 
> # Upload LFS files manually
Loading
Loading
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment