Commit Graph

231 Commits

Author SHA1 Message Date
Winnie cd3c8e9b12 Document how to run frontend tests 2016-10-28 14:02:17 +02:00
Achilleas Pipinellis 69ab287b36 Add note about ephemeral statuses in headings
[ci skip]
2016-10-27 08:26:35 +02:00
Robert Speicher 65d86e0d11 Merge branch 'improve-grape-dsl-rules' into 'master'
Add an API styleguide

This adds a styleguide for API development. Spinned-of from https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/6860#note_16922017.

[ci skip]

See merge request !6864
2016-10-25 15:12:43 +00:00
Achilleas Pipinellis 8b7634c2b6 Fix old monitoring links to point to the new location 2016-10-24 16:45:00 +02:00
Yorick Peterse 97731760d7
Re-organize queues to use for Sidekiq
Dumping too many jobs in the same queue (e.g. the "default" queue) is a
dangerous setup. Jobs that take a long time to process can effectively
block any other work from being performed given there are enough of
these jobs.

Furthermore it becomes harder to monitor the jobs as a single queue
could contain jobs for different workers. In such a setup the only
reliable way of getting counts per job is to iterate over all jobs in a
queue, which is a rather time consuming process.

By using separate queues for various workers we have better control over
throughput, we can add weight to queues, and we can monitor queues
better. Some workers still use the same queue whenever their work is
related. For example, the various CI pipeline workers use the same
"pipeline" queue.

This commit includes a Rails migration that moves Sidekiq jobs from the
old queues to the new ones. This migration also takes care of doing the
inverse if ever needed. This does require downtime as otherwise new jobs
could be scheduled in the old queues after this migration completes.

This commit also includes an RSpec test that blacklists the use of the
"default" queue and ensures cron workers use the "cronjob" queue.

Fixes gitlab-org/gitlab-ce#23370
2016-10-21 18:17:07 +02:00
Robert Speicher 285172c33c Merge branch 'dz-rename-user-routes' into 'master'
Rename users routing from /u/:username to /users/:username for
consistency with other routes

Renames /u/:username to /users/:username

To follow consistency with other routes (like groups) and
UsersController name.
Now when you can use `/:username` for accessing user page there is no
need in shortcut like `/u/`

See merge request !6851
2016-10-17 20:47:46 +02:00
Rémy Coutable 11e40c0e26
Improve copy
Signed-off-by: Rémy Coutable <remy@rymai.me>
2016-10-17 10:10:13 +02:00
Achilleas Pipinellis a4fa44ce90 Merge branch 'master' into 'docs/change-docs-reviewers'
# Conflicts:
#   doc/development/doc_styleguide.md
2016-10-16 18:16:50 +00:00
Achilleas Pipinellis 5174b7ad7e Add the tech writers usernames in the doc_sytleguide doc
[ci skip]
2016-10-16 11:35:51 +02:00
De Wet Blomerus 54c0286a3f remove ashley since she no longer works here 2016-10-15 10:59:40 +02:00
Ahmad Sherif c180221a5b Add docs for request profiling
Closes #23239
2016-10-14 20:18:23 +02:00
Rémy Coutable b4810fd2bc
More improvements
Signed-off-by: Rémy Coutable <remy@rymai.me>
2016-10-13 19:40:20 +02:00
Rémy Coutable 3a1d9bccd6
Fix typo
Signed-off-by: Rémy Coutable <remy@rymai.me>
2016-10-13 19:38:38 +02:00
Rémy Coutable c1dd1795ed
Move the Grape DSL part from Doc styleguide to API styleguide
Also improve API styleguide

Signed-off-by: Rémy Coutable <remy@rymai.me>
2016-10-13 19:35:57 +02:00
Rémy Coutable b2c771f452
Add an API styleguide
Signed-off-by: Rémy Coutable <remy@rymai.me>
2016-10-13 18:44:52 +02:00
Dmitriy Zaporozhets cb7872c3a0
Remove /u/ prefix from user pages in documentation
Signed-off-by: Dmitriy Zaporozhets <dmitriy.zaporozhets@gmail.com>
2016-10-13 14:24:09 +03:00
Bryce Johnson abfb4f6e32 Document Capybara errors from es6 in es5 file. 2016-10-12 19:00:38 +02:00
Achilleas Pipinellis ce8aedf030 Add examples of fake tokens to be used in docs
[ci skip]
2016-10-11 15:39:14 +02:00
Rémy Coutable 52ca9bf600
Fix typo and add he MWBS accronym for "Merge When Build Succeeds"
Signed-off-by: Rémy Coutable <remy@rymai.me>
2016-10-07 16:17:28 +02:00
Rémy Coutable 2f7e28d1f7
Improve the contribution and MR review guide
Signed-off-by: Rémy Coutable <remy@rymai.me>
2016-10-07 15:28:15 +02:00
Rémy Coutable 21f0c27aac Merge branch 'creative-commons-zero' into 'master'
Added CC0 license to list of licenses

Adds a "license" (actually a deed, because its a dedication to the public domain) to the appropriate place in the documentation.

It adds another relevant license to our documentation.

See merge request !6622
2016-10-06 15:55:32 +00:00
Nick Thomas 267a96f3d4 Link to the "What requires downtime?" page from the Migration Style Guide
[ci skip]
2016-10-02 20:36:45 +01:00
Matt Lee 1553275ebc Added CC0 license to list of licenses 2016-09-29 17:00:21 -04:00
Connor Shea fc94c637b1 Update Frontend Docs based on feedback. 2016-09-21 19:21:38 -06:00
Connor Shea 059656ad21 Add a section on vue and one on supported browsers. 2016-09-21 19:02:19 -06:00
Connor Shea 7730ec2d1c Add Overview section detailing our frontend stack. [ci skip] 2016-09-21 19:02:18 -06:00
Connor Shea d4e2c4eff5 Add short Testing section, minor fixes. 2016-09-21 19:02:18 -06:00
Connor Shea 3b3e9d17b9 Add CSP and SRI information [ci skip] 2016-09-21 19:02:18 -06:00
Connor Shea 79c2f60e91 Further revisions/additions [ci skip] 2016-09-21 19:02:18 -06:00
Connor Shea ccbaed208b Add more information on page-specific JS.
[ci skip]
2016-09-21 19:02:18 -06:00
Connor Shea 182bcc977a Initial incomplete draft of the Frontend Development Guidelines.
[ci skip]
2016-09-21 19:02:18 -06:00
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