Skip to content

Commit

Permalink
Tighten up first 2 sections to highlight relevant info
Browse files Browse the repository at this point in the history
Signed-off-by: mewzherder <tamao@weave.works>
  • Loading branch information
mewzherder authored Jan 28, 2021
1 parent 8f4191c commit ffe1ad1
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions SUPPORT.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,25 +8,26 @@ You might still run into issues. This page is meant to be a guide to help you fi

Implementing GitOps or any \*Ops is a process which involves many layers and technologies. We therefore place a lot of importance on encoding shared knowledge and best practices in our documentation.

To be mindful of everybody's time, please make sure you checked and followed the documentation before filing issues, below find good entry points to our documentation:
To be mindful of everybody's time, please make sure you checked and followed the documentation before filing issues.
Here are some good entry points to get started with our documentation including Getting Started Guides:

Project | Links
--------- | ----------------------------------------
Flux (v1) | [Entry point](https://docs.fluxcd.io/en/stable/), [Getting Started](https://docs.fluxcd.io/en/stable/get-started/), [FAQ](https://docs.fluxcd.io/en/stable/faq/), [Troubleshooting](https://docs.fluxcd.io/en/stable/troubleshooting/)
Helm Operator (v1) | [Entry point](https://docs.fluxcd.io/projects/helm-operator/en/stable/), [Getting Started](https://docs.fluxcd.io/projects/helm-operator/en/stable/get-started/quickstart/), [FAQ](https://docs.fluxcd.io/projects/helm-operator/en/stable/faq/), [Troubleshooting](https://docs.fluxcd.io/projects/helm-operator/en/stable/troubleshooting/)
Flux (v2) | [Entry point](https://toolkit.fluxcd.io/), [Core Concepts](https://toolkit.fluxcd.io/core-concepts/), [Getting Started](https://toolkit.fluxcd.io/get-started/), [FAQ](https://toolkit.fluxcd.io/faq/)
Flagger | [Entry point](https://docs.flagger.app/), [Getting Started](https://docs.flagger.app/install/flagger-install-on-kubernetes), [FAQ](https://docs.flagger.app/faq)
Flux (v2) | [Entry point](https://toolkit.fluxcd.io/), [Core Concepts](https://toolkit.fluxcd.io/core-concepts/), [Getting Started Guide](https://toolkit.fluxcd.io/get-started/), [FAQ](https://toolkit.fluxcd.io/faq/)
Flagger | [Entry point](https://docs.flagger.app/), [Getting Started Guide](https://docs.flagger.app/install/flagger-install-on-kubernetes), [FAQ](https://docs.flagger.app/faq)
Helm Operator (v1) | [Entry point](https://docs.fluxcd.io/projects/helm-operator/en/stable/), [Getting Started Guide](https://docs.fluxcd.io/projects/helm-operator/en/stable/get-started/quickstart/), [FAQ](https://docs.fluxcd.io/projects/helm-operator/en/stable/faq/), [Troubleshooting](https://docs.fluxcd.io/projects/helm-operator/en/stable/troubleshooting/)
Flux (v1 - in maintenance mode) | [Entry point](https://docs.fluxcd.io/en/stable/), [Getting Started Guide](https://docs.fluxcd.io/en/stable/get-started/), [FAQ](https://docs.fluxcd.io/en/stable/faq/), [Troubleshooting](https://docs.fluxcd.io/en/stable/troubleshooting/)

In addition to the links above there are a multitude of dedicated guides for specific topics. Just head to *entry point* document of the project you are interested in and check the table of contents.

## I am stuck

We as a community are both very thankful and proud to have attracted many incredibly kind and clever individuals who are all interested in the same thing and who are helping each other out.

As we have been overwhelmed with general questions, troubleshooting requests, feature requests, etc. in the past months, we would like to ask you to:

- Read the documentation carefully, check the individual troubleshooting sections for advice on how to interpret logs, use relevant tools, etc.
- Don't direct-message project maintainers or relevant others. Some of the Flux maintainers get 50 private messages with requests for help over the weekend. This is simply not feasible.
- Read the [documentation](https://toolkit.fluxcd.io/get-started/) carefully, check the individual troubleshooting sections for advice on how to interpret logs, use relevant tools, etc.
- For Flux 2 questions, see if there are answers on the [GH Discussions page](https://github.com/fluxcd/flux2/discussions)
- Please don't direct-message project maintainers or relevant others with specific support questions. The few Flux maintainers cannot answer all questions. If you post on [GH Discussions page](https://github.com/fluxcd/flux2/discussions) for Flux 2 questions or message in the appropriate Slack channel, you'll have a better chance at getting an answer from a community member willing to help.
- Make sure you don't share private information.
- Help out if you can, e.g. if somebody just answered your question and it was missing in the FAQ or other docs, please consider adding it, it might help somebody in the future.

Expand Down

0 comments on commit ffe1ad1

Please sign in to comment.