Skip to content

Commit 676840f

Browse files
rymaiaxilleas
authored andcommitted
Refactor the Development documentation, and divide the Testing documentation into multiple pages
1 parent 150f58d commit 676840f

14 files changed

+1027
-876
lines changed

CONTRIBUTING.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -296,9 +296,9 @@ might be edited to make them small and simple.
296296

297297
Please submit Feature Proposals using the ['Feature Proposal' issue template](.gitlab/issue_templates/Feature Proposal.md) provided on the issue tracker.
298298

299-
For changes in the interface, it is helpful to include a mockup. Issues that add to, or change, the interface should
300-
be given the ~"UX" label. This will allow the UX team to provide input and guidance. You may
301-
need to ask one of the [core team] members to add the label, if you do not have permissions to do it by yourself.
299+
For changes in the interface, it is helpful to include a mockup. Issues that add to, or change, the interface should
300+
be given the ~"UX" label. This will allow the UX team to provide input and guidance. You may
301+
need to ask one of the [core team] members to add the label, if you do not have permissions to do it by yourself.
302302

303303
If you want to create something yourself, consider opening an issue first to
304304
discuss whether it is interesting to include this in GitLab.
@@ -658,7 +658,7 @@ available at [http://contributor-covenant.org/version/1/1/0/](http://contributor
658658
[license-finder-doc]: doc/development/licensing.md
659659
[GitLab Inc engineering workflow]: https://about.gitlab.com/handbook/engineering/workflow/#labelling-issues
660660
[polling-etag]: https://docs.gitlab.com/ce/development/polling.html
661-
[testing]: doc/development/testing.md
661+
[testing]: doc/development/testing_guide/index.md
662662

663663
[^1]: Please note that specs other than JavaScript specs are considered backend
664664
code.

PROCESS.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## GitLab Core Team & GitLab Inc. Contribution Process
1+
## GitLab core team & GitLab Inc. contribution process
22

33
---
44

doc/development/README.md

+64-50
Original file line numberDiff line numberDiff line change
@@ -1,75 +1,89 @@
1-
# Development
1+
# GitLab development guides
22

3-
## Outside of docs
3+
## Get started!
44

5-
- [CONTRIBUTING.md](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/CONTRIBUTING.md) main contributing guide
6-
- [PROCESS.md](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/PROCESS.md) contributing process
7-
- [GitLab Development Kit (GDK)](https://gitlab.com/gitlab-org/gitlab-development-kit/blob/master/doc/howto/README.md) to install a development version
5+
- Setup GitLab's development environment with [GitLab Development Kit (GDK)](https://gitlab.com/gitlab-org/gitlab-development-kit/blob/master/doc/howto/README.md)
6+
- [GitLab contributing guide](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/CONTRIBUTING.md)
7+
- [Architecture](architecture.md) of GitLab
8+
- [Rake tasks](rake_tasks.md) for development
89

9-
## Styleguides
10+
## Processes
11+
12+
- [GitLab core team & GitLab Inc. contribution process](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/PROCESS.md)
13+
- [Generate a changelog entry with `bin/changelog`](changelog.md)
14+
- [Code review guidelines](code_review.md) for reviewing code and having code reviewed.
15+
- [Limit conflicts with EE when developing on CE](limit_ee_conflicts.md)
16+
17+
## UX and frontend guides
1018

11-
- [API styleguide](api_styleguide.md) Use this styleguide if you are
12-
contributing to the API.
13-
- [Documentation styleguide](doc_styleguide.md) Use this styleguide if you are
14-
contributing to documentation.
15-
- [Writing documentation](writing_documentation.md)
16-
- [Distinction between general documentation and technical articles](writing_documentation.md#distinction-between-general-documentation-and-technical-articles)
17-
- [SQL Migration Style Guide](migration_style_guide.md) for creating safe SQL migrations
18-
- [Testing standards and style guidelines](testing.md)
1919
- [UX guide](ux_guide/index.md) for building GitLab with existing CSS styles and elements
2020
- [Frontend guidelines](fe_guide/index.md)
21-
- [SQL guidelines](sql.md) for working with SQL queries
21+
22+
## Backend guides
23+
24+
- [Testing standards and style guidelines](testing_guide/index.md)
25+
- [API styleguide](api_styleguide.md) Use this styleguide if you are
26+
contributing to the API.
2227
- [Sidekiq guidelines](sidekiq_style_guide.md) for working with Sidekiq workers
28+
- [Working with Gitaly](gitaly.md)
29+
- [Manage feature flags](feature_flags.md)
30+
- [View sent emails or preview mailers](emails.md)
31+
- [Shell commands](shell_commands.md) in the GitLab codebase
2332
- [`Gemfile` guidelines](gemfile.md)
33+
- [Sidekiq debugging](sidekiq_debugging.md)
34+
- [Gotchas](gotchas.md) to avoid
35+
- [Issue and merge requests state models](object_state_models.md)
36+
- [How to dump production data to staging](db_dump.md)
2437

25-
## Process
38+
## Performance guides
2639

27-
- [Generate a changelog entry with `bin/changelog`](changelog.md)
28-
- [Limit conflicts with EE when developing on CE](limit_ee_conflicts.md)
29-
- [Code review guidelines](code_review.md) for reviewing code and having code reviewed.
40+
- [Instrumentation](instrumentation.md)
41+
- [Performance guidelines](performance.md)
3042
- [Merge request performance guidelines](merge_request_performance_guidelines.md)
3143
for ensuring merge requests do not negatively impact GitLab performance
3244

33-
## Backend howtos
34-
35-
- [Architecture](architecture.md) of GitLab
36-
- [Gotchas](gotchas.md) to avoid
37-
- [How to dump production data to staging](db_dump.md)
38-
- [Instrumentation](instrumentation.md)
39-
- [Performance guidelines](performance.md)
40-
- [Rake tasks](rake_tasks.md) for development
41-
- [Shell commands](shell_commands.md) in the GitLab codebase
42-
- [Sidekiq debugging](sidekiq_debugging.md)
43-
- [Object state models](object_state_models.md)
44-
- [Building a package for testing purposes](build_test_package.md)
45-
- [Manage feature flags](feature_flags.md)
46-
- [View sent emails or preview mailers](emails.md)
47-
- [Working with Gitaly](gitaly.md)
45+
## Databases guides
4846

49-
## Databases
47+
### Migrations
5048

51-
- [Merge Request Checklist](database_merge_request_checklist.md)
5249
- [What requires downtime?](what_requires_downtime.md)
50+
- [SQL guidelines](sql.md) for working with SQL queries
51+
- [Migrations style guide](migration_style_guide.md) for creating safe SQL migrations
52+
- [Post deployment migrations](post_deployment_migrations.md)
53+
- [Background migrations](background_migrations.md)
54+
- [Swapping tables](swapping_tables.md)
55+
56+
### Best practices
57+
58+
- [Merge Request checklist](database_merge_request_checklist.md)
5359
- [Adding database indexes](adding_database_indexes.md)
54-
- [Post Deployment Migrations](post_deployment_migrations.md)
55-
- [Foreign Keys & Associations](foreign_keys.md)
56-
- [Serializing Data](serializing_data.md)
57-
- [Polymorphic Associations](polymorphic_associations.md)
58-
- [Single Table Inheritance](single_table_inheritance.md)
59-
- [Background Migrations](background_migrations.md)
60-
- [Storing SHA1 Hashes As Binary](sha1_as_binary.md)
61-
- [Iterating Tables In Batches](iterating_tables_in_batches.md)
62-
- [Ordering Table Columns](ordering_table_columns.md)
63-
- [Verifying Database Capabilities](verifying_database_capabilities.md)
64-
- [Hash Indexes](hash_indexes.md)
65-
- [Swapping Tables](swapping_tables.md)
66-
67-
## Internationalization (i18n)
60+
- [Foreign keys & associations](foreign_keys.md)
61+
- [Single table inheritance](single_table_inheritance.md)
62+
- [Polymorphic associations](polymorphic_associations.md)
63+
- [Serializing data](serializing_data.md)
64+
- [Hash indexes](hash_indexes.md)
65+
- [Storing SHA1 hashes as binary](sha1_as_binary.md)
66+
- [Iterating tables in batches](iterating_tables_in_batches.md)
67+
- [Ordering table columns](ordering_table_columns.md)
68+
- [Verifying database capabilities](verifying_database_capabilities.md)
69+
70+
## Documentation guides
71+
72+
- [Documentation styleguide](doc_styleguide.md): Use this styleguide if you are
73+
contributing to the documentation.
74+
- [Writing documentation](writing_documentation.md)
75+
- [Distinction between general documentation and technical articles](writing_documentation.md#distinction-between-general-documentation-and-technical-articles)
76+
77+
## Internationalization (i18n) guides
6878

6979
- [Introduction](i18n/index.md)
7080
- [Externalization](i18n/externalization.md)
7181
- [Translation](i18n/translation.md)
7282

83+
## Build guides
84+
85+
- [Building a package for testing purposes](build_test_package.md)
86+
7387
## Compliance
7488

7589
- [Licensing](licensing.md) for ensuring license compliance

doc/development/fe_guide/index.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,8 @@ or make changes to our frontend development guidelines.
5454

5555
---
5656

57-
## [Testing](testing.md)
57+
## [Testing](../testing_guide/frontend_testing.md)
58+
5859
How we write frontend tests, run the GitLab test suite, and debug test related
5960
issues.
6061

0 commit comments

Comments
 (0)