Commit Graph

180 Commits

Author SHA1 Message Date
Marcel Amirault d7d218628f Fix markdown in various docs
Clean up issues that may cause the docs-lint
test to fail, such as trailing whitespace, no
EOF newline, blockquotes, etc
2019-08-28 06:06:34 +00:00
Marcel Amirault d936e8644c Add docs exceptions to two pipeline jobs 2019-08-22 11:56:14 +00:00
Winnie Hellmann a5b14d8231 Add diagrams for frontend testing levels (docs) 2019-08-21 09:28:13 +00:00
Winnie Hellmann f69dba8f10 Fix code blocks in frontend testing guide (docs) 2019-08-21 02:02:23 +00:00
Lin Jen-Shin 9e6a8bb93b Merge branch 'docs-testing-n-1-request-sepcs' into 'master'
Docs: Require request specs when testing N+1 for controllers

See merge request gitlab-org/gitlab-ce!31940
2019-08-20 11:35:21 +00:00
Thong Kuah 3b7df66eef Require request specs when testing N+1 for controllers 2019-08-20 23:12:48 +12:00
Winnie Hellmann 49ea1a64c8 Combine old and new frontend testing guide (docs) 2019-08-20 01:43:13 +00:00
Marcel Amirault 3bc0a1185c Standardize markdown in dev and workflow
Delete trailing whitespace, fix blockquotes, fix note
boxes, with indentation, clean up tables, etc.
2019-08-19 23:41:23 +00:00
Evan Read 40c9edf69e Merge branch 'docs-testing-guide-update' into 'master'
Docs fixup: Remove reference to old lib/api/ci dir

See merge request gitlab-org/gitlab-ce!31937
2019-08-19 06:38:26 +00:00
Evan Read fd3d2a6811 Merge branch 'doc-be_like_time' into 'master'
Add `be_like_time` matcher to Testing Styleguide

See merge request gitlab-org/gitlab-ce!31833
2019-08-19 06:33:14 +00:00
Evan Read 149cf5a39f Merge branch 'remove-mysql-from-dev-docs' into 'master'
Remove MySQL references from development docs

See merge request gitlab-org/gitlab-ce!31712
2019-08-19 00:23:48 +00:00
Luke Duncalfe c2c86e3514 Add `be_like_time` matcher to Testing Styleguide 2019-08-19 09:04:43 +12:00
Thong Kuah 90170ab1a7 Remove reference to old lib/api/ci dir
This directory no longer exists (since 2017)
2019-08-17 21:53:46 +00:00
Nick Thomas 5a574883f9
Remove MySQL references from development docs
I noticed the doc/development/testing_guide/best_practices.md still
referenced the `[run mysql]` tags, etc. They no longer work, so I
removed them, then realised I had better clean up the rest of
doc/development !
2019-08-16 14:05:08 +01:00
Bob Van Landuyt fe0ab065c4 Merge branch 'allow-focus-in-specs' into 'master'
Allow to use focus: true in specs

See merge request gitlab-org/gitlab-ce!31691
2019-08-15 08:04:38 +00:00
Giorgenes Gelatti dd84b9a03d Mention focus: true in the specs 2019-08-13 10:41:52 +10:00
Marcel Amirault 60dfca155c Add more rules to markdown lint check
Adds MD010 (Hard tabs), MD012 (blank lines), MD029 (ordered
list prefix), MD030 (spaces after list markers), and fixes
remaining docs that were failing these tests
2019-08-12 04:23:01 +00:00
Marcel Amirault 61e1a14925 Expand markdown linting rules for docs
MD002 - First header should be level 1
MD006 - Start bullets at beginning of line
MD019 - No multiple spaces after header style
MD022 - Headers surrounded by blank lines
MD025 - Only 1 level 1 header
MD028 - No blank lines within blockquote
MD038 - Spaces inside code span elements
2019-08-05 02:13:46 +00:00
Walmyr 2db7436aad Merge branch 'docs/update-end-to-end-style-guide' into 'master'
Update end-to-end style guide doc with new guideline

See merge request gitlab-org/gitlab-ce!31342
2019-08-02 12:05:02 +00:00
Stan Hu a3e18e7c97 Use Mermaid Markdown for testing guide docs
* Remove PNGs in favor of dynamically rendered graphs
* Eliminate <b> styling because this is no longer supported
* Change <br /> to <br> because the latter is only supported
* Add quotes around subgraph titles
2019-08-01 10:18:59 -07:00
Rémy Coutable aaefcb9c7e
Document the current state of the Review App clusters
Signed-off-by: Rémy Coutable <remy@rymai.me>
2019-08-01 17:53:03 +02:00
Walmyr Lima f26bb243cc Update e2e style guide with new guideline 2019-08-01 12:51:03 +02:00
Walmyr Lima 25cfdd69d3 Update sections titles with right heading 2019-07-31 15:50:34 +02:00
Marcel Amirault 0f7d8c0421 Update links to relative
Following the single docs codebase change, all internal links
should be relative. Also cleans up one table
2019-07-25 22:49:13 +00:00
Phil Hughes b83a4f8327 Merge branch '64722-mg-export-frontend-fixtures' into 'master'
Resolve "Export frontend fixtures as pipeline artifact"

