diff --git a/docs/goals.md b/docs/goals.md index 8a3762f997..f746469555 100644 --- a/docs/goals.md +++ b/docs/goals.md @@ -10,12 +10,10 @@ menu: # Goals -VictoriaMetrics project is aimed towards the following goals: - -1. **The main goal** - to help customers and users resolving issues with VictoriaMetrics components, so they could use these components - in the most efficient way. +1. The main goal - **to help users and [clients](https://docs.victoriametrics.com/enterprise/) resolving issues with VictoriaMetrics components, + so they could use these components in the most efficient way**. 1. Fixing bugs in the essential functionality of VictoriaMetrics components. Small usability bugs are usually the most annoying, - so they **must** be fixed first. + so they **must be fixed first**. 1. Improving [docs](https://github.com/VictoriaMetrics/VictoriaMetrics/tree/master/docs) for VictoriaMetrics components, so users could find answers to their questions via Google or [Perplexity](https://www.perplexity.ai/) without the need to ask these questions at our [support channels](https://docs.victoriametrics.com/#community-and-contributions). @@ -27,11 +25,18 @@ VictoriaMetrics project is aimed towards the following goals: # Non-goals -1. Adding non-trivial features, which require significant changes in the code and the architecture. - Such features may break the essential functionality of VictoriaMetrics components, so a big share +1. Convincing people to use VictoriaMetrics components when there are better suited solutions exist for their tasks, + since users will become angry at VictoriaMetrics after they discover better solutions. +1. Breaking links to [VictoriaMetrics docs](https://docs.victoriametrics.com/), since users will be unhappy seeing 404 page + or unexpected results after they click some old link somewhere on the Internet or in the internal knowledge base. +1. Breaking backwards compatibility in new releases, since users will be unhappy when their working setup breaks after the upgrade. +1. Adding non-trivial features, which require significant changes in the code and the architecture, + since these features may break the essential functionality of VictoriaMetrics components, so a big share of the existing users may become unhappy after the upgrade. 1. Adding unnecessary abstractions, since they may worsen project maintainability in the future. -1. Implementing all the features users ask. These features should fit [the goals](#goals) of VictoriaMetrics. Other features must be closed as `won't implement`. -1. Merging all the pull requests users submit. These pull requests should fit [the goals](#goals) of VictoriaMetrics. Other pull requests must be closed as `won't merge`. +1. Implementing all the features users ask. These features should fit [the goals](#goals) of VictoriaMetrics. + Other feature requests must be closed as `won't implement`, with the link to this page. +1. Merging all the pull requests users submit. These pull requests should fit [the goals](#goals) of VictoriaMetrics. + Other pull requests must be closed as `won't merge`, with the link to this page. 1. Slowing down CI/CD pipelines with non-essential tasks, since this results in development velocity slowdown. -1. Slowing down development velocity with non-essential requirements. +1. Slowing down development velocity by introducing non-essential requirements.