Commit Graph

6187 Commits

Author SHA1 Message Date
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
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 Peterse 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
Robert Schilling 3911e77eb4 Remove TODO for not documented stuff 2016-04-05 23:08:22 +02:00
Robert Speicher 6ffda88c97 Add a link back to Development documentation to Testing guide
[ci skip]
2016-04-01 20:36:59 -04:00
Robert Speicher 2e83b56203 Add a section about `let` to the Testing guide
[ci skip]
2016-04-01 20:31:16 -04:00
Robert Speicher 60f4081e13 Factories don't have to be limited to `ActiveRecord` objects
[ci skip]
2016-04-01 20:31:12 -04:00
Robert Speicher 0b9d9816f8 Add a note about Four-Phase Test to Testing guide
[ci skip]
2016-04-01 20:31:12 -04:00
Robert Speicher fb8b0041d8 First pass at a Testing styleguide
[ci skip]
2016-04-01 20:31:12 -04:00
connorshea 2c9f6cfa42 SCSS Style Guide fixes.
Fix a typo and add a section on ignoring issues.

[ci skip]
2016-03-23 14:39:12 -06:00
connorshea 8d8b457ceb Add SCSS Lint, CSSComb config file, run SCSS Lint in GitLab CI, add documentation for SCSS Style Guide.
See !3069 for more information.
2016-03-14 20:33:54 -06:00
Yorick Peterse d69dff5b4b Removed benchmark suite and its documentation
The rationale for this can be found in
https://gitlab.com/gitlab-org/gitlab-ce/issues/13718 but in short the
benchmark suite no longer serves a good purpose now that we have proper
production monitoring in place.

Fixes gitlab-org/gitlab-ce#13718
2016-03-10 11:15:43 +01:00
Yorick Peterse 059df2256e Added basic SQL guidelines
[ci skip]
2016-03-08 11:28:50 +01:00
Achilleas Pipinellis bfeab78ab5 Change doc styleguide to use quotes for notes
[ci skip]
2016-02-29 15:00:40 +02:00
Douwe Maan 17251cf447 Merge branch 'rs-development-docs' into 'master'
Add "Gotchas" to development docs

Also:

- Alphabetizes the "Developer" index page
- Fixes the broken `db_dump.md` link

See merge request !2846
2016-02-29 11:00:33 +00:00
Achilleas Pipinellis 83ba37e544 Merge branch 'fix_git_tag_in_architecture' into 'master'
Fixed ~git beeing displayed as link to issues tagged with git in architecture.md

