Add new frontend guide structure
This commit is contained in:
parent
7c7057590a
commit
04c7083ac9
18 changed files with 111 additions and 0 deletions
3
doc/development/new_fe_guide/dependencies.md
Normal file
3
doc/development/new_fe_guide/dependencies.md
Normal file
|
@ -0,0 +1,3 @@
|
||||||
|
# Dependencies
|
||||||
|
|
||||||
|
> TODO: Add Dependencies
|
|
@ -0,0 +1,3 @@
|
||||||
|
# Accessibility
|
||||||
|
|
||||||
|
> TODO: Add content
|
3
doc/development/new_fe_guide/development/components.md
Normal file
3
doc/development/new_fe_guide/development/components.md
Normal file
|
@ -0,0 +1,3 @@
|
||||||
|
# Components
|
||||||
|
|
||||||
|
> TODO: Add content
|
|
@ -0,0 +1,3 @@
|
||||||
|
# Design patterns
|
||||||
|
|
||||||
|
> TODO: Add content
|
29
doc/development/new_fe_guide/development/index.md
Normal file
29
doc/development/new_fe_guide/development/index.md
Normal file
|
@ -0,0 +1,29 @@
|
||||||
|
# Development
|
||||||
|
|
||||||
|
## [Design patterns](design_patterns.md)
|
||||||
|
|
||||||
|
Examples of proven design patterns used in our codebase.
|
||||||
|
|
||||||
|
## [Components](components.md)
|
||||||
|
|
||||||
|
Documentation on existing components and how to best create a new component.
|
||||||
|
|
||||||
|
## [Accessiblity](accessibility.md)
|
||||||
|
|
||||||
|
Learn how to implement an accessible frontend.
|
||||||
|
|
||||||
|
## [Network requests](network_requests.md)
|
||||||
|
|
||||||
|
Learn how to handle network requests in our codebase.
|
||||||
|
|
||||||
|
## [Security](security.md)
|
||||||
|
|
||||||
|
Learn how to ensure that our frontend is secure.
|
||||||
|
|
||||||
|
## [Performance](performance.md)
|
||||||
|
|
||||||
|
Learn how to keep our frontend performant.
|
||||||
|
|
||||||
|
## [Testing](testing.md)
|
||||||
|
|
||||||
|
Learn how to keep our frontend tested.
|
|
@ -0,0 +1,3 @@
|
||||||
|
# Network requests
|
||||||
|
|
||||||
|
> TODO: Add content
|
3
doc/development/new_fe_guide/development/performance.md
Normal file
3
doc/development/new_fe_guide/development/performance.md
Normal file
|
@ -0,0 +1,3 @@
|
||||||
|
# Performance
|
||||||
|
|
||||||
|
> TODO: Add content
|
3
doc/development/new_fe_guide/development/security.md
Normal file
3
doc/development/new_fe_guide/development/security.md
Normal file
|
@ -0,0 +1,3 @@
|
||||||
|
# Security
|
||||||
|
|
||||||
|
> TODO: Add content
|
3
doc/development/new_fe_guide/development/testing.md
Normal file
3
doc/development/new_fe_guide/development/testing.md
Normal file
|
@ -0,0 +1,3 @@
|
||||||
|
# Testing
|
||||||
|
|
||||||
|
> TODO: Add content
|
28
doc/development/new_fe_guide/index.md
Normal file
28
doc/development/new_fe_guide/index.md
Normal file
|
@ -0,0 +1,28 @@
|
||||||
|
# Frontend Development Guidelines
|
||||||
|
|
||||||
|
This guide contains all the information to successfully contribute to GitLab's frontend.
|
||||||
|
This is a living document, and we welcome contributions, feedback and suggestions.
|
||||||
|
|
||||||
|
## [Principles](principles.md)
|
||||||
|
|
||||||
|
Ensure that your frontend contribution starts off in the right direction.
|
||||||
|
|
||||||
|
## [Initiatives](initiatives.md)
|
||||||
|
|
||||||
|
High level overview of where we are going from a frontend perspective.
|
||||||
|
|
||||||
|
## [Development](development/index.md)
|
||||||
|
|
||||||
|
Guidance on topics related to development.
|
||||||
|
|
||||||
|
## [Dependencies](dependencies.md)
|
||||||
|
|
||||||
|
Learn about all the dependencies that make up our frontend, including some of our own custom built libraries.
|
||||||
|
|
||||||
|
## [Style](style/index.md)
|
||||||
|
|
||||||
|
Style guides to keep our code consistent.
|
||||||
|
|
||||||
|
## [Tips](tips.md)
|
||||||
|
|
||||||
|
Tips from our frontend team to develop more efficiently and effectively.
|
3
doc/development/new_fe_guide/initiatives.md
Normal file
3
doc/development/new_fe_guide/initiatives.md
Normal file
|
@ -0,0 +1,3 @@
|
||||||
|
# Initiatives
|
||||||
|
|
||||||
|
> TODO: Add Initiatives
|
3
doc/development/new_fe_guide/principles.md
Normal file
3
doc/development/new_fe_guide/principles.md
Normal file
|
@ -0,0 +1,3 @@
|
||||||
|
# Principles
|
||||||
|
|
||||||
|
> TODO: Add principles
|
3
doc/development/new_fe_guide/style/html.md
Normal file
3
doc/development/new_fe_guide/style/html.md
Normal file
|
@ -0,0 +1,3 @@
|
||||||
|
# HTML style guide
|
||||||
|
|
||||||
|
> TODO: Add content
|
9
doc/development/new_fe_guide/style/index.md
Normal file
9
doc/development/new_fe_guide/style/index.md
Normal file
|
@ -0,0 +1,9 @@
|
||||||
|
# Style
|
||||||
|
|
||||||
|
## [HTML style guide](html.md)
|
||||||
|
|
||||||
|
## [SCSS style guide](scss.md)
|
||||||
|
|
||||||
|
## [JavaScript style guide](javascript.md)
|
||||||
|
|
||||||
|
## [Vue style guide](vue.md)
|
3
doc/development/new_fe_guide/style/javascript.md
Normal file
3
doc/development/new_fe_guide/style/javascript.md
Normal file
|
@ -0,0 +1,3 @@
|
||||||
|
# JavaScript style guide
|
||||||
|
|
||||||
|
> TODO: Add content
|
3
doc/development/new_fe_guide/style/scss.md
Normal file
3
doc/development/new_fe_guide/style/scss.md
Normal file
|
@ -0,0 +1,3 @@
|
||||||
|
# SCSS style guide
|
||||||
|
|
||||||
|
> TODO: Add content
|
3
doc/development/new_fe_guide/style/vue.md
Normal file
3
doc/development/new_fe_guide/style/vue.md
Normal file
|
@ -0,0 +1,3 @@
|
||||||
|
# Vue style guide
|
||||||
|
|
||||||
|
> TODO: Add content
|
3
doc/development/new_fe_guide/tips.md
Normal file
3
doc/development/new_fe_guide/tips.md
Normal file
|
@ -0,0 +1,3 @@
|
||||||
|
# Tips
|
||||||
|
|
||||||
|
> TODO: Add tips
|
Loading…
Reference in a new issue