Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitlab-docs.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarcel Amirault <mamirault@gitlab.com>2021-10-19 19:12:44 +0300
committerSuzanne Selhorn <sselhorn@gitlab.com>2021-10-19 19:12:44 +0300
commitd630977db49f570ffa69811aca920134552c730f (patch)
treed03358aa321317235f1327d4813757b6f1c057ea
parent88c88fb77db533bf78b4f4b4ac1712173e756b0a (diff)
Clarify redirects raketask and jq details
-rw-r--r--doc/raketasks.md20
1 files changed, 17 insertions, 3 deletions
diff --git a/doc/raketasks.md b/doc/raketasks.md
index 2d581564..b6405716 100644
--- a/doc/raketasks.md
+++ b/doc/raketasks.md
@@ -28,9 +28,23 @@ The `docs:clean_redirects` rake task automates the removal of the expired redire
which is part of the monthly [scheduled TW tasks](https://about.gitlab.com/handbook/engineering/ux/technical-writing/#regularly-scheduled-tasks)
as seen in the "Local tasks" section of the [issue template](https://gitlab.com/gitlab-org/technical-writing/-/blob/main/.gitlab/issue_templates/tw-monthly-tasks.md):
-```shell
-bundle exec rake docs:clean_redirects
-```
+1. Make sure you have `jq` installed. On macOS:
+ - Use `brew list` and see if `jq` is in the list.
+ - If it is not installed, run `brew install jq`.
+
+1. Optional. Run the rake task locally in your `gitlab-docs` directory in a "dry run" mode
+ that does not create any MRs:
+
+ ```shell
+ SKIP_MR=true bundle exec rake docs:clean_redirects
+ ```
+
+1. Run the rake task locally in your `gitlab-docs` directory. This command creates up to five
+ merge requests:
+
+ ```shell
+ bundle exec rake docs:clean_redirects
+ ```
The task: