Commit Graph

207 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 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
Marcia Ramos 713cf0387b Merge branch 'patch-73' into 'master'
Add BrowserStack details to Frontend Dev Guide

See merge request gitlab-org/gitlab-ce!31744
2019-08-13 16:18:54 +00:00
Evan Read 98e65c130a Edits to event tracking topic 2019-08-13 08:20:57 +00:00
Luke Duncalfe ff7269276e Add BrowserStack details to Frontend Dev Guide 2019-08-12 23:40:09 +00: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 c237987843 Fix assorted links
Fix links as discovered by the lint in the docs project
2019-08-07 06:19:00 +00:00
Jeremy Jackson 23cc246066 Adds new tracking interface for snowplow
This will ultimately replace the stats.js that
exists in EE.
2019-08-01 05:28:15 +00:00
Marcel Amirault cc76259e8d Fix whitespace in ci docs
Many code blocks are 4spaced, and they render in GitLab
without coloring as a result, even though they are
fenced with a language label. If in a list, other items
will render as being in a code block too, even if not
meant to. This fixes all these issues for most docs in
/development, and cleans up other whitespace issues too
2019-07-31 08:28:51 +00:00
Marcel Amirault 74a34e8b7b Clean up headers in markdown
Some markdown headers needed tweaking to adhere
to standards, including blank lines above and below,
only one space after hash, first header should be
h1, and only one h1 per doc
2019-07-24 13:10:06 +00: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
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
Donald Cook f219b74433 CE backport: Removed non-decimal event values
Snowplow only accepts decimals for value
This MR removes sending of value implicitly with the value attribute
2019-07-16 12:44:15 +00: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
Marcel Amirault c6f943db44 Add blank lines around code blocks
All code blocks should be surrounded by blank lines
2019-07-12 08:09:23 +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 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
Evan Read d05eebe1dd Fix most bare URLs in project
Linting rule not enabled for now
because tooling produces false
positives.
2019-07-02 08:50:00 +00:00
czmj b1619b8340 Docs: minor fix to link format 2019-07-01 04:50:10 +00:00
David Pisek 490d521b65 Improve accessibility tooling documentation
Add links to useful browser extensions and learning resources to the
FE-accessibility documentation.
2019-06-27 17:15:19 +10:00
Natalia Tepluhina 0224aa4279 Added naming convention for .graphql files 2019-06-13 07:37:33 +00:00
Andrew Fontaine 8bea9eeddf Add a New Copy Button That Works in Modals
This copy button manages a local instance of the Clipboard plugin
specific to it, which means it is created/destroyed on the
creation/destruction of the component. This allows it to work well in
gitlab-ui modals, as the event listeners are bound on creation of the
button.

It also allows for bindings to the `container` option of the Clipboard
plugin, which allows it to work within the focus trap set by bootstrap's
modals.
2019-06-06 09:36:17 +00:00
Marcel Amirault b8c3339a46 Docs: Clean up links to remove ./ usage 2019-06-05 10:10:28 +00:00
Ondřej Budai ec0b681324 Fix badly rendered code blocks in JavaScript styleguide 2019-06-01 12:38:42 +00:00
Natalia Tepluhina ac02e49631 Added a note about v-slot directive 2019-05-28 14:03:27 +00:00
Clement Ho d5074b1d35 Merge branch 'fe-docs-utility-first' into 'master'
Add "utility-first" section to FE scss style guide

Closes gitlab-ui#38

See merge request gitlab-org/gitlab-ce!28312
2019-05-23 19:51:18 +00:00
Paul Slaughter 77e44ae7c1 Apply suggestion to doc/development/fe_guide/style_guide_scss.md 2019-05-22 15:09:30 +00:00
Clement Ho 5e53f25516 Merge branch 'patch-55' into 'master'
Docs: couple of improvements to the Vuex frontend guide

