History

Markus Koller 4027acf504 Clarify the process for CE-first documentation Previously it was unclear if the docs changes should be included in the MR as well, and adding a changelog entry in the CE MR also triggers the ee-specific-lines-check job in CI.		2019-06-05 12:38:56 +02:00
..
contributing	Merge branch 'winh-community-review-time-docs' into 'master'	2019-05-27 15:59:17 +00:00
documentation	Clarify the process for CE-first documentation	2019-06-05 12:38:56 +02:00
fe_guide	Docs: Clean up links to remove ./ usage	2019-06-05 10:10:28 +00:00
go_guide	Use relative URLs in development docs	2019-05-27 11:13:40 -04:00
i18n	Docs: Clean up links to remove ./ usage	2019-06-05 10:10:28 +00:00
img	Add developer documentation for distributing tracing	2019-02-28 00:21:37 +00:00
integrations	Docs: Realigning scattered EE docs into CE	2019-05-06 00:56:13 +00:00
new_fe_guide	Use relative URLs in development docs	2019-05-27 11:13:40 -04:00
python_guide	Upgrade `gitlab-markup` to 1.7.0	2019-03-27 16:29:22 +01:00
testing_guide	Consolidate documentation written for e2e tests under dev docs	2019-05-30 22:10:33 -07:00
ux_guide	Docs: Remove orphaned UX guide images	2019-05-17 19:19:43 +00:00
README.md	Add developmenty documentation about routing	2019-05-27 08:33:40 +00:00
adding_database_indexes.md	Make unordered lists conform to styleguide	2019-01-08 12:21:09 +10:00
api_graphql_styleguide.md	Expose IDs in GraphQL as a GlobalID	2019-06-03 21:59:25 +02:00
api_styleguide.md	Fix most instances of bare URLs in markdown	2019-01-24 06:52:33 +00:00
architecture.md	Update architecture.md to fix typo in GitLabMonito -> GitLabMonitor	2019-06-03 18:29:25 +00:00
automatic_ce_ee_merge.md	Ensure all lists are surrounded by new lines	2019-02-22 13:17:10 +00:00
background_migrations.md	Make unordered lists conform to styleguide	2019-01-08 12:21:09 +10:00
build_test_package.md	Resolve Markdown ordered lists not conforming to styleguide	2018-11-13 10:53:38 +10:00
changelog.md	Move the line up in the list	2019-05-20 12:13:33 -04:00
chaos_endpoints.md	…
code_review.md	Use relative URLs in development docs	2019-05-27 11:13:40 -04:00
database_debugging.md	Docs: Clean up links to remove ./ usage	2019-06-05 10:10:28 +00:00
database_helpers.md	…
database_merge_request_checklist.md	…
db_dump.md	Replace deprecated skip-auto-migrations occurrence	2018-11-23 15:44:27 +01:00
diffs.md	Remove consecutive blank lines from markdown files	2019-02-18 09:36:13 +00:00
distributed_tracing.md	Use relative URLs in development docs	2019-05-27 11:13:40 -04:00
doc_styleguide.md	…
ee_features.md	Docs: Clean up links to remove ./ usage	2019-06-05 10:10:28 +00:00
elasticsearch.md	Use relative URLs in development docs	2019-05-27 11:13:40 -04:00
emails.md	Document new incoming email address format	2019-01-08 00:12:59 +00:00
feature_flags.md	Use relative URLs in development docs	2019-05-27 11:13:40 -04:00
file_storage.md	Remove consecutive blank lines from markdown files	2019-02-18 09:36:13 +00:00
foreign_keys.md	…
frontend.md	…
gemfile.md	…
geo.md	Added FDW development documentation	2019-05-29 16:25:15 +02:00
git_object_deduplication.md	Document how Git object deduplication works in GitLab	2019-03-19 13:25:12 +00:00
gitaly.md	Document where Gitaly instance writes logs during rspec	2019-05-02 22:47:29 +00:00
github_importer.md	Make unordered lists conform to styleguide	2019-01-08 12:21:09 +10:00
gitlab_diagram_overview.odg	…
gotchas.md	Make unordered lists conform to styleguide	2019-01-08 12:21:09 +10:00
hash_indexes.md	…
i18n_guide.md	Docs: Add automatic redirects to last batch of moved files	2019-03-26 17:21:22 +00:00
import_export.md	Use relative URLs in development docs	2019-05-27 11:13:40 -04:00
instrumentation.md	Make unordered lists conform to styleguide	2019-01-08 12:21:09 +10:00
iterating_tables_in_batches.md	…
kubernetes.md	Development guide for Kubernetes	2019-02-12 14:18:49 +13:00
licensed_feature_availability.md	Use relative URLs in development docs	2019-05-27 11:13:40 -04:00
licensing.md	…
logging.md	Ensure all lists are surrounded by new lines	2019-02-22 13:17:10 +00:00
merge_request_performance_guidelines.md	Make unordered lists conform to styleguide	2019-01-08 12:21:09 +10:00
migration_style_guide.md	Add note for index requirement with FK constraint	2019-05-23 12:45:52 +00:00
module_with_instance_variables.md	…
newlines_styleguide.md	…
omnibus.md	…
ordering_table_columns.md	Fix misspellings in docs	2019-02-25 10:31:35 +09:00
packages.md	Use relative URLs in development docs	2019-05-27 11:13:40 -04:00
performance.md	Add developer documentation for distributing tracing	2019-02-28 00:21:37 +00:00
permissions.md	…
policies.md	Ensure all lists are surrounded by new lines	2019-02-22 13:17:10 +00:00
polling.md	Ensure all lists are surrounded by new lines	2019-02-22 13:17:10 +00:00
polymorphic_associations.md	Make unordered lists conform to styleguide	2019-01-08 12:21:09 +10:00
post_deployment_migrations.md	Make unordered lists conform to styleguide	2019-01-08 12:21:09 +10:00
profiling.md	Profiler only works with absolute URLs and paths	2019-03-07 11:06:12 +00:00
prometheus_metrics.md	Fix ActiveRecord::Migration deprecations	2018-12-12 16:38:40 +01:00
pry_debugging.md	…
query_count_limits.md	Resolve Markdown ordered lists not conforming to styleguide	2018-11-13 10:53:38 +10:00
query_recorder.md	…
rake_tasks.md	Use relative URLs in development docs	2019-05-27 11:13:40 -04:00
reusing_abstractions.md	Make unordered lists conform to styleguide	2019-01-08 12:21:09 +10:00
rolling_out_changes_using_feature_flags.md	Update invalid anchor link	2019-06-03 16:04:07 +00:00
routing.md	Add developmenty documentation about routing	2019-05-27 08:33:40 +00:00
serializing_data.md	…
session.md	Document ways of accessing Session data in GitLab	2019-05-15 09:57:00 +07:00
sha1_as_binary.md	…
shared_files.md	…
shell_commands.md	Remove consecutive blank lines from markdown files	2019-02-18 09:36:13 +00:00
sidekiq_debugging.md	Limit Sidekiq args logging to 10 KB of JSON	2019-01-22 10:54:12 +00:00
sidekiq_style_guide.md	Backport of gitlab-ee!8470	2018-11-19 16:29:19 -05:00
single_table_inheritance.md	…
sql.md	Document ApplicationRecord / pluck_primary_key	2019-03-29 20:54:06 +00:00
swapping_tables.md	Resolve Markdown ordered lists not conforming to styleguide	2018-11-13 10:53:38 +10:00
testing.md	Docs: Add automatic redirects to last batch of moved files	2019-03-26 17:21:22 +00:00
ui_guide.md	Fix minor grammar issues	2018-11-27 11:08:29 +10:00
understanding_explain_plans.md	Add activerecord-explain-analyze gem	2019-06-03 20:53:53 +02:00
utilities.md	Make unordered lists conform to styleguide	2019-01-08 12:21:09 +10:00
verifying_database_capabilities.md	Make unordered lists conform to styleguide	2019-01-08 12:21:09 +10:00
what_requires_downtime.md	Fix ActiveRecord::Migration deprecations	2018-12-12 16:38:40 +01:00
writing_documentation.md	…

