Commit d5d91d29 authored by Thong Kuah's avatar Thong Kuah

Merge branch 'revert-bafd3ab4' into 'master'

Revert "Merge branch 'eread/restore-docs-metadata-check' into 'master'"

See merge request gitlab-org/gitlab!59723
parents e59cd3af 2bf707c7
...@@ -12,7 +12,7 @@ To enable the Atlassian OmniAuth provider for passwordless authentication you mu ...@@ -12,7 +12,7 @@ To enable the Atlassian OmniAuth provider for passwordless authentication you mu
## Atlassian application registration ## Atlassian application registration
1. Go to <https://developer.atlassian.com/apps/> and sign-in with the Atlassian 1. Go to <https://developer.atlassian.com/apps/> and sign-in with the Atlassian
account to administer the application with. account that will administer the application.
1. Click **Create a new app**. 1. Click **Create a new app**.
......
...@@ -9,7 +9,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -9,7 +9,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w
To enable the Authentiq OmniAuth provider for passwordless authentication you must register an application with Authentiq. To enable the Authentiq OmniAuth provider for passwordless authentication you must register an application with Authentiq.
Authentiq generates a Client ID and the accompanying Client Secret for you to use. Authentiq will generate a Client ID and the accompanying Client Secret for you to use.
1. Get your Client credentials (Client ID and Client Secret) at [Authentiq](https://www.authentiq.com/developers). 1. Get your Client credentials (Client ID and Client Secret) at [Authentiq](https://www.authentiq.com/developers).
......
...@@ -62,7 +62,6 @@ Before you push your changes, Lefthook automatically runs the following checks: ...@@ -62,7 +62,6 @@ Before you push your changes, Lefthook automatically runs the following checks:
- SCSS lint: Run `yarn lint:stylelint` checks (with the [`.stylelintrc`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/.stylelintrc) configuration) on the modified `*.scss{,.css}` files. Tags: `stylesheet`, `css`, `style`. - SCSS lint: Run `yarn lint:stylelint` checks (with the [`.stylelintrc`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/.stylelintrc) configuration) on the modified `*.scss{,.css}` files. Tags: `stylesheet`, `css`, `style`.
- RuboCop: Run `bundle exec rubocop` checks (with the [`.rubocop.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/.rubocop.yml) configuration) on the modified `*.rb` files. Tags: `backend`, `style`. - RuboCop: Run `bundle exec rubocop` checks (with the [`.rubocop.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/.rubocop.yml) configuration) on the modified `*.rb` files. Tags: `backend`, `style`.
- Vale: Run `vale` checks (with the [`.vale.ini`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/.vale.ini) configuration) on the modified `*.md` files. Tags: `documentation`, `style`. - Vale: Run `vale` checks (with the [`.vale.ini`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/.vale.ini) configuration) on the modified `*.md` files. Tags: `documentation`, `style`.
- Documentation metadata: Run checks for the absence of [documentation metadata](../documentation/index.md#metadata).
In addition to the default configuration, you can define a [local configuration](https://github.com/Arkweid/lefthook/blob/master/docs/full_guide.md#local-config). In addition to the default configuration, you can define a [local configuration](https://github.com/Arkweid/lefthook/blob/master/docs/full_guide.md#local-config).
......
...@@ -38,8 +38,3 @@ pre-push: ...@@ -38,8 +38,3 @@ pre-push:
files: git diff --name-only --diff-filter=d $(git merge-base origin/master HEAD)..HEAD files: git diff --name-only --diff-filter=d $(git merge-base origin/master HEAD)..HEAD
glob: 'doc/*.md' glob: 'doc/*.md'
run: if command -v vale 2> /dev/null; then vale --config .vale.ini --minAlertLevel error {files}; else echo "Vale not found. Install Vale"; fi run: if command -v vale 2> /dev/null; then vale --config .vale.ini --minAlertLevel error {files}; else echo "Vale not found. Install Vale"; fi
docs-metadata: # https://docs.gitlab.com/ee/development/documentation/#metadata
tags: documentation style
files: git diff --name-only --diff-filter=d $(git merge-base origin/master HEAD)..HEAD
glob: '*.md'
run: scripts/lint-docs-metadata.sh "{files}"
...@@ -19,7 +19,6 @@ then ...@@ -19,7 +19,6 @@ then
fi fi
# Documentation pages need front matter for tracking purposes. # Documentation pages need front matter for tracking purposes.
# See also lint-docs-metadata.sh
echo '=> Checking documentation for front matter...' echo '=> Checking documentation for front matter...'
echo echo
no_frontmatter=$(find doc -name "*.md" -exec head -n1 {} \; | grep -v --count -- ---) no_frontmatter=$(find doc -name "*.md" -exec head -n1 {} \; | grep -v --count -- ---)
......
#!/usr/bin/env bash
# Used in `lefthook.yml`
(( counter=0 ))
for file in $1
do
if [ "$(head -n1 "$file")" != "---" ]
then
printf "%sDocumentation metadata missing in %s%s\n" "$(tput setaf 1)" "$file" "$(tput sgr0)"
(( counter++ ))
else
printf "Documentation metadata found in %s.\n" "$file"
fi
done
if [ "$counter" -gt 0 ]
then
printf "\n%sDocumentation metadata is missing in changed documentation files.%s For more information, see https://docs.gitlab.com/ee/development/documentation/#metadata.\n" "$(tput setaf 1)" "$(tput sgr0)"
false
else
printf "\n%sDocumentation metadata found in all changed documentation files.%s\n" "$(tput setaf 2)" "$(tput sgr0)"
true
fi
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment