Combine frontend style guides - docs
Feature branch to merge !20010 (merged) and !20045 (merged) cleanly.
What does this MR do?
We have two frontend style guides. They are located here:
- https://docs.gitlab.com/ee/development/fe_guide/#style-guides
- https://docs.gitlab.com/ee/development/new_fe_guide/style/
This change merges the two together into a single style guide.
It attempts to minimise any alterations on the content, apart from to deduplicate or provide clarification wherever the need had arisen from the merging of the two guides.
Summary of the changes:
old location | new location |
---|---|
new_fe_guide/style/javascript.md JS section |
fe_guide/style/javascript.md |
new_fe_guide/style/javascript.md ESLint section |
fe_guide/tooling.md |
new_fe_guide/style/vue.md |
empty, so removed |
new_fe_guide/style/scss.md |
empty, so removed |
new_fe_guide/style/prettier.md |
fe_guide/tooling.md |
fe_guide/style_guide_js.md JS section |
fe_guide/style/javascript.md |
fe_guide/style_guide_js.md ESLint section |
fe_guide/tooling.md |
fe_guide/style_guide_js.md Vue section |
fe_guide/style/vue.md |
fe_guide/style_guide_scss.md |
fe_guide/style/scss.md |
Links have been updated.
Redirect pages were not included in this MR since it made the diff viewer include a lot of non-changes. These have been separated into another MR.
Two related MRs
- One code change related to the docs move: !17573 (merged)
- Reinstating the redirect pages !20045 (merged)
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
- [n/a] Make sure the old link is not removed and has its contents replaced with a link to the new location. In a separate MR, as discussed above.
-
Make sure internal links pointing to the document in question are not broken. - [n/a] Search and replace any links referring to old docs in GitLab Rails app,
specifically under the
app/views/
andee/app/views
(for GitLab EE) directories. In a separate MR, as mentioned above. -
Make sure to add redirect_from
to the new document if there are any Disqus comments on the old document thread. - [n/a] Update the link in
features.yml
(if applicable) - [n/a] 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 🤖 GitLab Bot 🤖