Commit Graph

200 Commits

Author SHA1 Message Date
Drew Blessing e000f02bd3 Add support for column limits in add_column_with_default 2016-09-15 21:59:58 -05:00
Yorick Peterse 0c046399d4
Document how to track custom events
Fixes gitlab-org/gitlab-ce#22070

[ci skip]
2016-09-12 17:41:45 +02:00
Achilleas Pipinellis 3ef2c38b63 Change the inline code to codeblocks for the new features doc guideline
[ci skip]
2016-09-02 08:55:54 +02:00
Achilleas Pipinellis ee61c4037e Merge branch 'mr-performance-guides' into 'master'
Added performance guidelines for new MRs

## What does this MR do?

This MR adds a set of guides that should be followed by merge request authors.

## Are there points in the code the reviewer needs to double check?

Spelling, grammar, etc

## Why was this MR needed?

There is no set of guidelines one should follow when submitting merge requests. This leads to developers at times disregarding performance. This in turn results in performance specialists having to clean up the mess, or production engineers being woken up in the middle of the night because the database is on fire.

## Does this MR meet the acceptance criteria?

- [x] [Documentation created/updated](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/doc/development/doc_styleguide.md)
- Tests
  - [x] All builds are passing
- [x] Conform by the [style guides](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/CONTRIBUTING.md#style-guides)
- [x] Branch has no merge conflicts with `master` (if you do - rebase it please)
- [x] [Squashed related commits together](https://git-scm.com/book/en/Git-Tools-Rewriting-History#Squashing-Commits)

cc @DouweM @rspeicher @pcarranza @dzaporozhets 

See merge request !5905
2016-08-31 12:51:36 +00:00
Douwe Maan 7f47dddc25 Merge branch 'patch-1' into 'master'
Clarify blank line rule in newlines_styleguide.md

## What does this MR do?

* Corrects a typo in the GitLab Ruby newlines style guide
* Makes some vague language in the original guideline more precise

## Are there points in the code the reviewer needs to double check?

n/a

## Why was this MR needed?

* There was a typo in the original text.
* The original text was vague.

## What are the relevant issue numbers?

n/a

## Screenshots (if relevant)

n/a

## Does this MR meet the acceptance criteria?

- [x] [CHANGELOG](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/CHANGELOG) entry added  (Is this recommended for this kind of patch?)
- ~~[Documentation created/updated](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/doc/development/doc_styleguide.md)~~
- ~~API support added~~
- Tests
  - ~~Added for this feature/bug~~
  - [x] All builds are passing
- [x] Conform by the [style guides](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/CONTRIBUTING.md#style-guides)
- [x] Branch has no merge conflicts with `master` (if you do - rebase it please)
- [x] [Squashed related commits together](https://git-scm.com/book/en/Git-Tools-Rewriting-History#Squashing-Commits)

See merge request !6048
2016-08-30 17:43:56 +00:00
Achilleas Pipinellis 773bca382b Merge branch 'doc/styleguide-fix-grep' into 'master'
Clarify steps when changing a document's location

Clarify the steps needed to change a document's location so issues like
https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/6024
don't occur.

See merge request !6070
2016-08-29 20:13:49 +00:00
Achilleas Pipinellis d30d992813 Use `git grep` instead of `grep`
[ci skip]
2016-08-29 22:08:02 +02:00
Achilleas Pipinellis 8044797559 Clarify steps when changing a document's location
[ci skip]
2016-08-27 20:52:13 +02:00
Clement Ho aeb280b0cc Fix markdown help references 2016-08-26 09:38:21 -05:00
Jake Romer 1fc0d4f4b5 Clarify blank line rule in newlines_styleguide.md
To clarify what's meant by "from a logical perspective" here, I
consulted Python's PEP8 style guide, which provides some helpfully
precise language: 

> Extra blank lines may be used (sparingly) to separate groups of 
> related functions. Blank lines may be omitted between a bunch of 
> related one-liners (e.g. a set of dummy implementations).

https://www.python.org/dev/peps/pep-0008/#blank-lines

I adapted this passage to the existing language for the newline rule.
2016-08-26 06:12:30 +00:00
Achilleas Pipinellis cb5e6fe71e Fix markdown link in doc_styleguide.md
[ci skip]
2016-08-25 15:36:56 +02:00
Yorick Peterse e4e03d946e
Added performance guidelines for new MRs
These guidelines cover the performance requirement for newly submitted
merge requests. These guidelines are put in to place to prevent merge
requests from negatively impacting GitLab performance as much as
possible.
2016-08-22 14:32:25 +02:00
Achilleas Pipinellis 07d5759408 Merge branch 'document-when-to-add-indexes' into 'master'
Added documentation on adding database indexes

## What does this MR do?

This MR adds a guide on when to add database indexes, how to approach this problem, etc

## Are there points in the code the reviewer needs to double check?

Spelling, grammar, etc

## Why was this MR needed?

Blindly adding indexes can be harmful to the database, and I recently had to remove 48-something unused indexes.

## What are the relevant issue numbers?

#20767

## Does this MR meet the acceptance criteria?

- [x] [Documentation created/updated](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/doc/development/doc_styleguide.md)
- Tests
  - [x] All builds are passing
- [ ] Conform by the [style guides](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/CONTRIBUTING.md#style-guides)
- [x] Branch has no merge conflicts with `master` (if you do - rebase it please)
- [x] [Squashed related commits together](https://git-scm.com/book/en/Git-Tools-Rewriting-History#Squashing-Commits)

See merge request !5771
2016-08-16 17:03:22 +00:00
Jacob Schatz e51de3b9a5 Merge branch '19350-product-map' into 'master'
Add reference to product map.

## What does this MR do?
Mention the product map in the UI Guide and remove a line that says that the GitLab logo and user picture and in the sidebar.

## What are the relevant issue numbers?
19350

- [ ] [CHANGELOG](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/CHANGELOG) entry added
- [ ] [Documentation created/updated](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/doc/development/doc_styleguide.md)
- [ ] API support added
- Tests
  - [ ] Added for this feature/bug
  - [ ] All builds are passing
- [ ] Conform by the [style guides](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/CONTRIBUTING.md#style-guides)
- [ ] Branch has no merge conflicts with `master` (if you do - rebase it please)
- [ ] [Squashed related commits together](https://git-scm.com/book/en/Git-Tools-Rewriting-History#Squashing-Commits)
Closes #19350

See merge request !5769
2016-08-16 15:09:45 +00:00
Yorick Peterse 7d65d2ec2b
Corrected links/usernames in performance guide
This fixes two broken links in the performance guide and removes the
mention of Josh as he no longer works for GitLab.

[ci skip]
2016-08-11 14:31:19 +02:00
Yorick Peterse 5f7394070f
Added documentation on adding database indexes 2016-08-11 14:22:50 +02:00
Chris Peressini 91cd5ae71c Add reference to product map.
Remove line that says the GitLab logo and user picture are in the sidebar.
2016-08-11 10:11:17 +00:00
Achilleas Pipinellis ae2d3c4170 Merge branch 'add-column-with-default-to-downtime-guide' into 'master'
Mention add_column_with_default in downtime guide

## What does this MR do?

This extends the "What causes downtime" guide with a mention of the `add_column_with_default` migration helper.

## Are there points in the code the reviewer needs to double check?

Spelling, grammar, etc.

## Why was this MR needed?

Currently the guide may lead one to believe it's not possible at all to add a column with a default value.

## Does this MR meet the acceptance criteria?

- [x] ~~[CHANGELOG](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/CHANGELOG) entry added~~
- [x] [Documentation created/updated](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/doc/development/doc_styleguide.md)
- Tests
  - [ ] All builds are passing
- [ ] Conform by the [style guides](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/CONTRIBUTING.md#style-guides)
- [ ] Branch has no merge conflicts with `master` (if you do - rebase it please)
- [x] [Squashed related commits together](https://git-scm.com/book/en/Git-Tools-Rewriting-History#Squashing-Commits)

See merge request !5719
2016-08-10 14:15:16 +00:00
Dmitriy Zaporozhets 58bde30320 Merge branch 'update-ui-guide--svgs' into 'master'
Update UI Guide with SVG guidelines

This addition to the guide is to provide some guidelines to UX designers when exporting SVGs. Please let me know if anything is unclear or if you any improvements so we can document it clearly for everyone.

cc / @hazelyang @cperessini @dimitrieh @connorshea @annabeldunstone @dzaporozhets 

## What are the relevant issue numbers?
https://gitlab.com/gitlab-org/gitlab-ee/issues/872

See merge request !5748
2016-08-10 12:14:53 +00:00
Achilleas Pipinellis 01c0039c55 Small refactor of doc/development/README.md
- Fix wrong doc_styleguide URL
- Clarify migrations refer to SQL
- Capitalize CSS
2016-08-10 14:28:56 +03:00
Yorick Peterse ee451ea573
Mention add_column_with_default in downtime guide
[ci skip]
2016-08-10 11:09:53 +02:00
Achilleas Pipinellis 9db46cc89a Merge branch 'link-to-gdk-howtos' into 'master'
Link to doc root, not readme of GDK

I hope this makes navigation between gitlab-ce developer docs and GDK docs more smooth.

See merge request !5716
2016-08-10 06:31:04 +00:00
Achilleas Pipinellis 68097a3a5c Merge branch 'api-examples-curl-long-options' into 'master'
Use long options for curl examples in documentation

## What does this MR do?

Use long options (e.g. `--header` instead of `-H`) for curl examples in documentation.

## Why was this MR needed?

Short options are less readable.

## What are the relevant issue numbers?

https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/5465#note_13603730


See merge request !5703
2016-08-10 06:12:27 +00:00
Taurie Davis 864bdda4ae spellcheck 2016-08-09 21:59:25 +00:00
Taurie Davis befb425c92 Add svg guidelines to ui guide 2016-08-09 21:57:46 +00:00
winniehell e0a858efcc use long options for curl examples in API documentation (!5703) 2016-08-09 01:42:50 +02:00
Robert Speicher fa95d9e48b Merge branch 'dz-newlines-styleguide' into 'master'
Add newlines styleguide for Ruby code 

See merge request !5636
2016-08-08 23:29:56 +00:00
Jacob Vosmaer 23ddd5eca2 Link to doc root, not readme of GDK 2016-08-08 17:14:36 +02:00
Achilleas Pipinellis 689de9c6fb Simplify feature introduction note
[ci skip]
2016-08-08 11:44:55 +03:00
Achilleas Pipinellis 9103023054 Merge branch 'doc-location-guidelines' into 'master'
Add doc guidelines on documents naming and location

## What does this MR do?

Add guidelines on the structure of the documentation.

## What are the relevant issue numbers?

https://gitlab.com/gitlab-org/gitlab-ce/issues/3349

See merge request !5641
2016-08-06 14:45:39 +00:00
Jacob Vosmaer ef589219d2 Add 'run tests' docs from GDK 2016-08-05 17:19:37 +02:00
Dmitriy Zaporozhets 13cabe7184 Add newlines styleguide for Ruby code 2016-08-05 12:19:19 +03:00
Yorick Peterse c462dcec4d
Added guide about migrations and downtime
This guide describes various commonly used operations and the impact
they have on the availability of a GitLab instance.
2016-08-04 17:25:31 +02:00
Rémy Coutable f4c79d6a84 Merge branch 'coffescript_docs_migration' into 'master'
Update docs for CoffeeScript -> JavaScript.

## What does this MR do?
Removes some CoffeeScript docs and adds more JS ones

## Are there points in the code the reviewer needs to double check?
No

## Why was this MR needed?
To migrate some docs

## What are the relevant issue numbers?
#20098

## Screenshots (if relevant)
None

## Does this MR meet the acceptance criteria?

- [x] [CHANGELOG](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/CHANGELOG) entry added
- [x] [Documentation created/updated](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/doc/development/doc_styleguide.md)
- [ ] API support added
- Tests
  - [ ] Added for this feature/bug
  - [ ] All builds are passing
- [x] Conform by the [style guides](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/CONTRIBUTING.md#style-guides)
- [x] Branch has no merge conflicts with `master` (if you do - rebase it please)
- [x] [Squashed related commits together](https://git-scm.com/book/en/Git-Tools-Rewriting-History#Squashing-Commits)

See merge request !5433
2016-08-04 11:41:52 +00:00
Sid Sijbrandij 1de019f5c8 Structure the development documentation 2016-08-04 10:45:59 +00:00
Rémy Coutable 8c8599a605
Remove CHANGELOG and fix typo
Signed-off-by: Rémy Coutable <remy@rymai.me>
2016-08-04 12:30:27 +02:00
Achilleas Pipinellis ff4407996b Add doc guidelines on documents naming and location
[ci skip]
2016-08-03 17:06:04 +03:00
Rémy Coutable 8bcdc4b185 API methods should be documented using Grape's DSL
See https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/2397#note_13491048
2016-08-01 13:52:51 +00:00
Jacob Schatz d6ebd4a3f7 Update docs for CoffeeScript -> JavaScript. 2016-07-22 20:13:46 -07:00
Robert Speicher 22c8e21bf4 Merge branch 'email-domain-blacklist' into 'master'
Added the ability to block sign ups using a domain blacklist.

As part of this MR, I restructured the Application Settings form to separate **Sign up** related settings from **Sign in** related settings and make everything cleaner and easier to read.

Fixes #19749 

Related to #5573

See merge request !5259
2016-07-20 20:26:00 +00:00
Yorick Peterse a8bfe20d0d
Added checks for migration downtime
These new checks can be used to check if migrations require downtime or
not (as tagged by their authors). In CI this compares the current branch
with master so migrations added by merge requests are automatically
verified.

To check the migrations added since a Git reference simply run:

    bundle exec rake gitlab:db:downtime_check[GIT_REF]
2016-07-20 12:41:56 +02:00
Patricio Cano c71e658cca Refactor and rename `restricted_signup_domains` to `domain_whitelist` to better conform to its behavior and newly introduced behavior. 2016-07-18 17:53:43 -05:00
Connor Shea 6a06c5cfb9
Upgrade Gemojione from 2.6.1 to 3.0.1.
This adds the 2016 emoji as well as support for using SVG images instead of PNGs.

It also fixes a number of incorrectly categorized emoji and other minor issues.

Upgrade Rake task for Gemojione 3.0.0 and generate sprites.

Upgrade aliases.json by pulling down index.json from the gemojione repository and running the generate_aliases.rb file.

Changelog: https://github.com/jonathanwiesel/gemojione/blob/master/CHANGELOG.md#v301-2016-07-16

For the specific emoji added to the Unicode standard, see: http://emojione.com/releases/2.2.4/

Huge kudos to Jonathan Wiesel (@jonathanwiesel) for his work on the gemojione gem!
2016-07-18 10:40:16 -06:00
Jacob Vosmaer (GitLab) 52af77d8f8 Don't ask Heather to review documentation MR's 2016-07-15 16:04:45 +00:00
Robert Speicher 78d75652bc Add a UI guide note about number_with_delimiter
[ci skip]
2016-07-12 15:10:11 -05:00
Dmitriy Zaporozhets 5d742a308c Improve wording in UI guide 2016-07-12 10:55:18 +00:00
Dmitriy Zaporozhets c4fb58ef35 Fix typo in UI guide 2016-07-11 16:54:24 +00:00
Dmitriy Zaporozhets 4765a3414e
Add rule about adding new header tab to the ui guide
Signed-off-by: Dmitriy Zaporozhets <dmitriy.zaporozhets@gmail.com>
2016-07-11 19:51:20 +03:00
Dmitriy Zaporozhets 3bae69aa5d Update ui_guide.md with button capitalize rule 2016-07-08 21:20:13 +00:00
Achilleas Pipinellis 432929fd45 Merge branch 'fix-dead-links' into 'master'
Fix dead links in the docs (Jun 2016)

## What does this MR do?

Fix dead links in the docs found as of Jun 2016.

## Are there points in the code the reviewer needs to double check?

n/a

## Why was this MR needed?

This MR must improve UX on docs.gitlab.com.

## What are the relevant issue numbers?

Closes #19156 

## Does this MR meet the acceptance criteria?

- No [CHANGELOG](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/CHANGELOG) updated
- [x] [Documentation created/updated](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/doc/development/doc_styleguide.md)
- [x] Conform by the [style guides](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/CONTRIBUTING.md#style-guides)
- [x] Branch has no merge conflicts with `master` (if you do - rebase it please)
- [x] [Squashed related commits together](https://git-scm.com/book/en/Git-Tools-Rewriting-History#Squashing-Commits)

See merge request !4921
2016-07-04 16:49:18 +00:00