See merge request gitlab-org/gitlab-ce!28257
2019-05-15 22:46:21 +00:00
Paul Slaughter 631cf1e504
Add utility-first css section to fe docs 2019-05-14 11:13:22 -05:00
Paul Slaughter bb9f0f4f71
Clean up readability of utility class style guide 2019-05-14 11:13:22 -05:00
Natalia Tepluhina f226d9ab02 Update doc/development/fe_guide/graphql.md 2019-05-13 08:09:21 +00:00
Phillip Johnsen 1dcc79cb09 Couple of improvements to the Vuex frontend guide
Two nitpick improvements to the following:

* set `state.isAddingUser = false` when request resulted in an error,
  as it has finished after all
* be very explicit about vuex store being a local module to avoid confusion
  about a dependency named `store`
2019-05-10 22:53:02 +00:00
Marcel Amirault 0207468401 Docs: Merge EE doc/development to CE 2019-05-05 13:57:21 +00:00
Winnie Hellmann 044440e05e Create frontend FAQ (documentation) 2019-04-16 15:22:05 +00:00
Filipa Lacerda 7ec8871b57 Merge branch 'more-consistent-namespacing-vuex-example-code' into 'master'
Use RECEIVE namespace rather than REQUEST

See merge request gitlab-org/gitlab-ce!27130
2019-04-09 10:33:53 +00:00
Mark Florian 8e809033ea Fix page specific JavaScript link in documentation 2019-04-09 09:35:09 +00:00
Mark Florian 0efff5d18d Use RECEIVE namespace rather than REQUEST
This brings the mutation type name closer to the associated action,
so the documented example is more consistent.
2019-04-08 15:16:21 +00:00
Simon Knox a9346f332a Add docs to mention new util classes 2019-04-05 23:47:20 +11:00
Simon Knox c4c6dcb68c Add color util classes for backgrounds and text
We have a range of shades for most of the theme colors
Grouped them into color maps the same way Bootstrap does
for $grays already
Also add type scale utils
2019-04-04 00:54:32 +11:00
Filipa Lacerda 5343eb0600 Adds documentation about the utility classes 2019-04-02 10:56:32 +00:00
Phil Hughes 07e61875de
CE backport of design-management-upload-client 2019-04-02 09:34:17 +01:00
Marcel Amirault 29ba393004 Docs: Add automatic redirects to last batch of moved files 2019-03-26 17:21:22 +00:00
Simon Knox d7c92faacb Cleanup of fe_docs
Start moving back to regular fe_docs
Remove Initiatives, add section to index in fe_guide
Delete some no-longer-relevant parts from principles
Update title - Progressive Enchancement is a browser-support term
and could be confused
"When to use" parts are discussed elswhere
Vue & jQuery issue is no longer relevant
Delete duplicate Security docs
Remove empty files, move event_tracking
Shuffle index sections around
Remove sections on Vue & Webpack (we say same thing in prev paragraph)
Remove link to Droplab docs
2019-03-22 09:24:10 +11:00
Filipa Lacerda cbe69e4324 Updates how to export the state object 2019-03-10 19:24:04 +00:00
Marcel Amirault 9c8dc7ddf6 Docs: Fix broken anchors in development docs 2019-03-05 13:06:32 +00:00
Filipa Lacerda 4f5bb0886e Merge branch 'design-management-vue-app-ce' into 'master'
Port design-management-vue-app to CE

See merge request gitlab-org/gitlab-ce!25494
2019-02-25 09:40:42 +00:00
Takuya Noguchi e8fee6b8f7 Fix misspellings in docs
Signed-off-by: Takuya Noguchi <takninnovationresearch@gmail.com>
2019-02-25 10:31:35 +09:00
Evan Read eb86630959 Ensure all lists are surrounded by new lines
Markdown renderers find it easier to determine
where lists start and end when lists are surrounded
by new lines.

For consistency, also ensure entries in the list
are aligned when they span multipls lines.
2019-02-22 13:17:10 +00:00
Phil Hughes 6ed496a896
Port design-management-vue-app to CE 2019-02-22 12:54:06 +00:00