Skip to content
Snippets Groups Projects
Commit df4a4fe69d8f authored by Marcel Amirault's avatar Marcel Amirault
Browse files

Merge branch 'eread/restructure-markdownlint-configuration-docs' into 'master'

Restructure markdownlint configuration

See merge request gitlab-org/omnibus-gitlab!5435
No related branches found
No related tags found
3 merge requests!51Validate shift of Heptapod 0.25 to oldstable series,!47Making Heptapod 0.25 the new stable in Omnibus,!45GitLab 14.2
......@@ -3,6 +3,6 @@
# As described in https://docs.gitlab.com/ee/user/project/code_owners.html
[Documentation]
.markdownlint.json @marcel.amirault @eread @aqualls @cnorris
.markdownlint.yml @marcel.amirault @eread @aqualls @cnorris
/doc/.vale/ @marcel.amirault @eread @aqualls @cnorris
/doc/ @axil
{
"default": true,
"first-header-h1": true,
"header-style": {
"style": "atx"
},
"ul-style": {
"style": "dash"
},
"no-trailing-spaces": false,
"line-length": false,
"no-duplicate-header": {
"allow_different_nesting": true
},
"no-trailing-punctuation": {
"punctuation": ".,;:!。,;:!?"
},
"ol-prefix": {
"style": "one"
},
"no-inline-html": false,
"hr-style": {
"style": "---"
},
"no-emphasis-as-heading": false,
"first-line-h1": false,
"code-block-style": {
"style": "fenced"
},
"proper-names": {
"names": [
"Akismet",
"Alertmanager",
"API",
"Asana",
"Auth0",
"Authentiq",
"Azure",
"Bamboo",
"Bitbucket",
"Bugzilla",
"CAS",
"CentOS",
"Consul",
"Debian",
"DevOps",
"Docker",
"DockerSlim",
"Elasticsearch",
"Facebook",
"fastlane",
"fluent-plugin-redis-slowlog",
"GDK",
"Geo",
"Git LFS",
"git-annex",
"Git",
"Gitaly",
"GitHub",
"GitLab Geo",
"GitLab Monitor",
"GitLab Operator",
"GitLab Pages",
"GitLab Rails",
"GitLab Runner",
"GitLab Shell",
"GitLab Workhorse",
"GitLab",
"Gitleaks",
"Gmail",
"Google",
"Grafana",
"Gzip",
"Helm",
"HipChat",
"ID",
"Ingress",
"jasmine-jquery",
"JavaScript",
"Jaeger",
"Jenkins",
"Jira",
"Jira Cloud",
"Jira Server",
"jQuery",
"JSON",
"JupyterHub",
"Karma",
"Kerberos",
"Knative",
"Kubernetes",
"LDAP",
"Let's Encrypt",
"Markdown",
"markdownlint",
"Mattermost",
"Microsoft",
"Minikube",
"MinIO",
"ModSecurity",
"NGINX Ingress",
"NGINX",
"OAuth",
"OAuth 2",
"OmniAuth",
"Omnibus GitLab",
"OpenID",
"OpenShift",
"PgBouncer",
"PostgreSQL",
"Praefect",
"Prometheus",
"Puma",
"puma-worker-killer",
"Python",
"Rake",
"Redis",
"Redmine",
"reCAPTCHA",
"Ruby",
"runit",
"Salesforce",
"SAML",
"Sentry",
"Sidekiq",
"Shibboleth",
"Slack",
"SMTP",
"SpotBugs",
"SSH",
"Tiller",
"TOML",
"Trello",
"Trello Power-Ups",
"TypeScript",
"Twitter",
"Ubuntu",
"Ultra Auth",
"Unicorn",
"unicorn-worker-killer",
"URL",
"WebdriverIO",
"YAML",
"YouTrack"
],
"code_blocks": false
}
}
# Base Markdownlint configuration
# Extended Markdownlint configuration in doc/.markdownlint/
"default":
"first-header-h1":
"header-style":
"style": "atx"
"ul-style":
"style": "dash"
"no-trailing-spaces": false
"line-length": false
"no-duplicate-header":
"allow_different_nesting": true
"no-trailing-punctuation":
"punctuation": ".,;:!。,;:!?"
"ol-prefix":
"style": "one"
"no-inline-html": false
"hr-style":
"style": "---"
"no-emphasis-as-heading": false
"first-line-h1": false
"code-block-style":
"style": "fenced"
"proper-names":
"names": [
"Akismet",
"Alertmanager",
"API",
"Asana",
"Auth0",
"Authentiq",
"Azure",
"Bamboo",
"Bitbucket",
"Bugzilla",
"CAS",
"CentOS",
"Consul",
"Debian",
"DevOps",
"Docker",
"DockerSlim",
"Elasticsearch",
"Facebook",
"fastlane",
"fluent-plugin-redis-slowlog",
"GDK",
"Geo",
"Git LFS",
"git-annex",
"Git",
"Gitaly",
"GitHub",
"GitLab Geo",
"GitLab Monitor",
"GitLab Operator",
"GitLab Pages",
"GitLab Rails",
"GitLab Runner",
"GitLab Shell",
"GitLab Workhorse",
"GitLab",
"Gitleaks",
"Gmail",
"Google",
"Grafana",
"Gzip",
"Helm",
"HipChat",
"ID",
"Ingress",
"jasmine-jquery",
"JavaScript",
"Jaeger",
"Jenkins",
"Jira",
"Jira Cloud",
"Jira Server",
"jQuery",
"JSON",
"JupyterHub",
"Karma",
"Kerberos",
"Knative",
"Kubernetes",
"LDAP",
"Let's Encrypt",
"Markdown",
"markdownlint",
"Mattermost",
"Microsoft",
"Minikube",
"MinIO",
"ModSecurity",
"NGINX Ingress",
"NGINX",
"OAuth",
"OAuth 2",
"OmniAuth",
"Omnibus GitLab",
"OpenID",
"OpenShift",
"PgBouncer",
"PostgreSQL",
"Praefect",
"Prometheus",
"Puma",
"puma-worker-killer",
"Python",
"Rake",
"Redis",
"Redmine",
"reCAPTCHA",
"Ruby",
"runit",
"Salesforce",
"SAML",
"Sentry",
"Sidekiq",
"Shibboleth",
"Slack",
"SMTP",
"SpotBugs",
"SSH",
"Tiller",
"TOML",
"Trello",
"Trello Power-Ups",
"TypeScript",
"Twitter",
"Ubuntu",
"Ultra Auth",
"Unicorn",
"unicorn-worker-killer",
"URL",
"WebdriverIO",
"YAML",
"YouTrack"
]
"code_blocks": false
# Extended Markdown configuration to enforce no-trailing-spaces rule
"extends": "../../.markdownlint.yml"
"no-trailing-spaces": true
......@@ -9,9 +9,9 @@
Upgrading from non-Omnibus installations has not been tested by GitLab.com.
Please be advised that you lose your settings in files such as `gitlab.yml`,
`puma.rb` and `smtp_settings.rb`. You will have to
`puma.rb` and `smtp_settings.rb`. You need to
[configure those settings in `/etc/gitlab/gitlab.rb`](../index.md#configuring).
Before starting the migration, ensure that you are moving to **exactly the same version** of GitLab.
To convert your installation to Omnibus:
......@@ -13,9 +13,9 @@
[configure those settings in `/etc/gitlab/gitlab.rb`](../index.md#configuring).
Before starting the migration, ensure that you are moving to **exactly the same version** of GitLab.
To convert your installation to Omnibus:
1. If your current GitLab installation uses MySQL, you will first need to migrate
1. If your current GitLab installation uses MySQL, you first need to migrate
your data to PostgreSQL, because starting with GitLab 12.1, PostgreSQL is the
only supported database management system. If you already use PostgreSQL, skip this step.
1. Verify the [PostgreSQL requirements and supported versions](https://docs.gitlab.com/ee/install/requirements.html#postgresql-requirements),
......@@ -38,7 +38,7 @@
sudo gitlab-backup restore BACKUP=<FILE_NAME>
```
The restore will take a few minutes depending on the size of you database and Git data.
The restore takes a few minutes depending on the size of you database and Git data.
1. Configure the new installation as in Omnibus GitLab all settings are stored in
`/etc/gitlab/gitlab.rb`. Individual settings need to be manually moved from
......@@ -47,7 +47,7 @@
for all available options.
1. To finalize the configuration process, copy the secrets from the old installation
to the new one. GitLab uses secrets to multiple purposes, like database encryption,
session encryption, etc. In Omnibus GitLab all secrets are placed in a single
session encryption, and so on. In Omnibus GitLab all secrets are placed in a single
file `/etc/gitlab/gitlab-secrets.json`, whereas in source installations, the
secrets are placed in multiple files:
1. First, you need to restore secrets related to Rails. Copy the values of
......
......@@ -240,7 +240,7 @@
# Lint prose
- vale --minAlertLevel error doc
# Lint Markdown
- markdownlint --config .markdownlint.json 'doc/**/*.md'
- markdownlint --config .markdownlint.yml 'doc/**/*.md'
except:
refs:
- /./@gitlab/omnibus-gitlab
......
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