Commit Graph
151 Commits
Author SHA1 Message Date
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
Peter Dave Hello 9e6f99744e optimize png images losslessly using zopflipng 2016-06-29 19:22:15 +08:00
Achilleas Pipinellis 365015e3c9 Merge branch 'gitlab_architecture' into 'master'
Refactor GitLab architecture document

Closes https://gitlab.com/gitlab-org/gitlab-ce/issues/14236

See merge request !3694
2016-06-28 10:34:46 +00:00
Chris Wilson 5eba2670c7 Add "GitLab team members only" to diagram link 2016-06-28 03:12:26 +00:00
Takuya Noguchi 6206f7f0a8 Fix dead links in the docs 2016-06-26 12:43:10 +09:00
Robert Speicher 9e43fc151b Merge branch 'hamlit-test' into 'master'
Replace Haml with Hamlit

What this change does:
- It replaces HAML with [Hamlit](https://github.com/k0kubun/hamlit), a much more efficient implementation of HAML.
- It removes `haml-rails`.
- It adds `hamlit.rb` and removes `haml.rb`.
- It makes things faster and less memory-hungry!

See also #13201.

See merge request !3666
2016-06-23 23:51:08 +00:00
Connor Shea 262f902d9a Restrict hamlit version, remove coffeescript filters. 2016-06-23 15:54:23 -06:00
Achilleas Pipinellis b7c7ebee59 Merge branch 'document-emoji-rake-tasks' into 'master'
Added basic docs for the Emoji Rake tasks

## What does this MR do?

This MR adds basic documentation for the two Emoji Rake tasks.

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

Spelling, that sort of thing.

## Why was this MR needed?

These Rake tasks only had some small amount of source level documentation.

## What are the relevant issue numbers?

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

## 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)
- [ ] 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 !4877
2016-06-23 19:37:46 +00:00
Yorick Peterse a5670cd59b Added basic docs for the Emoji Rake tasks
Fixes gitlab-org/gitlab-ce#14794 gitlab-com/performance#13

[ci skip]
2016-06-23 16:17:49 +02:00
Drew Blessing 8d96bae6db Remove Rubocop skip comment from migration style guide [ci skip] 2016-06-23 09:01:04 -05:00
Chris Wilson bb5a6e3c51 Update GitLab architecture diagram, include Google draw link
[ci skip]
2016-06-23 02:21:39 +00:00
Achilleas Pipinellis dd417699a3 Add styleguide on configuration settings documentation
[ci skip]
2016-06-20 13:32:54 +02:00
Yorick PeterseandRobert Speicher be3b878443 Track method call times/counts as a single metric
Previously we'd create a separate Metric instance for every method call
that would exceed the method call threshold. This is problematic because
it doesn't provide us with information to accurately get the _total_
execution time of a particular method. For example, if the method
"Foo#bar" was called 4 times with a runtime of ~10 milliseconds we'd end
up with 4 different Metric instances. If we were to then get the
average/95th percentile/etc of the timings this would be roughly 10
milliseconds. However, the _actual_ total time spent in this method
would be around 40 milliseconds.

To solve this problem we now create a single Metric instance per method.
This Metric instance contains the _total_ real/CPU time and the call
count for every instrumented method.
2016-06-17 13:09:55 -04:00
Drew Blessing 8033afd817 Update migration_style_guide.md with new details 2016-06-15 21:38:12 +00:00
Paco Guzman dadc531353 Instrument private/protected methods
By default instrumentation will instrument public,
protected and private methods, because usually
heavy work is done on private method or at least
that’s what facts is showing
2016-06-14 15:17:51 +02:00
Paco Guzman 120fbbd487 Measure CPU time for instrumented methods 2016-06-14 12:49:31 +02:00
Achilleas Pipinellis aa48eeef17 Merge branch 'doc-styleguide-move-locations' into 'master'
Add guide on changing a document's location

## What does this MR do?

Add a documentation styleguide when changing a document's location.

## What are the relevant issue numbers?

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


See merge request !4624
2016-06-13 13:26:43 +00:00
Achilleas Pipinellis cb7fa10cb5 Change to new Notes styleguide
[ci skip]
2016-06-13 15:04:22 +02:00
Achilleas Pipinellis d1abbb3b66 Add guide on changing a document's location
[ci skip]
2016-06-13 15:00:28 +02:00
Dmitriy Zaporozhets 366ad9ff72 Reject idea of using white/gray button depends on bg color
Signed-off-by: Dmitriy Zaporozhets <dmitriy.zaporozhets@gmail.com>
2016-06-08 17:11:43 +03:00
Connor Shea b2e85b7968 Add relevant commands to the licensing document, resolve some feedback. 2016-06-06 13:39:36 -06:00
Connor Shea 7045b9e908 Make sure to mention the GNU Project and OSI-provided information regarding the GPL so no one tries to disagree with that decision. 2016-06-06 13:39:36 -06:00
Connor Shea 3c32341215 Add Licensing information and guidelines to the Documentation. 2016-06-06 13:39:36 -06:00
Dmitriy Zaporozhets 814b26cfc3 Fix typo
Signed-off-by: Dmitriy Zaporozhets <dmitriy.zaporozhets@gmail.com>
2016-06-02 23:04:08 +03:00
Dmitriy Zaporozhets 33c499441a Add icons and buttons to UI guide
Signed-off-by: Dmitriy Zaporozhets <dmitriy.zaporozhets@gmail.com>
2016-06-02 22:43:02 +03:00
Chris Spicer 348d16f524 updtae -> update 2016-05-29 22:31:39 -07:00
Jacob Schatz 42e55585bb Merge branch 'dz-improve-ui-guide' into 'master'
Write some thoughts to the UI guide

cc @skyruler 

See merge request !4290
2016-05-25 19:55:14 +00:00
Jacob Schatz 16817cc49f Fix the english. 2016-05-25 14:57:15 -04:00
Dmitriy Zaporozhets f7da994cfd Write some thoughts to the UI guide
Signed-off-by: Dmitriy Zaporozhets <dmitriy.zaporozhets@gmail.com>
2016-05-25 20:44:02 +02:00
Robert Speicher 75739e54be Enable RSpec/NotToNot cop and auto-correct offenses
Also removes the note from the development/testing.md guide
2016-05-24 15:40:29 -04:00
Robert Speicher 883e2d2187 Merge branch 'migration-helpers' into 'master'
Added helper methods for database migrations

These helpers can ultimately be used to write migrations that don't
require downtime.

See #15464 for more information.

See merge request !3860
2016-05-19 16:49:14 +00:00
Achilleas Pipinellis 9eb4569ed9 Change all occurrences of doc.gitlab.com to docs.gitlab.com
[ci skip]
2016-05-13 16:26:56 -05:00
Yorick Peterse e8efaca23c Updated migration styleguide for new helpers 2016-05-12 13:03:55 +02:00
Rémy Coutable 898f613072 Merge branch 'document-adding-instrumentation' into 'master'
Added documentation on how to instrument methods

This will hopefully remove me as a single point of failure when it comes to adding instrumentation.

cc @axil @rspeicher 

See merge request !4035
2016-05-09 12:52:53 +00:00
Robert Speicher df9a7c6b4a Add a note to testing docs about the :each argument to RSpec hooks
[ci skip]
2016-05-05 17:22:18 -04:00
Yorick Peterse e449a6c05c Added documentation on how to instrument methods
[ci skip]
2016-05-05 19:26:41 +02:00
Yorick Peterse 70551217a6 Fixed username links in the performance guide
These would end up being rendered as:

    <a href="...">@yorickpeterse</a>
    <a href="...">@yorickpeterse</a>

[ci skip]
2016-05-04 13:17:43 +02:00
Achilleas Pipinellis 8bd793c9c5 Copyedit performance document
[ci skip]
2016-05-03 20:47:38 +03:00
Yorick Peterse b47a84b4be Added performance guidelines
Fixes gitlab-org/gitlab-ce#15254 gitlab-org/gitlab-ce#14277

[ci skip]
2016-04-30 02:10:25 +02:00
Yorick Peterse a54af831ba Use rake db:reset instead of db:setup
Using db:reset ensures existing tables are first dropped. This in turn
ensures that we can drop tables regardless of any foreign key
constraints. While CE currently doesn't have any foreign keys EE defines
the following relation:

    remote_mirrors.project_id -> projects.id

MySQL will complain whenever you try to drop the "projects" table first
even when using "DROP TABLE ... CASCADE".
2016-04-14 15:53:54 +02:00
Achilleas Pipinellis fd9eb4036c Replace GitLab architecture diagram
[ci skip]
2016-04-13 12:39:11 +03:00
Yorick Peterse 15cbbd09fb Merge branch 'metrics-measure-block-transaction' into 'master'
Store block timings as transaction values

See merge request !3649
2016-04-11 13:16:58 +00:00
Yorick Peterse d9110a7eca Track call counts in Gitlab::Metrics.measure_block 2016-04-11 13:27:52 +02:00
Yorick Peterse 16926a676b Store block timings as transaction values
This makes it easier to query, simplifies the code, and makes it
possible to figure out what transaction the data belongs to (simply
because it's now stored _in_ the transaction).

This new setup keeps track of both the real/wall time _and_ CPU time
spent in a block, both measured using milliseconds (to keep all units
the same).
2016-04-11 13:09:36 +02:00
Robert Speicher 0c6923e2d1 Re-add a note about sarcasm to the Code Review guide
[ci skip]
2016-04-10 22:54:44 -04:00
Robert Speicher c7ec5929b1 First pass at a Code Review guide
Largely borrowed from thoughtbot's code review guide, so attribution is
included.

[ci skip]
2016-04-09 21:49:47 -04:00
Robert Speicher cedcc1453c Minor Testing guide copyedits
[ci skip]
2016-04-09 01:19:21 -04:00
Dmitriy Zaporozhets 4a1fdc78a4 Merge branch 'remove-todo' into 'master'
Remove TODO for not documented stuff

We should not put a `TODO` in a released product.

See merge request !3553
2016-04-08 17:42:53 +00:00
Dmitriy Zaporozhets 0396c8525c Merge branch 'rs-testing-guide' into 'master'
First pass at a Testing styleguide

Closes https://gitlab.com/gitlab-org/gitlab-ce/issues/14121

[ci skip]

See merge request !3465
2016-04-08 17:34:55 +00:00
Yorick Peterse 352bc7d2b9 Added dev guide for measuring Ruby blocks 2016-04-06 14:32:27 +02:00