Skip to content

Dev docs - merge style guides for fe_guide and new_fe_guide

Tristan Read requested to merge tr-combine-frontend-style-guides into master

We have two frontend style guides. They are located here:

This change merges the two together into a single style guide.

It does not attempt to improve/iterate on the content, apart from to deduplicate or provide clarification wherever the need had arisen from the merging of the two guides.

It also moves one file about Prettier formatting into a new section - Tooling.

Related issues

Closes gitlab-org/frontend/general#25 (closed)

Moving docs to a new location?

Read the guidelines: https://docs.gitlab.com/ee/development/documentation/index.html#changing-document-location

  • Make sure the old link is not removed and has its contents replaced with a link to the new location.
  • Make sure internal links pointing to the document in question are not broken.
  • Search and replace any links referring to old docs in GitLab Rails app, specifically under the app/views/ and ee/app/views (for GitLab EE) directories.
  • Make sure to add redirect_from to the new document if there are any Disqus comments on the old document thread.
  • Update the link in features.yml (if applicable)
  • If working on CE and the ee-compat-check jobs fails, submit an MR to EE with the changes as well (https://docs.gitlab.com/ce/development/documentation/index.html#cherry-picking-from-ce-to-ee).
  • Ping one of the technical writers for review.
Edited by Tristan Read

Merge request reports