From 044440e05e9d2b0de94d38db72ba171bbd813184 Mon Sep 17 00:00:00 2001 From: Winnie Hellmann Date: Tue, 16 Apr 2019 15:22:05 +0000 Subject: Create frontend FAQ (documentation) --- doc/development/fe_guide/frontend_faq.md | 27 +++++++++++++++++++++++++++ doc/development/fe_guide/index.md | 4 ++++ 2 files changed, 31 insertions(+) create mode 100644 doc/development/fe_guide/frontend_faq.md diff --git a/doc/development/fe_guide/frontend_faq.md b/doc/development/fe_guide/frontend_faq.md new file mode 100644 index 00000000000..77f064a21a9 --- /dev/null +++ b/doc/development/fe_guide/frontend_faq.md @@ -0,0 +1,27 @@ +# Frontend FAQ + +## Rules of Frontend FAQ + +1. **You talk about Frontend FAQ.** + Please share links to it whenever applicable, so more eyes catch when content + gets outdated. +2. **Keep it short and simple.** + Whenever an answer needs more than two sentences it does not belong here. +3. **Provide background when possible.** + Linking to relevant source code, issue / epic, or other documentation helps + to understand the answer. +4. **If you see something, do something.** + Please remove or update any content that is outdated as soon as you see it. + +## FAQ + +### How do I find the Rails route for a page? + +The easiest way is to type the following in the browser while on the page in +question: + +```javascript +document.body.dataset.page +``` + +Find here the [source code setting the attribute](https://gitlab.com/gitlab-org/gitlab-ce/blob/cc5095edfce2b4d4083a4fb1cdc7c0a1898b9921/app/views/layouts/application.html.haml#L4). diff --git a/doc/development/fe_guide/index.md b/doc/development/fe_guide/index.md index d5cc28dc00c..36d5e4ab96b 100644 --- a/doc/development/fe_guide/index.md +++ b/doc/development/fe_guide/index.md @@ -73,6 +73,10 @@ How we use UI components. How we use Snowplow to track custom events. +## Frontend FAQ + +Read the [frontend's FAQ](frontend_faq.md) for common small pieces of helpful information. + --- ## Style Guides -- cgit v1.2.1