Proposes a subheading-length rule
What does this MR do?
Based on this Slack thread, proposes a warning-level test that captures subheadings longer than 70 characters.
We specify 70 is the maximum length for subheadings in troubleshooting sections, but have we ever specified it for all subheadings?
Findings: 356 new warnings
Results of the command vale --no-wrap --filter='.Name=="gitlab.SubheadingLength"' doc/**/*.md
356 new warnings
doc/administration/auth/crowd.md
90:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/administration/auth/ldap/ldap-troubleshooting.md
687:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
953:6 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/administration/auth/smartcard.md
58:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/administration/backup_restore/restore_gitlab.md
55:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
437:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
483:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/administration/backup_restore/troubleshooting_backup_gitlab.md
526:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/administration/geo/disaster_recovery/index.md
349:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/administration/geo/replication/disable_geo.md
89:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/administration/geo/replication/faq.md
72:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/administration/geo/replication/multiple_servers.md
123:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
194:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
310:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/administration/geo/replication/security_review.md
37:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
45:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
99:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
131:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
146:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
150:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
154:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
164:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
169:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
174:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
180:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
184:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
192:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
235:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
250:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
262:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
291:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/administration/geo/replication/troubleshooting/index.md
381:7 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
547:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
563:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
572:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
579:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
598:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
638:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
677:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
686:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
872:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
955:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
1240:7 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
1369:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
1374:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
1499:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
1523:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
1548:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
1565:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
1586:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
1591:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
1672:6 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/administration/geo/setup/database.md
677:7 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/administration/geo/setup/two_single_node_external_services.md
7:3 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/administration/gitaly/index.md
90:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/administration/gitaly/troubleshooting.md
10:1 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
230:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
313:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
349:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
392:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
443:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/administration/gitaly/troubleshooting_gitaly_cluster.md
10:1 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/administration/job_artifacts_troubleshooting.md
189:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
327:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
416:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
428:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/administration/logs/log_parsing.md
71:6 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
135:6 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
151:6 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
253:6 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/administration/object_storage.md
50:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
149:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/administration/operations/moving_repositories.md
239:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/administration/package_information/omnibus_packages.md
79:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/administration/packages/container_registry.md
1310:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/administration/pages/troubleshooting.md
10:1 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
49:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
152:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
166:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
288:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
314:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/administration/postgresql/replication_and_failover_troubleshooting.md
7:3 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
53:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
254:1 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/administration/raketasks/project_import_export.md
10:1 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
131:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/administration/redis/replication_and_failover.md
528:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/administration/redis/replication_and_failover_external.md
278:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/administration/reference_architectures/10k_users.md
2239:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/administration/reference_architectures/25k_users.md
2245:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/administration/reference_architectures/2k_users.md
1085:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/administration/reference_architectures/3k_users.md
2227:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/administration/reference_architectures/50k_users.md
2259:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/administration/reference_architectures/5k_users.md
2202:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/administration/repository_checks.md
105:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/administration/settings/continuous_integration.md
136:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/administration/settings/visibility_and_access_controls.md
268:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/administration/sidekiq/extra_sidekiq_processes.md
111:6 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/administration/sidekiq/index.md
16:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/administration/sidekiq/sidekiq_troubleshooting.md
591:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/administration/user_settings.md
15:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/api/bulk_imports.md
289:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/api/geo_nodes.md
976:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/api/geo_sites.md
975:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/api/groups.md
975:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/api/members.md
115:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
266:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/api/personal_access_tokens.md
392:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/api/users.md
2290:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/architecture/blueprints/cells/impacted_features/contributions-forks.md
58:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
117:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
169:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
173:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/architecture/blueprints/cells/index.md
401:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/architecture/blueprints/cells/rejected/deployment-architecture.md
58:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/architecture/blueprints/cells/rejected/proposal-stateless-router-with-buffering-requests.md
472:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
558:6 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
581:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
619:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
644:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/architecture/blueprints/cells/rejected/proposal-stateless-router-with-routes-learning.md
495:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
581:6 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
604:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
643:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
668:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/architecture/blueprints/ci_builds_runner_fleet_metrics/index.md
58:6 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/architecture/blueprints/ci_data_decay/pipeline_partitioning.md
29:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/architecture/blueprints/clickhouse_read_abstraction_layer/index.md
11:3 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/architecture/blueprints/database_scaling/size-limits.md
7:3 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
114:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/architecture/blueprints/database_testing/index.md
110:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/architecture/blueprints/disaster_recovery/index.md
47:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
66:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/architecture/blueprints/disaster_recovery/regional.md
11:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
54:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/architecture/blueprints/disaster_recovery/zonal.md
11:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
61:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
71:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/architecture/blueprints/feature_flags_usage_in_dev_and_ops/index.md
95:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
249:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/architecture/blueprints/gitlab_ci_events/proposal-4-creating-events-via-ci-files.md
6:3 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/architecture/blueprints/gitlab_ml_experiments/index.md
63:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/architecture/blueprints/model_experiments_and_registry/index.md
99:6 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/architecture/blueprints/observability_metrics/index.md
243:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/architecture/blueprints/organization/organization-faq.md
9:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
14:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
20:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
25:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/architecture/blueprints/permissions/index.md
130:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
147:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/architecture/blueprints/runner_scaling/index.md
145:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/architecture/blueprints/runway/index.md
88:1 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/architecture/blueprints/secret_detection/decisions/001_use_ruby_push_check_approach_within_monolith.md
6:3 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/architecture/blueprints/secret_detection/decisions/002_store_the_secret_detection_gem_in_the_same_repository.md
6:3 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/architecture/blueprints/security_policies_database_read_model/index.md
236:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/ci/cloud_services/aws/index.md
10:1 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/ci/cloud_services/azure/index.md
10:1 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/ci/debugging.md
101:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/ci/docker/buildah_rootless_tutorial.md
7:3 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/ci/docker/using_docker_build.md
10:1 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
826:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
833:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/ci/docker/using_kaniko.md
163:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/ci/environments/index.md
1072:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/ci/environments/protected_environments.md
281:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/ci/examples/deployment/composer-npm-deploy.md
7:3 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/ci/examples/semantic-release.md
7:3 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/ci/jobs/job_artifacts_troubleshooting.md
39:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
67:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
97:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/ci/jobs/job_control.md
919:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/ci/pipelines/downstream_pipelines.md
10:1 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/ci/pipelines/merge_trains.md
180:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/ci/pipelines/mr_pipeline_troubleshooting.md
33:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
36:1 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/ci/resource_groups/index.md
146:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/ci/secrets/gcp_secret_manager.md
10:1 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/ci/ssh_keys/index.md
10:1 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/ci/testing/code_quality_troubleshooting.md
15:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/ci/yaml/script.md
348:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/development/ai_features/index.md
518:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/development/backend/ruby_style_guide.md
137:7 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/development/code_owners/index.md
128:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
140:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/development/contributing/index.md
164:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/development/database/adding_database_indexes.md
482:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/development/database/avoiding_downtime_in_migrations.md
334:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
360:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
441:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/development/database/loose_foreign_keys.md
446:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
467:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/development/database/migrations_for_multiple_databases.md
129:6 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
218:6 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
348:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/development/database/multiple_databases.md
50:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
154:6 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
199:7 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/development/database/namespaces_storage_statistics.md
152:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/development/database/partitioning/list.md
179:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/development/database/strings_and_the_text_data_type.md
114:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/development/database_review.md
222:6 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/development/fe_guide/frontend_faq.md
87:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/development/fe_guide/graphql.md
424:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/development/fe_guide/migrating_from_vuex.md
316:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/development/fe_guide/troubleshooting.md
27:1 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
72:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/development/fe_guide/type_hinting.md
77:6 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/development/fe_guide/vue3_migration.md
234:6 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
348:6 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/development/feature_flags/controls.md
136:7 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/development/geo/proxying.md
46:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/development/git_object_deduplication.md
28:1 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
175:6 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
179:6 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/development/gotchas.md
27:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
130:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/development/multi_version_compatibility.md
115:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/development/pipelines/index.md
216:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
220:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/development/pipelines/internals.md
141:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
360:6 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/development/redis/new_redis_instance.md
113:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/development/ruby3_gotchas.md
142:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/development/testing_guide/flaky_tests.md
344:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/development/testing_guide/testing_levels.md
319:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/index.md
13:7 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/install/docker_troubleshooting.md
56:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/install/installation.md
10:1 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/integration/advanced_search/elasticsearch_troubleshooting.md
10:1 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
196:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
226:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
230:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
252:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
442:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
471:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
495:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
549:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/integration/github.md
228:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/integration/jenkins.md
174:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/integration/kerberos_troubleshooting.md
90:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/integration/omniauth.md
255:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/raketasks/user_management.md
68:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/security/passwords_for_integrated_authentication_methods.md
7:3 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/solutions/cloud/aws/gitlab_aws_integration.md
69:6 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
101:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/solutions/cloud/aws/gitlab_instance_on_aws.md
11:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/topics/autodevops/cloud_deployments/auto_devops_with_eks.md
7:3 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/topics/autodevops/troubleshooting.md
10:1 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/topics/autodevops/upgrading_auto_deploy_dependencies.md
273:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/topics/data_seeder.md
267:6 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
298:6 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/topics/git/troubleshooting_git.md
60:1 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
75:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/topics/offline/quick_start_guide.md
274:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/tutorials/scrum_events/index.md
116:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/tutorials/set_up_gitlab_google_integration/index.md
43:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/update/background_migrations_troubleshooting.md
15:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/update/package/package_troubleshooting.md
10:1 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
106:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
110:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/update/patch_versions.md
7:3 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
96:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/update/upgrading_from_ce_to_ee.md
7:3 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/update/versions/gitlab_15_changes.md
10:1 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/update/versions/gitlab_16_changes.md
843:6 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/user/analytics/dora_metrics.md
212:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/user/application_security/api_fuzzing/performance.md
29:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/user/application_security/api_fuzzing/troubleshooting.md
24:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
37:1 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/user/application_security/container_scanning/index.md
10:1 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
578:6 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
601:6 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
617:6 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
838:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/user/application_security/dast/browser/checks/200.1.md
7:3 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/user/application_security/dast/browser/checks/22.1.md
7:3 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/user/application_security/dast/browser/checks/359.1.md
7:3 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/user/application_security/dast/browser/checks/359.2.md
7:3 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/user/application_security/dast/browser/checks/598.3.md
7:3 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/user/application_security/dast/browser/checks/798.107.md
7:3 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/user/application_security/dast/browser/checks/798.58.md
7:3 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/user/application_security/dast/browser/checks/798.83.md
7:3 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/user/application_security/dast/dast_troubleshooting.md
78:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/user/application_security/dast/proxy-based.md
11:1 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/user/application_security/dast_api/performance.md
29:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/user/application_security/dast_api/troubleshooting.md
24:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
37:1 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/user/application_security/dependency_scanning/index.md
476:6 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
1081:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
1103:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/user/application_security/dependency_scanning/troubleshooting_dependency_scanning.md
10:1 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
20:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
61:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
80:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
100:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
134:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
150:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
170:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/user/application_security/policies/index.md
10:1 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/user/application_security/policies/scan-result-policies.md
451:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/user/application_security/sast/customize_rulesets.md
384:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
453:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/user/application_security/sast/index.md
440:6 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
459:6 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/user/application_security/sast/troubleshooting.md
10:1 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
18:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
59:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
116:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/user/application_security/troubleshooting_application_security.md
97:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
197:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
205:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/user/clusters/agent/ci_cd_workflow.md
369:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/user/clusters/agent/troubleshooting.md
65:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
190:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
212:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/user/clusters/migrating_from_gma_to_project_template.md
7:3 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/user/compliance/compliance_center/compliance_violations_report.md
97:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/user/compliance/license_approval_policies.md
59:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/user/compliance/license_scanning_of_cyclonedx_files/index.md
149:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/user/enterprise_user/index.md
194:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/user/gitlab_duo_chat.md
357:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/user/group/compliance_pipelines.md
150:6 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/user/group/custom_project_templates.md
107:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/user/group/saml_sso/group_sync.md
314:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/user/group/saml_sso/troubleshooting.md
183:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
212:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
227:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
241:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
257:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
417:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/user/group/saml_sso/troubleshooting_scim.md
10:1 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/user/group/troubleshooting.md
91:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/user/infrastructure/iac/troubleshooting.md
20:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
91:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/user/packages/nuget_repository/index.md
10:1 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/user/profile/account/two_factor_authentication.md
563:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/user/profile/notifications.md
292:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/user/project/canary_deployments.md
108:6 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/user/project/clusters/add_eks_clusters.md
32:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
290:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/user/project/clusters/add_existing_cluster.md
10:1 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/user/project/codeowners/index.md
165:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/user/project/import/bitbucket_server.md
153:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/user/project/import/gitlab_com.md
7:3 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/user/project/integrations/index.md
84:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/user/project/issue_board.md
10:1 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/user/project/merge_requests/index.md
404:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/user/project/pages/custom_domains_ssl_tls_certification/lets_encrypt_integration.md
71:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
88:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/user/project/releases/index.md
434:5 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/user/project/repository/mirror/troubleshooting.md
10:1 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
44:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
185:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
233:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/user/upgrade_email_bypass.md
79:4 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
doc/user/workspace/create_image.md
7:3 warning Subheadings should use fewer than 70 characters. gitlab.SubheadingLength
✖ 0 errors, 356 warnings and 0 suggestions in 2292 files.Related issues
Author's checklist
-
Optional. Consider taking the GitLab Technical Writing Fundamentals course. -
Follow the: -
If you're adding a new page, add the product tier badge under the H1 topic title. -
If you are a GitLab team member, request a review based on: - The documentation page's metadata.
- The associated Technical Writer.
If you are a GitLab team member and only adding documentation, do not add any of the following labels:
~"frontend"~"backend"~"type::bug"~"database"
These labels cause the MR to be added to code verification QA issues.
Reviewer's checklist
Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.
If you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.
-
If the content requires it, ensure the information is reviewed by a subject matter expert. - Technical writer review items:
-
Ensure docs metadata is present and up-to-date. -
Ensure the appropriate labels are added to this MR. -
Ensure a release milestone is set. - If relevant to this MR, ensure content topic type principles are in use, including:
-
The headings should be something you'd do a Google search for. Instead of Default behavior, say something likeDefault behavior when you close an issue. -
The headings (other than the page title) should be active. Instead of Configuring GDK, say something likeConfigure GDK. -
Any task steps should be written as a numbered list. - If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
-
-
-
Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.
Edited by Amy Qualls