The architecture documentation explains `~git` from the picture below which is replaced by a [link to issues tagged with `git`](https://gitlab.com/gitlab-org/gitlab-ce/issues?label_name=git). I believe that this was unintended and should be fixed by using backticks.

![Screenshot_from_2016-02-13_21-36-30](/uploads/5ea1a60e8b230952874e58eab0abe1ac/Screenshot_from_2016-02-13_21-36-30.png)

See merge request !2814
2016-02-24 20:16:50 +00:00
James Lopez af0ba6605b revert back to ruby 2.1 - use 2.1.8 2016-02-19 17:19:57 +01:00
James Lopez 83829c0902 revert back to ruby 2.1 2016-02-19 15:59:46 +01:00
Robert Speicher 0afe2e0513 Update Gotchas doc
[ci skip]
2016-02-17 15:35:28 -05:00
Rémy Coutable a4ffdf922d Merge branch 'master' of gitlab.com:gitlab-org/gitlab-ce 2016-02-17 17:33:09 +01:00
Robert Speicher 6053ad8474 Add "Gotchas" development doc 2016-02-16 22:09:00 -05:00
Robert Speicher e82b17fa43 Fix the "How to dump production data" link
[ci skip]
2016-02-16 21:31:42 -05:00
Robert Speicher 4a9d174b91 Alphabetize Development doc index
[ci skip]
2016-02-16 21:31:40 -05:00
Douwe Maan c29517aaf4 Merge branch 'offline-migration-docs' into 'master'
Add notice about offline migrations

/cc @sytses 

See merge request !1723
2016-02-15 11:43:50 +00:00
Finn Glöe 81ab172a25 Fixed ~git beeing displayed as link to issues tagged with git
[ci skip]
2016-02-13 23:59:38 +01:00
Prayag Verma b877afc371 Fix a typo [ci skip]
Remove extra `make`
2016-02-12 19:02:35 +05:30
Achilleas Pipinellis a95c6e38c6 Add ruby version update info in doc_styleguide
[ci skip]
2016-02-05 17:26:40 +02:00
James Lopez 3d81f1da6e Merge branch 'master' of gitlab.com:gitlab-org/gitlab-ce into update-ruby-2.2.4
# Conflicts:
#	.gitlab-ci.yml
2016-01-22 18:01:38 +01:00
James Lopez 1c51fb1778 update Ruby version to 2.2.4 (latest previous stable) and update docs 2016-01-21 16:12:49 +01:00
Achilleas Pipinellis 086cbca6bf Link to restart_gitlab.md and some more fixes
[ci skip]
2016-01-20 10:44:26 +01:00
Achilleas Pipinellis 9d756f3d8b Add document on restarting GitLab
[ci skip]
2016-01-20 10:33:59 +01:00
Achilleas Pipinellis 4eae95c03c Update doc_styleguide.md [ci skip]
- Fix some syntax/grammar typos
- Link to GFM documentation on newlines
- Be less strict on the alphabetical order styleguide
- You can override the "numbers in headings" rule if you discuss it first
- Do not mention CE in notes if the feature is in both CE and EE
2016-01-13 18:24:08 +01:00
Achilleas Pipinellis 20c327fcfd Clarify the naming guideline
[ci skip]
2016-01-12 16:19:11 +01:00
Achilleas Pipinellis d0b2d278f4 Move doc_styleguide in the development directory
[ci skip]
2016-01-12 11:57:42 +01:00
Anton Davydov d6e0a1883b Fix typos in all docs [skip ci] 2015-11-24 02:19:17 +03:00
Alex Jordan 3300db70ff Rewrite HTTP links to force TLS, where possible 2015-11-16 16:50:05 -08:00
Yorick Peterse 126a2428cd Updated profiling guides for Sherlock 2015-11-09 14:29:10 +01:00
Robert Speicher 312375ac7c Update Shell Commands doc for configurable git binary path 2015-11-03 17:10:17 -05:00
Kamil Trzciński 35b93f9d22 Add notice about offline migrations 2015-11-02 15:14:34 +00:00
Robert Schilling 98008a2db8 Fix typo in rake task doc 2015-10-31 22:56:24 +01:00
Jacob Vosmaer 5ff830cf32 Clarify puppies 2015-10-26 14:28:31 +01:00
Jacob Vosmaer 0b082b348b Start putting shared files in "shared" 2015-10-26 13:42:09 +01:00
Yorick Peterse 97e02f4bc9 Added documentation on the various profiling tools 2015-10-15 12:15:18 +02:00
Yorick Peterse 0bef64911b Added documentation for writing benchmarks 2015-10-05 11:32:22 +02:00
Stan Hu a73044320f Fix `rake services:doc` generation
[ci skip]
2015-09-03 20:54:16 +00:00
Dmitriy Zaporozhets 3e259ea8bc Revert "Merge branch 'revert-satellites' into 'master' "
This reverts commit 5daf44b7c8, reversing
changes made to 2f706fbd23.
2015-08-11 14:33:31 +02:00
Dmitriy Zaporozhets 9f10943c1a
Revert "Merge branch 'drop-satellites'"
This reverts commit 957e849f41, reversing
changes made to 6b9dbe9f5a.

Signed-off-by: Dmitriy Zaporozhets <dmitriy.zaporozhets@gmail.com>
2015-08-11 10:28:42 +02:00
Dmitriy Zaporozhets 66bdbdb35d
Remove satellites mention from architecture doc
Signed-off-by: Dmitriy Zaporozhets <dmitriy.zaporozhets@gmail.com>
2015-07-16 17:57:46 +02:00
Dmitriy Zaporozhets a87989fb7d Remove satellites 2015-07-15 15:45:57 +02:00
Dmitriy Zaporozhets e840ccaf15 Merge branch 'db-dump-instructions' into 'master'
Improve DB dump instructions

See merge request !1868
2015-06-16 09:33:45 +00:00
Jacob Vosmaer 6000c7199e Improve DB dump instructions 2015-06-16 10:00:02 +02:00
Douwe Maan 313438b327 Add info about regex anchors to shell command docs. 2015-06-12 16:17:04 +02:00
Jacob Vosmaer 5483c2b0a9 How to dump a production DB to staging 2015-05-18 13:37:43 +02:00
Valery Sizov 34a9aa2e8a update migration style guide 2015-05-12 14:34:43 +03:00
Sytse Sijbrandij 881e11df1b Small improvements to style guide. 2015-05-11 14:48:39 +00:00
Job van der Voort 6a6047f80c create migration style guide. Fixes #2305 2015-05-11 15:09:36 +02:00
Sytse Sijbrandij a2fb3711f0 Replace linux with GNU/Linux to recognize the work of Dr. Stallman. 2015-03-15 18:06:25 -07:00
Dmitriy Zaporozhets 69d2e1d829 Add UI guide to GitLab development help 2015-03-08 14:56:45 -07:00
Dmitriy Zaporozhets f850cff417 Update ci setup documenation 2015-03-02 18:34:29 -08:00
Jacob Vosmaer 4efe3cf556 More reasons why prefixing is good
Inspired by http://www.dwheeler.com/essays/filenames-in-shell.html
2015-02-26 18:25:59 +01:00
Jacob Vosmaer 93e42f690b Document fun facts about omnibus-gitlab 2015-02-19 11:20:58 +01:00
Ewan Edwards ad6c372eee Fix a number of discovered typos, capitalization of developer and
product names, plus a couple of instances of bad Markdown markup.
2015-02-03 15:18:40 -08:00
Jacob Vosmaer a63187f28b Don't create zombies with IO.popen
The previous recommend incantation would leave the process we read from
hanging around, even though it had finished. That gives you a
'defunct'/'zombie' process.
2015-01-22 15:53:16 +01:00
Jacob Vosmaer 82eb0a44d7 Add security tips about file and paths 2014-12-09 14:51:15 +01:00
Robert Schilling 369375d086 Move sidekiq debug docs to development folder 2014-12-07 01:24:03 +01:00
Sytse Sijbrandij 3dc25ba331 Remove warning from db seed since it is called by db setup. 2014-12-04 21:22:21 +01:00
Sytse Sijbrandij 704b7237e6 Fix notifications for developers that don't read the documentation. 2014-12-04 16:54:08 +01:00
Jacob Vosmaer 6491974554 Disable Sidekiq arguments logging by default 2014-12-01 18:58:37 +01:00
Marc Radulescu c85d4af889 remove unnecessarry image 2014-11-27 10:24:19 +01:00
Marc Radulescu 8ccaee1979 replaced hotlink 2014-11-26 20:54:42 +01:00
Marc Radulescu b82a205b74 added office analogy to help understanding of gitlab architecture 2014-11-26 18:51:12 +01:00
Achilleas Pipinellis c2bcdeb950 Make semaphore configuration an ordered list. 2014-10-15 20:52:39 +03:00
Achilleas Pipinellis b57ec54fae Point to correct project on githost.io. 2014-10-15 20:25:47 +03:00
Marin Jankovski 57b38f6f1c Describe who can trigger builds and where, add no red tests policy to contributing doc. 2014-10-15 12:48:37 +02:00
Ciro Santilli 7dcbf35019 Replace www.gitlab.com with about.gitlab.com 2014-10-07 13:16:19 +02:00
Jacob Vosmaer 97c5d38097 Add a counterexample to 'do it in Ruby' 2014-10-02 18:27:18 +02:00
Sytse Sijbrandij db2bb8c304 Add semaphore config to ci testing doc. 2014-09-19 13:23:53 +02:00
Dmitriy Zaporozhets c0cecdb08a Mention build script 2014-09-18 15:14:40 +00:00
Dmitriy Zaporozhets 175a913065
CI setup docs
Signed-off-by: Dmitriy Zaporozhets <dmitriy.zaporozhets@gmail.com>
2014-09-18 16:45:18 +03:00
Robert Schilling abdc442648 Fix spelling errors in doc, closes #7437
Further changes
2014-08-07 10:27:54 +02:00
Rob Taylor 38a692d20b Fixed typos in Development - Rake Tasks doc 2014-07-31 17:55:13 +01:00
Sytse Sijbrandij 6d0bfc922d Updated the picture based on comments. 2014-07-10 23:34:29 +02:00
Sytse Sijbrandij 2df7a7b204 Update the diagram and make clear that rails accesses the repo's via shell. 2014-07-10 18:54:25 +02:00
Ciro Santilli fd348de76d Update docs to markdown style guide. 2014-06-03 23:16:31 +02:00
Dmitriy Zaporozhets 7e10d10178 Add doc file for dev rake tasks 2014-04-24 19:53:18 +02:00
dosire 2a9eb02650 Also need to change the reference. 2014-04-08 12:38:24 +02:00
dosire 76ca5976de Remove nested images since they are not supported by https://gitlab.com/gitlab-com/doc-gitlab-com 2014-04-08 12:28:59 +02:00
Dmitriy Zaporozhets 0546a98981 Merge branch 'doc-readme-for-site' into 'master'
Doc-readme-for-site

New readme files for doc.gitlab.com
I also but the links for the api readme at the top.
2014-03-27 18:30:50 +00:00
Job van der Voort 3b3186d58b fix image not displaying in GitLab due to faulty markdown 2014-03-27 14:34:55 +00:00
dosire 417c0cb2d3 New doc site needs indexes. 2014-03-27 12:17:27 +01:00
Jacob Vosmaer 1fe07cfbae Merge branch 'attribution-for-shell-guide' into 'master'
Attribution For Shell Guide
2014-03-24 15:10:40 +00:00
dosire 842c0d6b5f Can deeplink after all. 2014-03-24 14:31:35 +01:00
dosire 00487d455a References for the issues the guide addresses. 2014-03-24 12:04:43 +01:00
Evgeniy Sokovikov 4f68e15d9e typo fix 2014-03-19 20:08:26 +03:00
dosire 509c45163a Update references to gitlab dot com. 2014-03-10 17:40:40 +01:00
Jacob Vosmaer 4c746c2522 Add shell commands guide 2014-02-25 11:53:01 +01:00
Jacob Vosmaer 464d820bc5 Domain sockets are the default, not TCP 2014-02-10 14:01:15 +01:00
Jacob Vosmaer e009e0203e Use one sentence per line in architecture.md 2014-02-10 13:59:30 +01:00
dosire c296ecfb59 Remove duplication with readme. Remove unneeded spaces. Prevent people writing ~git in the documentation. Descriptive headers. 2014-02-04 14:49:06 +01:00
Sam Gleske d030f62e4b adding ref from structure to architecture 2014-01-29 09:17:58 -05:00
Sam Gleske 3235d2c342 Clarifying web frontend direct file access
Rewrite how Apache/nginx interacts with precompiled assets.
2014-01-28 22:12:51 -05:00
Sam Gleske 794461c835 update links for gitlab.com 2014-01-28 21:21:15 -05:00
Sam Gleske 3671984b24 An architectural overview of GitLab
This is to help new admins of GitLab understand what components
are involved in making GitLab work.
2014-01-28 10:10:25 -05:00
Dmitriy Zaporozhets 7cc8459d43
Start writing doc about GitLab architecture for developers
Signed-off-by: Dmitriy Zaporozhets <dmitriy.zaporozhets@gmail.com>
2013-11-25 11:47:55 +02:00