History

Yorick Peterse 4d10197915 Refactor the upgrading from source docs Instead of requiring one separate document for every version (which is created by release managers), we now use a single document for both Community Edition and Enterprise Edition. This allows developers to add guidelines right away, instead of release managers having to determine what to add. Version specific upgrading instructions are placed in a separate section. This prevents instructions from lingering around for many versions should a developer forget to remove them. This also ensures that all instructions are kept in a single place, instead of being spread across different documents. A minor downside is that CE and EE guidelines now live in the same document, which could cause merge conflicts. Since we are working towards a single codebase, this should only be an issue until we merge the codebases together; something we expect to do in the coming months. This commit also removes all old upgrading instructions, but these can still be accessed using Git branch specific URLs (included in the updating README).		2019-02-11 15:29:21 +01:00
..
contributing	Refactor the upgrading from source docs	2019-02-11 15:29:21 +01:00
documentation	Merge branch 'docs-correct-word' into 'master'	2019-02-11 05:52:43 +00:00
fe_guide	Fix most instances of bare URLs in markdown	2019-01-24 06:52:33 +00:00
go_guide	Add Go guidelines to developer docs	2019-02-06 16:10:12 +00:00
i18n	Fix spelling and other minor improvements	2019-01-31 12:45:38 +10:00
img	…
new_fe_guide	Fix most instances of bare URLs in markdown	2019-01-24 06:52:33 +00:00
testing_guide	Use $CI_COMMIT_REF_NAME for tags in trigger-build	2019-01-24 08:43:11 +01:00
ux_guide	Fix minor grammar issues	2018-11-27 11:08:29 +10:00
README.md	Add Go guidelines to developer docs	2019-02-06 16:10:12 +00:00
adding_database_indexes.md	Make unordered lists conform to styleguide	2019-01-08 12:21:09 +10:00
api_graphql_styleguide.md	…
api_styleguide.md	Fix most instances of bare URLs in markdown	2019-01-24 06:52:33 +00:00
architecture.md	Update architecture.md	2018-11-29 03:37:03 +00:00
automatic_ce_ee_merge.md	Fix typos	2019-01-21 18:06:16 +00:00
background_migrations.md	Make unordered lists conform to styleguide	2019-01-08 12:21:09 +10:00
build_test_package.md	…
changelog.md	…
chaos_endpoints.md	…
code_review.md	Fix links to sections that were moved	2018-12-11 20:09:05 +00:00
database_debugging.md	…
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	…
doc_styleguide.md	…
ee_features.md	Document ee_else_ce alias for splitting CE/EE JavaScript	2019-01-30 14:02:44 +00:00
emails.md	Document new incoming email address format	2019-01-08 00:12:59 +00:00
feature_flags.md	Add section about enabling feature flag in development	2018-12-06 16:46:12 +00:00
file_storage.md	Allow MR diffs to be placed into an object store	2019-02-05 14:12:48 +00:00
foreign_keys.md	…
frontend.md	…
gemfile.md	…
gitaly.md	Fix most instances of bare URLs in markdown	2019-01-24 06:52:33 +00:00
github_importer.md	Make unordered lists conform to styleguide	2019-01-08 12:21:09 +10:00
gitlab_architecture_diagram.png	…
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	…
import_export.md	Add Import/Export dev docs	2019-01-14 18:18:54 +00:00
instrumentation.md	Make unordered lists conform to styleguide	2019-01-08 12:21:09 +10:00
iterating_tables_in_batches.md	…
licensing.md	…
logging.md	Correct errors in doc/development/logging.md	2018-11-23 16:15:52 +01:00
merge_request_performance_guidelines.md	Make unordered lists conform to styleguide	2019-01-08 12:21:09 +10:00
migration_style_guide.md	Make unordered lists conform to styleguide	2019-01-08 12:21:09 +10:00
module_with_instance_variables.md	…
newlines_styleguide.md	…
omnibus.md	…
ordering_table_columns.md	Fix most instances of bare URLs in markdown	2019-01-24 06:52:33 +00:00
performance.md	Make unordered lists conform to styleguide	2019-01-08 12:21:09 +10:00
permissions.md	…
policies.md	Make unordered lists conform to styleguide	2019-01-08 12:21:09 +10:00
polling.md	…
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	Remove mentions of Redash	2018-12-05 10:34:16 -08:00
prometheus_metrics.md	Fix ActiveRecord::Migration deprecations	2018-12-12 16:38:40 +01:00
pry_debugging.md	…
query_count_limits.md	…
query_recorder.md	…
rake_tasks.md	Backport of elastic-test-repos from EE	2019-01-08 17:18:15 -06: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	Make unordered lists conform to styleguide	2019-01-08 12:21:09 +10:00
serializing_data.md	…
sha1_as_binary.md	…
shared_files.md	…
shell_commands.md	…
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	Adds helper for `find_or_create_by` in transaction	2019-02-05 14:44:41 +01:00
swapping_tables.md	…
testing.md	…
ui_guide.md	Fix minor grammar issues	2018-11-27 11:08:29 +10:00
understanding_explain_plans.md	Make unordered lists conform to styleguide	2019-01-08 12:21:09 +10: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
View sent emails or preview mailers
Shell commands in the GitLab codebase
Gemfile guidelines
Pry debugging
Sidekiq debugging
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
Working with Merge Request diffs
Permissions
Prometheus metrics
Guidelines for reusing abstractions
DeclarativePolicy framework

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

Testing guides

Documentation guides

Internationalization (i18n) guides

Build guides

Compliance

Go guides