Closes #64722 and #59166

See merge request gitlab-org/gitlab-ce!30917
2019-07-19 14:23:41 +00:00
Mike Greiling 97b8f85e03
Move frontend fixtures into spec/frontend
Moves every fixture source file from
spec/javascripts to spec/frontend
2019-07-19 02:27:15 -05:00
Mike Greiling faa17d5263
Rename the karma:fixtures task
Introduces frontend:fixtures rake task to replace
karma:fixtures and update documentation and CI scripts
to match
2019-07-19 02:27:14 -05:00
Marcel Amirault 7da80b2d36 Update numbered lists for docs standards
Ensure that all numbered lists use only 1. and no other numbers.
Also ensure that numbered lists use proper spacing.
2019-07-19 02:20:32 +00:00
Dan Davison 0604390a11 Fix QA documentation to refer to perform method
The documentation referred to the .act method
This MR changes this to refer to the preferred
.perform method
2019-07-18 19:21:02 +00:00
Marcel Amirault 746f547877 Fix unordered list spacing
Correct the spacing of unordered markdown lists
in docs, to maintain standards of documentation.
2019-07-18 01:15:58 +00:00
Dan Davison a7e16ee208 Add documentation surrounding [data-qa-selector]
Documentation was lacking for the [data-qa-selector]
method of defining methods vs .qa-selector method.
2019-07-17 19:30:00 +00:00
Martin Hanzel e424fcedcc Add docs about auto-injected Jest mocks 2019-07-17 17:47:19 +00:00
ddavison 18b3f530fc
Add an appropriate solution in documentation
A "bad" example was given, however no solution was provided
for fixing the bad example
2019-07-15 15:29:20 -07:00
Marcel Amirault 4121c63676 Remove extra blank lines from docs
Removing extra blank lines in docs that serve
no purpose, as well as some --- lines that also
are not needed.
2019-07-15 01:04:35 +00:00
Walmyr Lima c53d9e7278 Fix link on end-to-end quick start guide doc 2019-07-12 18:20:21 +02:00
Marcel Amirault 143872fa52 Remove trailing whitespace in docs
Remove unneeded trailing whitespace in lines in
/development /ci /api and /administration docs.
2019-07-12 08:15:38 +00:00
Marcel Amirault 347a879909 Update redirected links to final destination
Updating redirected links in the development, install, policy
raketasks and university dirs. Should now link to final
URL to avoid redirect hops
2019-07-09 00:20:40 +00:00
Evan Read 4f93fa4b7d Add lint rule that headings must increment one level at a time
Also fixes instances in Markdown that broke the rule.
2019-07-08 11:07:07 +00:00
Marcel Amirault 6feda1df3b Change absolute links to relative
Change assorted absolute links to ce and ee docs
to relative links
2019-07-05 16:25:58 +00:00
Marcel Amirault e108f0d961 Small markdown tweaks to clear kramdown warnings
Fixing square brackets, links, etc in:
  merge_requests.md
  vulnerabilities.md
  issues.md
  issues_statistics.md
  pipelines.md
  services.md
  group_milestones.md
  milestones.md
  runners.md
  changelog.md
  issue_workflow.md
  elasticsearch.md
  api_graphql_styleguide.md
  automatic_ce_ee_merge.md
  file_storage.md
  architecture.md
  database_debugging.md
  index.md
  index.md
  frontend_testing.md
  pry_debugging.md
  vue.md
  development_process.md
2019-07-04 22:46:12 +00:00
Rémy Coutable 77212dd5ec Merge branch 'update-sidekiq-inline-testing-docs' into 'master'
Change docs to recommend perform_enqueued_jobs instead of Sidekiq::Testing.inline!

See merge request gitlab-org/gitlab-ce!29845
2019-07-01 15:28:12 +00:00
Marcel Amirault 20654fb9bf Enforce consistent prefix for bullet lists
Adjusts asterisks to hyphens in assorted docs to allow lint rule to pass
2019-07-01 03:36:23 +00:00
Walmyr Lima e6257e43cb Fix typo on end-to-end quick start guide 2019-06-27 17:18:19 +02:00
Walmyr Lima 4767dda56c Backport of EE MR
https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/14320
2019-06-27 12:38:38 +02:00
Winnie Hellmann 6ca0f281fb Document limitations of jsdom 2019-06-26 11:39:30 +00:00
Winnie Hellmann 1eccad79c1 Clarify that this.something is not available in Jest (docs) 2019-06-25 15:37:41 +00:00
Winnie Hellmann 4a125e97cc Clarify that Jest does not use Webpack (docs) 2019-06-25 15:28:33 +00:00
Evan Read e128239340 Add Markdown linting
Also adds and one linting rule
and makes project conform to it.
2019-06-25 04:34:55 +00:00
Mark Lapierre 61a2ed5d0e Merge branch 'docs-ml-gdk-how-to-more-info' into 'master'
Update docs on how to run E2E tests

See merge request gitlab-org/gitlab-ce!29823
2019-06-20 21:37:44 +00:00
Walmyr Lima 02eece7539 Backport EE MR
https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/14280
2019-06-19 16:01:27 +02:00