From aede0b73b00696a88a7d726d54741b7c46cf24a1 Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Sun, 21 Jan 2024 14:38:02 +0100 Subject: [PATCH] docs/faq: add back index + frontmatter tweaks Signed-off-by: Patrik Oldsberg --- docs/faq/index.md | 15 +++++++++++++++ docs/faq/{product-faq.md => product.md} | 6 +++--- docs/faq/technical.md | 6 +++--- microsite/sidebars.json | 2 +- 4 files changed, 22 insertions(+), 7 deletions(-) create mode 100644 docs/faq/index.md rename docs/faq/{product-faq.md => product.md} (97%) diff --git a/docs/faq/index.md b/docs/faq/index.md new file mode 100644 index 0000000000..93e3e90fbe --- /dev/null +++ b/docs/faq/index.md @@ -0,0 +1,15 @@ +--- +id: index +title: Overview +description: FAQ Overview +--- + +This section contains answers to frequently asked questions about Backstage. + +### [Product FAQ](../faq/product.md) + +Questions related to product and design. + +### [Technical FAQ](../faq/technical.md) + +General technical questions about Backstage. diff --git a/docs/faq/product-faq.md b/docs/faq/product.md similarity index 97% rename from docs/faq/product-faq.md rename to docs/faq/product.md index 29cd22992b..6d97206907 100644 --- a/docs/faq/product-faq.md +++ b/docs/faq/product.md @@ -1,7 +1,7 @@ --- -id: Product FAQs -title: Product FAQs -description: All FAQs related to Product +id: product +title: Product FAQ +description: Product FAQ --- ### Can we call Backstage something different? So that it fits our company better? diff --git a/docs/faq/technical.md b/docs/faq/technical.md index 1573c14c59..140b4c0893 100644 --- a/docs/faq/technical.md +++ b/docs/faq/technical.md @@ -1,7 +1,7 @@ --- -id: Technical FAQs -title: Technical FAQs -description: All FAQs related to Technical +id: technical +title: Technical FAQ +description: Technical FAQ --- ### What technology does Backstage use? diff --git a/microsite/sidebars.json b/microsite/sidebars.json index 8272f5edfb..f0f924411b 100644 --- a/microsite/sidebars.json +++ b/microsite/sidebars.json @@ -472,7 +472,7 @@ "architecture-decisions/adrs-adr012", "architecture-decisions/adrs-adr013" ], - "FAQ": ["faq/Product FAQs", "faq/Technical FAQs"], + "FAQ": ["faq/index", "faq/product", "faq/technical"], "Accessibility": ["accessibility/index"] } }