Commit Graph

28 Commits

Author SHA1 Message Date
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
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 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
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
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
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 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
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
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
Mark Lapierre 09d7f0c0e0 Update docs on how to run E2E tests
Make instructions on how to run the E2E tests against GDK more
explicit and easier to find.
2019-06-19 00:22:23 +00:00
Rémy Coutable 63043b6fb6 Merge branch 'docs-qa-ml-fix-list-rendering' into 'master'
Fix list rendering on docs site

See merge request gitlab-org/gitlab-ce!29738
2019-06-17 15:16:26 +00:00
Walmyr 7bfe9ae2fb Turn single line code into blocks
To improve doc readability.

Closes https://gitlab.com/gitlab-org/gitlab-ce/issues/62506
2019-06-17 12:13:25 +00:00
Mark Lapierre 657760ba52 Fix list rendering on docs site 2019-06-17 03:07:32 +00:00
Walmyr 8769eef340 Backport of EE changes from MR 13763
https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/13763
2019-06-14 05:07:29 +00:00
Walmyr 407029a4c5 Update guide with alphabetical order style
Closes https://gitlab.com/gitlab-org/gitlab-ce/issues/62505
2019-06-12 23:45:40 +00:00
Yoginth 88bb6b1d74 Fix Typos 2019-06-12 15:51:29 +00:00
ddavison e61495610d
Documentation for dynamic element validation
First iteration on the documentation for how
dynamic element validation works within the
GitLab QA framework and how to utilize it
2019-06-05 16:14:47 -07:00
ddavison eb066f649b
Consolidate documentation written for e2e tests under dev docs
Previously the documentation was separated.  If we want to bake
quality into the product, how better than to include everything
we use directly in the development documentation

Signed-off-by: ddavison <ddavison@gitlab.com>

Fix broken internal doc link

Move documentation for page objects to the e2e section
2019-05-30 22:10:33 -07:00