Skip to content

Commit 5da5552

Browse files
olblakolblak
authored
refactor: revamp support page (#2270)
* refactor: support page * feat: add code of conduct * Update content/en/support/index.md * Update content/en/support/index.md
1 parent 15c54b7 commit 5da5552

2 files changed

Lines changed: 216 additions & 8 deletions

File tree

‎content/en/code-of-conduct/index.md‎

Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
---
2+
title: "Contributor Covenant Code of Conduct"
3+
description: "Set clear expectations for behavior, promoting a safe, inclusive, and respectful environment."
4+
type: docs
5+
draft: false
6+
image: []
7+
---
8+
9+
## Our Pledge
10+
11+
We as members, contributors, and leaders pledge to make participation in our
12+
community a harassment-free experience for everyone, regardless of age, body
13+
size, visible or invisible disability, ethnicity, sex characteristics, gender
14+
identity and expression, level of experience, education, socio-economic status,
15+
nationality, personal appearance, race, religion, or sexual identity
16+
and orientation.
17+
18+
We pledge to act and interact in ways that contribute to an open, welcoming,
19+
diverse, inclusive, and healthy community.
20+
21+
## Our Standards
22+
23+
Examples of behavior that contributes to a positive environment for our
24+
community include:
25+
26+
* Demonstrating empathy and kindness toward other people
27+
* Being respectful of differing opinions, viewpoints, and experiences
28+
* Giving and gracefully accepting constructive feedback
29+
* Accepting responsibility and apologizing to those affected by our mistakes,
30+
and learning from the experience
31+
* Focusing on what is best not just for us as individuals, but for the
32+
overall community
33+
34+
Examples of unacceptable behavior include:
35+
36+
* The use of sexualized language or imagery, and sexual attention or
37+
advances of any kind
38+
* Trolling, insulting or derogatory comments, and personal or political attacks
39+
* Public or private harassment
40+
* Publishing others' private information, such as a physical or email
41+
address, without their explicit permission
42+
* Other conduct which could reasonably be considered inappropriate in a
43+
professional setting
44+
45+
## Enforcement Responsibilities
46+
47+
Community leaders are responsible for clarifying and enforcing our standards of
48+
acceptable behavior and will take appropriate and fair corrective action in
49+
response to any behavior that they deem inappropriate, threatening, offensive,
50+
or harmful.
51+
52+
Community leaders have the right and responsibility to remove, edit, or reject
53+
comments, commits, code, wiki edits, issues, and other contributions that are
54+
not aligned to this Code of Conduct, and will communicate reasons for moderation
55+
decisions when appropriate.
56+
57+
## Scope
58+
59+
This Code of Conduct applies within all community spaces, and also applies when
60+
an individual is officially representing the community in public spaces.
61+
Examples of representing our community include using an official e-mail address,
62+
posting via an official social media account, or acting as an appointed
63+
representative at an online or offline event.
64+
65+
## Enforcement
66+
67+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
68+
reported to the community leaders responsible for enforcement at
69+
contact@updatecli.io.
70+
All complaints will be reviewed and investigated promptly and fairly.
71+
72+
All community leaders are obligated to respect the privacy and security of the
73+
reporter of any incident.
74+
75+
## Enforcement Guidelines
76+
77+
Community leaders will follow these Community Impact Guidelines in determining
78+
the consequences for any action they deem in violation of this Code of Conduct:
79+
80+
### 1. Correction
81+
82+
**Community Impact**: Use of inappropriate language or other behavior deemed
83+
unprofessional or unwelcome in the community.
84+
85+
**Consequence**: A private, written warning from community leaders, providing
86+
clarity around the nature of the violation and an explanation of why the
87+
behavior was inappropriate. A public apology may be requested.
88+
89+
### 2. Warning
90+
91+
**Community Impact**: A violation through a single incident or series
92+
of actions.
93+
94+
**Consequence**: A warning with consequences for continued behavior. No
95+
interaction with the people involved, including unsolicited interaction with
96+
those enforcing the Code of Conduct, for a specified period of time. This
97+
includes avoiding interactions in community spaces as well as external channels
98+
like social media. Violating these terms may lead to a temporary or
99+
permanent ban.
100+
101+
### 3. Temporary Ban
102+
103+
**Community Impact**: A serious violation of community standards, including
104+
sustained inappropriate behavior.
105+
106+
**Consequence**: A temporary ban from any sort of interaction or public
107+
communication with the community for a specified period of time. No public or
108+
private interaction with the people involved, including unsolicited interaction
109+
with those enforcing the Code of Conduct, is allowed during this period.
110+
Violating these terms may lead to a permanent ban.
111+
112+
### 4. Permanent Ban
113+
114+
**Community Impact**: Demonstrating a pattern of violation of community
115+
standards, including sustained inappropriate behavior, harassment of an
116+
individual, or aggression toward or disparagement of classes of individuals.
117+
118+
**Consequence**: A permanent ban from any sort of public interaction within
119+
the community.
120+
121+
## Attribution
122+
123+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
124+
version 2.0, available at
125+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
126+
127+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
128+
enforcement ladder](https://github.com/mozilla/diversity).
129+
130+
[homepage]: https://www.contributor-covenant.org
131+
132+
For answers to common questions about this code of conduct, see the FAQ at
133+
https://www.contributor-covenant.org/faq. Translations are available at
134+
https://www.contributor-covenant.org/translations.

‎content/en/support/index.md‎

Lines changed: 82 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,89 @@
11
---
22
title: "Support"
3-
description: "Reach out"
4-
date: 2020-08-27T19:25:12+02:00
5-
lastmod: 2022-03-31T19:25:12+02:00
3+
description: "How to get help, report issues, and engage with the project community."
4+
type: docs
65
draft: false
7-
images: []
6+
image: []
87
---
98

10-
The people behind Updatecli are Open-Source veterans working on many different projects.
9+
Welcome to the support page. Whether you're using the project, contributing to it, or just exploring, this page outlines how to get help, report issues, and engage with the community.
1110

12-
We build Updatecli to make our work easier by automating processes that would be daunting and error prone to do manually.
13-
This allows us to better focus on the important parts of our day-to-day work.
11+
## Before You Ask
1412

15-
If you are looking for consulting services or need us to implement a specific feature, feel free to reach out via email at [contact@updatecli.io](mailto:contact@updatecli.io)
13+
Before opening a ticket or asking a question:
14+
15+
- Review the [Documentation](/docs/prologue/introduction/)
16+
- Browse the [FAQ](/docs/help/faq/) or common issues
17+
- Search existing [GitHub Issues](https://github.com/updatecli/updatecli/issues) to see if your question has already been answered
18+
19+
## Getting Help
20+
21+
You can get help in the following ways:
22+
23+
### Community Channels
24+
25+
- **Discussions Forum**: Ask questions or start discussions on [GitHub Discussions](https://github.com/updatecli/updatecli/discussions)
26+
- **Chat**: Join the community on [Matrix](https://gitter.im/Updatecli/community?utm_source=share-link&utm_medium=link&utm_campaign=share-link)
27+
28+
Please be respectful and follow our [Code of Conduct](/code-of-conduct/).
29+
30+
## Reporting Bugs
31+
32+
To report a bug:
33+
34+
1. Search [existing issues](https://github.com/updatecli/updatecli/issues)
35+
2. If not found, open a new issue and include:
36+
- Steps to reproduce the issue
37+
- Expected and actual behavior
38+
- Environment details (OS, version)
39+
- Relevant logs or screenshots
40+
41+
Well-written reports help us fix issues more efficiently.
42+
43+
## Requesting Features
44+
45+
To suggest a new feature:
46+
47+
- Open a [Feature Request](https://github.com/updatecli/updatecli/issues/new?template=2-feature-request.yml)
48+
- Describe the feature, its purpose, and why it is useful
49+
- Optionally, suggest implementation ideas
50+
51+
## Supporting the Community
52+
53+
You can support the project in several ways:
54+
55+
- Answer questions on the GitHub discussion or chat
56+
- Improve the documentation
57+
- Help triage GitHub issues (label duplicates, confirm bugs)
58+
- Share examples, tutorials, or blog posts about your usage
59+
60+
See the [Contributing Guide](/docs/help/contributing/) for how to get started.
61+
62+
## Sponsor or Donate
63+
64+
If you'd like to support ongoing development, consider:
65+
66+
- [Sponsoring us on GitHub](https://github.com/sponsors/updatecli)
67+
- [Sponsoring us on OpenCollective](https://opencollective.com/updatecli)
68+
69+
## Consulting and Commercial Support
70+
71+
While community support is available for free, we also offer commercial services for organizations that need:
72+
73+
- Guaranteed response times
74+
- Custom development or integration work
75+
- Migration assistance
76+
- Training or workshops
77+
- Ongoing support contracts
78+
79+
These services are provided by Maintainers who are actively involved in the development of the project.
80+
81+
If you're interested in commercial support, please contact us at [consulting@updatecli.io](mailto:consulting@updatecli.io).
82+
83+
## Contact
84+
85+
For sensitive issues such as security vulnerabilities, email us directly at [security@updatecli.io](mailto:security@updatecli.io).
86+
87+
---
88+
89+
We appreciate your involvement and support. Thank you for helping build a stronger community around this project.

0 commit comments

Comments
 (0)