From 1aeceee9fa29f16591759c98846679260a39c5c2 Mon Sep 17 00:00:00 2001 From: blam Date: Thu, 2 Mar 2023 15:30:43 +0100 Subject: [PATCH 1/4] chore: moving the guide to docs Signed-off-by: blam --- CONTRIBUTING.md | 60 ------------------------------- docs/overview/get-involved.md | 66 +++++++++++++++++++++++++++++++++++ 2 files changed, 66 insertions(+), 60 deletions(-) create mode 100644 docs/overview/get-involved.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c2df005a1c..70b0bcf842 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,66 +8,6 @@ Contributions are welcome, and they are greatly appreciated! Every little bit he Backstage is released under the Apache 2.0 License, and original creations contributed to this repo are accepted under the same license. -## Types of Contributions - -### Report bugs - -No one likes bugs. Report bugs as an issue [here](https://github.com/backstage/backstage/issues/new?template=bug_template.md). - -### Fix bugs or build new features - -Look through the GitHub issues for [bugs](https://github.com/backstage/backstage/labels/bug), [good first issues](https://github.com/backstage/backstage/labels/good%20first%20issue) or [help wanted](https://github.com/backstage/backstage/labels/help%20wanted). - -### Build a plugin - -The value of Backstage grows with every new plugin that gets added. Wouldn't it be fantastic if there was a plugin for every infrastructure project out there? We think so. And we would love your help. - -A great reference example of a plugin can be found on [our blog](https://backstage.io/blog/2020/04/06/lighthouse-plugin) (thanks [@fastfrwrd](https://github.com/fastfrwrd)!) - -What kind of plugins should/could be created? Some inspiration from the 120+ plugins that we have developed inside Spotify can be found [here](https://backstage.io/demos), but we will keep a running list of suggestions labeled with [[plugin]](https://github.com/backstage/backstage/labels/plugin). - -### Suggesting a plugin - -If you start developing a plugin that you aim to release as open source, we suggest that you create a [new Issue](https://github.com/backstage/backstage/issues/new?labels=plugin&template=plugin_template.md&title=%5BPlugin%5D+THE+PLUGIN+NAME). This helps the community know what plugins are in development. - -You can also use this process if you have an idea for a good plugin but you hope that someone else will pick up the work. - -### Adding Non-code Contributions - -Since there is such a large landscape of possible development, build, and deployment environments, we welcome community contributions in these areas in the [`/contrib`](https://github.com/backstage/backstage/tree/master/contrib) folder of the project. This is an excellent place to put things that help out the community at large, but which may not fit within the scope of the core product to support natively. Here, you will find Helm charts, alternative Docker images, and much more. - -### Write Documentation or improve the website - -The current documentation is very limited. Help us make the `/docs` folder come alive. - -Docs are published to [backstage.io/docs](https://backstage.io/docs). If you -contribute to the documentation, you might want to preview your changes before -submitting them. You'll find the website sources under [/microsite](/microsite) -with instructions for building and locally serving the website in the -[README](/microsite#readme). - -### Contribute to Storybook - -We think the best way to ensure different plugins provide a consistent experience is through a solid set of reusable UI/UX components. Backstage uses [Storybook](http://backstage.io/storybook). - -Either help us [create new components](https://github.com/backstage/backstage/labels/help%20wanted) or improve stories for the existing ones (look for files with `*.stories.tsx`). - -### Submit Feedback - -The best way to send feedback is to file [an issue](https://github.com/backstage/backstage/issues). - -If you are proposing a feature: - -- Explain in detail how it would work. -- Keep the scope as narrow as possible, to make it easier to implement. -- Use appropriate labels -- Remember that this is a volunteer-driven project, and that contributions - are welcome :) - -### Add your company to `ADOPTERS` - -Have you started using Backstage? Adding your company to [ADOPTERS](ADOPTERS.md) really helps the project, you can do this by filling out this [Adopter form](https://form.typeform.com/to/zcOaKikB). - ## Get Started! So...feel ready to jump in? Let's do this. 👏🏻💯 diff --git a/docs/overview/get-involved.md b/docs/overview/get-involved.md new file mode 100644 index 0000000000..675d0b23f3 --- /dev/null +++ b/docs/overview/get-involved.md @@ -0,0 +1,66 @@ +--- +id: get-involved +title: Get Involved +# prettier-ignore +description: How can you help us build Backstage? We welcome contributions of all kinds, from documentation to code to design. +--- + +We encourage contributions of all kinds, from documentation to code to design, here's some ideas on how you can help us build and improve Backstage! + +### Report bugs + +No one likes bugs. Report bugs as an issue [here](https://github.com/backstage/backstage/issues/new?template=bug_template.md). + +### Fix bugs or build new features + +Look through the GitHub issues for [bugs](https://github.com/backstage/backstage/labels/bug), [good first issues](https://github.com/backstage/backstage/labels/good%20first%20issue) or [help wanted](https://github.com/backstage/backstage/labels/help%20wanted). + +### Build a plugin + +The value of Backstage grows with every new plugin that gets added. Wouldn't it be fantastic if there was a plugin for every infrastructure project out there? We think so. And we would love your help. + +A great reference example of a plugin can be found on [our blog](https://backstage.io/blog/2020/04/06/lighthouse-plugin) (thanks [@fastfrwrd](https://github.com/fastfrwrd)!) + +What kind of plugins should/could be created? Some inspiration from the 120+ plugins that we have developed inside Spotify can be found [here](https://backstage.io/demos), but we will keep a running list of suggestions labeled with [[plugin]](https://github.com/backstage/backstage/labels/plugin). + +### Suggesting a plugin + +If you start developing a plugin that you aim to release as open source, we suggest that you create a [new Issue](https://github.com/backstage/backstage/issues/new?labels=plugin&template=plugin_template.md&title=%5BPlugin%5D+THE+PLUGIN+NAME). This helps the community know what plugins are in development. + +You can also use this process if you have an idea for a good plugin but you hope that someone else will pick up the work. + +### Adding Non-code Contributions + +Since there is such a large landscape of possible development, build, and deployment environments, we welcome community contributions in these areas in the [`/contrib`](https://github.com/backstage/backstage/tree/master/contrib) folder of the project. This is an excellent place to put things that help out the community at large, but which may not fit within the scope of the core product to support natively. Here, you will find Helm charts, alternative Docker images, and much more. + +### Write Documentation or improve the website + +The current documentation is very limited. Help us make the `/docs` folder come alive. + +Docs are published to [backstage.io/docs](https://backstage.io/docs). If you +contribute to the documentation, you might want to preview your changes before +submitting them. You'll find the website sources under [/microsite](/microsite) +with instructions for building and locally serving the website in the +[README](/microsite#readme). + +### Contribute to Storybook + +We think the best way to ensure different plugins provide a consistent experience is through a solid set of reusable UI/UX components. Backstage uses [Storybook](http://backstage.io/storybook). + +Either help us [create new components](https://github.com/backstage/backstage/labels/help%20wanted) or improve stories for the existing ones (look for files with `*.stories.tsx`). + +### Submit Feedback + +The best way to send feedback is to file [an issue](https://github.com/backstage/backstage/issues). + +If you are proposing a feature: + +- Explain in detail how it would work. +- Keep the scope as narrow as possible, to make it easier to implement. +- Use appropriate labels +- Remember that this is a volunteer-driven project, and that contributions + are welcome :) + +### Add your company to `ADOPTERS` + +Have you started using Backstage? Adding your company to [ADOPTERS](ADOPTERS.md) really helps the project, you can do this by filling out this [Adopter form](https://form.typeform.com/to/zcOaKikB). From ca4cdda5575ea0138dbb1407176d2d7618120717 Mon Sep 17 00:00:00 2001 From: blam Date: Thu, 2 Mar 2023 15:36:05 +0100 Subject: [PATCH 2/4] chore: links between docs Signed-off-by: blam --- CONTRIBUTING.md | 2 ++ docs/{overview => getting-started}/get-involved.md | 0 microsite-next/sidebars.json | 1 + 3 files changed, 3 insertions(+) rename docs/{overview => getting-started}/get-involved.md (100%) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 70b0bcf842..f816f1b6af 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,6 +8,8 @@ Contributions are welcome, and they are greatly appreciated! Every little bit he Backstage is released under the Apache 2.0 License, and original creations contributed to this repo are accepted under the same license. +You can find out more about the types of contributions over at [getting involved](https://backstage.io/docs/getting-started/get-involved)! + ## Get Started! So...feel ready to jump in? Let's do this. 👏🏻💯 diff --git a/docs/overview/get-involved.md b/docs/getting-started/get-involved.md similarity index 100% rename from docs/overview/get-involved.md rename to docs/getting-started/get-involved.md diff --git a/microsite-next/sidebars.json b/microsite-next/sidebars.json index f489771fa0..630e4474e6 100644 --- a/microsite-next/sidebars.json +++ b/microsite-next/sidebars.json @@ -46,6 +46,7 @@ "getting-started/keeping-backstage-updated", "getting-started/concepts", "getting-started/contributors", + "getting-started/get-involved", "getting-started/project-structure" ], "Local Development": [ From 7d59c54e7df6e85191b908e2a2aa4abe89d1e5e5 Mon Sep 17 00:00:00 2001 From: blam Date: Thu, 2 Mar 2023 17:50:41 +0100 Subject: [PATCH 3/4] chore: bump old space size in order to fix microsite build Signed-off-by: blam --- .github/workflows/deploy_microsite.yml | 2 +- .github/workflows/verify_microsite-next.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/deploy_microsite.yml b/.github/workflows/deploy_microsite.yml index ec7124ed35..b25dd90b84 100644 --- a/.github/workflows/deploy_microsite.yml +++ b/.github/workflows/deploy_microsite.yml @@ -14,7 +14,7 @@ jobs: env: CI: true - NODE_OPTIONS: --max-old-space-size=7168 + NODE_OPTIONS: --max-old-space-size=8192 DOCUSAURUS_SSR_CONCURRENCY: 5 steps: diff --git a/.github/workflows/verify_microsite-next.yml b/.github/workflows/verify_microsite-next.yml index 6c9edf2031..7db5f102a9 100644 --- a/.github/workflows/verify_microsite-next.yml +++ b/.github/workflows/verify_microsite-next.yml @@ -16,7 +16,7 @@ jobs: env: CI: true - NODE_OPTIONS: --max-old-space-size=4096 + NODE_OPTIONS: --max-old-space-size=8192 DOCUSAURUS_SSR_CONCURRENCY: 5 steps: From d0864ef9eb3a926b45051e5f438a660429c416b1 Mon Sep 17 00:00:00 2001 From: blam Date: Thu, 2 Mar 2023 19:06:30 +0100 Subject: [PATCH 4/4] chore: fixing broken links Signed-off-by: blam --- docs/getting-started/get-involved.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/getting-started/get-involved.md b/docs/getting-started/get-involved.md index 675d0b23f3..5d8dc35032 100644 --- a/docs/getting-started/get-involved.md +++ b/docs/getting-started/get-involved.md @@ -39,7 +39,7 @@ The current documentation is very limited. Help us make the `/docs` folder come Docs are published to [backstage.io/docs](https://backstage.io/docs). If you contribute to the documentation, you might want to preview your changes before -submitting them. You'll find the website sources under [/microsite](/microsite) +submitting them. You'll find the website sources under [/microsite](https://github.com/backstage/backstage/tree/master/microsite) with instructions for building and locally serving the website in the [README](/microsite#readme). @@ -63,4 +63,4 @@ If you are proposing a feature: ### Add your company to `ADOPTERS` -Have you started using Backstage? Adding your company to [ADOPTERS](ADOPTERS.md) really helps the project, you can do this by filling out this [Adopter form](https://form.typeform.com/to/zcOaKikB). +Have you started using Backstage? Adding your company to [ADOPTERS](https://github.com/backstage/backstage/blob/master/ADOPTERS.md) really helps the project, you can do this by filling out this [Adopter form](https://form.typeform.com/to/zcOaKikB).