README.md

comments	description
false	Learn how to contribute to GitLab.

GitLab development guides

Get started!

Set up GitLab's development environment with GitLab Development Kit (GDK)
GitLab contributing guide
Architecture of GitLab
Rake tasks for development

Processes

GitLab core team & GitLab Inc. contribution process
Generate a changelog entry with bin/changelog
Code review guidelines for reviewing code and having code reviewed.
Automatic CE->EE merge
Guidelines for implementing Enterprise Edition features
Security process for developers

UX and frontend guides

GitLab Design System for building GitLab with existing CSS styles and elements
Frontend guidelines
Emoji guide

Backend guides

GitLab utilities
Logging
API styleguide Use this styleguide if you are contributing to the API.
GraphQL API styleguide Use this styleguide if you are contribution to the GraphQL API
Sidekiq guidelines for working with Sidekiq workers
Working with Gitaly
Manage feature flags
Licensed feature availability
View sent emails or preview mailers
Shell commands in the GitLab codebase
Gemfile guidelines
Pry debugging
Sidekiq debugging
Accessing session data
Gotchas to avoid
Avoid modules with instance variables if possible
How to dump production data to staging
Working with the GitHub importer
Import/Export development documentation
Elasticsearch integration docs
Working with Merge Request diffs
Kubernetes integration guidelines
Permissions
Prometheus metrics
Guidelines for reusing abstractions
DeclarativePolicy framework
How Git object deduplication works in GitLab
Geo development
Routing

Performance guides

Instrumentation for Ruby code running in production environments
Performance guidelines for writing code, benchmarks, and certain patterns to avoid
Merge request performance guidelines for ensuring merge requests do not negatively impact GitLab performance
Profiling a URL, measuring performance using Sherlock, or tracking down N+1 queries using Bullet

Database guides

Tooling

Understanding EXPLAIN plans
explain.depesz.com for visualising the output of EXPLAIN

Migrations

What requires downtime?
SQL guidelines for working with SQL queries
Migrations style guide for creating safe SQL migrations
Post deployment migrations
Background migrations
Swapping tables

README.md

GitLab development guides

Get started!

Processes

UX and frontend guides

Backend guides

Performance guides

Database guides

Tooling

Migrations

Best practices

Integration guides

Testing guides

Documentation guides

Internationalization (i18n) guides

Build guides

Compliance

Go guides

Other GitLab Development Kit (GDK) guides