From 25e6212fedcffef69e0873480ac1470b3e456402 Mon Sep 17 00:00:00 2001 From: npiyush97 Date: Wed, 10 Jan 2024 14:41:47 +0530 Subject: [PATCH] new faq draft Signed-off-by: npiyush97 --- docs/faq/FAQ.md | 19 +++++++++ docs/faq/adoption.md | 7 +++ docs/faq/corefeatures.md | 7 +++ docs/faq/deployment.md | 7 +++ docs/faq/framework.md | 7 +++ docs/faq/product-faq.md | 68 +++++++++++++++++++++++++++++ docs/{FAQ.md => faq/technical.md} | 71 ++----------------------------- microsite/sidebars.json | 10 ++++- 8 files changed, 128 insertions(+), 68 deletions(-) create mode 100644 docs/faq/FAQ.md create mode 100644 docs/faq/adoption.md create mode 100644 docs/faq/corefeatures.md create mode 100644 docs/faq/deployment.md create mode 100644 docs/faq/framework.md create mode 100644 docs/faq/product-faq.md rename docs/{FAQ.md => faq/technical.md} (75%) diff --git a/docs/faq/FAQ.md b/docs/faq/FAQ.md new file mode 100644 index 0000000000..4b50a38818 --- /dev/null +++ b/docs/faq/FAQ.md @@ -0,0 +1,19 @@ +--- +id: FAQ +title: FAQ +description: All FAQ related to Questions +--- + +## FAQS + +[Product FAQS](../faq/product-faq.md) + +[Technical FAQS](../faq/technical.md) + +[Adoption FAQS](../faq/adoption.md) + +[Deployment FAQS](../faq/deployment.md) + +[Framework FAQS](../faq/framework.md) + +[Core features FAQS](../faq/corefeatures.md) diff --git a/docs/faq/adoption.md b/docs/faq/adoption.md new file mode 100644 index 0000000000..0939fef069 --- /dev/null +++ b/docs/faq/adoption.md @@ -0,0 +1,7 @@ +--- +id: Adoption FAQs +title: Adoption FAQs +description: All FAQs related to Adoption +--- + +## ADOPTION FAQ diff --git a/docs/faq/corefeatures.md b/docs/faq/corefeatures.md new file mode 100644 index 0000000000..8a46929797 --- /dev/null +++ b/docs/faq/corefeatures.md @@ -0,0 +1,7 @@ +--- +id: CORE FEATURES FAQs +title: Core Features FAQs +description: All FAQs related to Core Features +--- + +## Core Features FAQs diff --git a/docs/faq/deployment.md b/docs/faq/deployment.md new file mode 100644 index 0000000000..a67586bc2a --- /dev/null +++ b/docs/faq/deployment.md @@ -0,0 +1,7 @@ +--- +id: DEPLOYMENT FAQs +title: Deployment FAQs +description: All FAQs related to DEPLOYMENT +--- + +## Deployment FAQs diff --git a/docs/faq/framework.md b/docs/faq/framework.md new file mode 100644 index 0000000000..409a273bfb --- /dev/null +++ b/docs/faq/framework.md @@ -0,0 +1,7 @@ +--- +id: FRAMEWORK FAQs +title: Framework FAQs +description: All FAQ related to FRAMEWORK +--- + +## FRAMEWORK FAQs diff --git a/docs/faq/product-faq.md b/docs/faq/product-faq.md new file mode 100644 index 0000000000..68d8918ad0 --- /dev/null +++ b/docs/faq/product-faq.md @@ -0,0 +1,68 @@ +--- +id: Product FAQs +title: Product FAQs +description: All FAQs related to Product +--- + +## Product FAQs + +### Can we call Backstage something different? So that it fits our company better? + +Yes, Backstage is just a platform for building your own developer portal. We +happen to call our internal version Backstage, as well, as a reference to our +music roots. You can call your version whatever suits your team, company, or +brand. + +### Is Backstage a monitoring platform? + +No, but it can be! Backstage is designed to be a developer portal for all your +infrastructure tooling, services, and documentation. So, it's not a monitoring +platform — but that doesn't mean you can't integrate a monitoring tool into +Backstage by writing [a plugin](#what-is-a-plugin-in-backstage). + +### How is Backstage licensed? + +Backstage was released as open source software by Spotify and is licensed under +[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0). + +### Why did we open source Backstage? + +We hope to see Backstage become the infrastructure standard everywhere. When we +saw how much Backstage improved developer experience and productivity +internally, we wanted to share those gains. After all, if Backstage can create +order in an engineering environment as open and diverse as ours, then we're +pretty sure it can create order (and boost productivity) anywhere. To learn +more, read our blog post, +"[What the heck is Backstage anyway?](https://backstage.io/blog/2020/03/18/what-is-backstage)" + +### Will Spotify's internal plugins be open sourced, too? + +Yes, we've already started releasing open source versions of some of the plugins +we use here, and we'll continue to do so. +[Plugins](#what-is-a-plugin-in-backstage) are the building blocks of +functionality in Backstage. We have over 120 plugins inside Spotify — many of +those are specialized for our use, so will remain internal and proprietary to +us. But we estimate that about a third of our existing plugins make good open +source candidates. (And we'll probably end up writing some brand new ones, too.) + +### What's the roadmap for Backstage? + +We envision three phases, which you can learn about in +[our project roadmap](overview/roadmap.md). Even though the open source version +of Backstage is relatively new compared to our internal version, we have already +begun work on various aspects of all three phases. Looking at the +[milestones for active issues](https://github.com/backstage/backstage/milestones) +will also give you a sense of our progress. + +### My company doesn't have thousands of developers or services. Is using Backstage excessive for our needs? + +Not at all! A core reason to adopt Backstage is to standardize how software is +built at your company. It's easier to decide on those standards as a small +company, and grows in importance as the company grows. Backstage sets a +foundation, and an early investment in your infrastructure becomes even more +valuable as you grow. + +### Our company has a strong design language system/brand that we want to incorporate. Does Backstage support this? + +Yes! The Backstage UI is built using Material UI. With the theming capabilities +of Material UI, you are able to adapt the interface to your brand guidelines. diff --git a/docs/FAQ.md b/docs/faq/technical.md similarity index 75% rename from docs/FAQ.md rename to docs/faq/technical.md index 7b935140e6..a79c673799 100644 --- a/docs/FAQ.md +++ b/docs/faq/technical.md @@ -1,73 +1,10 @@ --- -id: FAQ -title: FAQ -description: All FAQ related to Backstage +id: Technical FAQs +title: Technical FAQs +description: All FAQs related to Technical --- -## Product FAQ - -### Can we call Backstage something different? So that it fits our company better? - -Yes, Backstage is just a platform for building your own developer portal. We -happen to call our internal version Backstage, as well, as a reference to our -music roots. You can call your version whatever suits your team, company, or -brand. - -### Is Backstage a monitoring platform? - -No, but it can be! Backstage is designed to be a developer portal for all your -infrastructure tooling, services, and documentation. So, it's not a monitoring -platform — but that doesn't mean you can't integrate a monitoring tool into -Backstage by writing [a plugin](#what-is-a-plugin-in-backstage). - -### How is Backstage licensed? - -Backstage was released as open source software by Spotify and is licensed under -[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0). - -### Why did we open source Backstage? - -We hope to see Backstage become the infrastructure standard everywhere. When we -saw how much Backstage improved developer experience and productivity -internally, we wanted to share those gains. After all, if Backstage can create -order in an engineering environment as open and diverse as ours, then we're -pretty sure it can create order (and boost productivity) anywhere. To learn -more, read our blog post, -"[What the heck is Backstage anyway?](https://backstage.io/blog/2020/03/18/what-is-backstage)" - -### Will Spotify's internal plugins be open sourced, too? - -Yes, we've already started releasing open source versions of some of the plugins -we use here, and we'll continue to do so. -[Plugins](#what-is-a-plugin-in-backstage) are the building blocks of -functionality in Backstage. We have over 120 plugins inside Spotify — many of -those are specialized for our use, so will remain internal and proprietary to -us. But we estimate that about a third of our existing plugins make good open -source candidates. (And we'll probably end up writing some brand new ones, too.) - -### What's the roadmap for Backstage? - -We envision three phases, which you can learn about in -[our project roadmap](overview/roadmap.md). Even though the open source version -of Backstage is relatively new compared to our internal version, we have already -begun work on various aspects of all three phases. Looking at the -[milestones for active issues](https://github.com/backstage/backstage/milestones) -will also give you a sense of our progress. - -### My company doesn't have thousands of developers or services. Is using Backstage excessive for our needs? - -Not at all! A core reason to adopt Backstage is to standardize how software is -built at your company. It's easier to decide on those standards as a small -company, and grows in importance as the company grows. Backstage sets a -foundation, and an early investment in your infrastructure becomes even more -valuable as you grow. - -### Our company has a strong design language system/brand that we want to incorporate. Does Backstage support this? - -Yes! The Backstage UI is built using Material UI. With the theming capabilities -of Material UI, you are able to adapt the interface to your brand guidelines. - -## Technical FAQ +## Technical FAQs ### What technology does Backstage use? diff --git a/microsite/sidebars.json b/microsite/sidebars.json index 5dd5ce93f8..81bd0daec0 100644 --- a/microsite/sidebars.json +++ b/microsite/sidebars.json @@ -472,7 +472,15 @@ "architecture-decisions/adrs-adr012", "architecture-decisions/adrs-adr013" ], - "FAQ": ["FAQ"], + "FAQ": [ + "faq/FAQ", + "faq/Product FAQs", + "faq/Technical FAQs", + "faq/Adoption FAQs", + "faq/DEPLOYMENT FAQs", + "faq/FRAMEWORK FAQs", + "faq/CORE FEATURES FAQs" + ], "Accessibility": ["accessibility/index"] } }