Skip to content

Commit 6a56d3a

Browse files
authored
doc: Improve README and Contributing (#2480)
* doc: Improve README and Contributing Signed-off-by: Olblak <[email protected]> * fix: add roadmap to allow.txt Signed-off-by: Olblak <[email protected]> --------- Signed-off-by: Olblak <[email protected]>
1 parent 2215781 commit 6a56d3a

File tree

3 files changed

+32
-8
lines changed

3 files changed

+32
-8
lines changed

.github/actions/spelling/allow.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -149,3 +149,4 @@ envcommon
149149
hclparse
150150
hclfile
151151
gruntwork
152+
Roadmap

CONTRIBUTING.adoc

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,40 @@
1-
= CONTRIBUTING
1+
= Contributing
22
:toc: preamble
33
:toclevels: 3
44

55
Thanks for your interest in this project, feel free to ask any questions you may have.
66

7-
== REQUIREMENTS
7+
== Requirements
88

99
To build the project, make sure that you link:golang[https://go.dev/] installed, link:https://www.gnu.org/software/make/[GNU Make] and link:https://goreleaser.com/install/[goreleaser installed], then execute the command `make build`, or use Docker with:
1010

1111
```
1212
docker run --rm -v "$PWD":/usr/src/updatecli -w /usr/src/updatecli -e GOOS=windows -e GOARCH=386 golang:1.16 go build -v
1313
```
1414

15-
== CONTRIBUTE
15+
== Contribute
1616

17-
They're multiple ways to contribute which don't necessarily involve coding, like providing feedback, improving documentation and processes.
17+
They're multiple ways to contribute which don't necessarily involve coding, like providing feedback, financially, improving documentation and processes.
1818
Here I'll just highlight some of them:
1919

20-
=== FEEDBACK
20+
=== Feedback
2121

2222
It's significantly harder to build a solution that could be used by different people. It involves many different skills hard to master and it's easy to get stuck in local optimum. So feel free to reach out to say what's wrong and what could be improved.
2323

24-
=== CODE
24+
=== Code
2525

2626
The code is divided into two categories, core and plugins. The core is designed to be independent and to provide the skeleton for the application, while the plugins define how things are automated for a specific use-case. The easiest part is probably plugins as it allows you to contribute independently to the process you are looking to automate.
2727

2828
==== CORE
2929

3030
This section is still evolving as they're many areas that need attention.
3131

32-
==== PLUGINS
32+
==== Financially
33+
34+
If you're using this project and it's saving you time, consider supporting it financially. It's a great way to show appreciation and to help the project grow.
35+
You can sponsor the project on GitHub at link:https://github.com/sponsors/olblak[link]
36+
37+
==== Plugins
3338

3439
Plugins can be easily added by following this workflow:
3540

@@ -188,7 +193,7 @@ targets:
188193
```
189194

190195

191-
=== DOCUMENTATION
196+
=== Documentation
192197

193198
If you spot phrasing issues or just a lack of documentation, feel free to open link:https://github.com/updatecli/updatecli/issues[an issue] and/or link:https://github.com/updatecli/updatecli/pulls[a pull request].
194199
https://github.com/updatecli/website[website]

README.adoc

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
= Updatecli
22

3+
image:https://www.updatecli.io/images/updatecli.png[alt=Updatecli,float="right",align="center",width=200,height=200]
4+
35
link:https://matrix.to/#/#Updatecli_community:gitter.im[image:https://img.shields.io/matrix/updatecli:matrix.org[]]
46
link:https://github.com/updatecli/updatecli/blob/main/LICENSE[image:https://img.shields.io/github/license/updatecli/updatecli[GitHub]]
57
link:https://goreportcard.com/report/github.com/updatecli/updatecli[image:https://goreportcard.com/badge/github.com/updatecli/updatecli[Go Report Card]]
@@ -165,6 +167,17 @@ More information link:https://www.updatecli.io/docs/prologue/introduction/[here]
165167

166168
---
167169

170+
== Roadmap
171+
172+
We use the GitHub milestone link:https://github.com/updatecli/updatecli/milestone/73[**Next**] to prioritize our effort. As our requirements evolve we regularly add plugins or improve existing ones.
173+
174+
If you ever need a specific integration, feel free to either:
175+
176+
1. Contribute it, we are more than happy to help. link:https://github.com/updatecli/updatecli/blob/main/CONTRIBUTING.adoc[Link]
177+
2. Comment on existing issues as we may prioritize issues affecting other users. link:https://github.com/updatecli/updatecli/issues[Link]
178+
3. Sponsor financially the project link:https://github.com/sponsors/olblak[link]
179+
4. Feel free to reach out to mailto:[email protected][[email protected],role=email] to see how we can help you.
180+
168181
== Contributing
169182

170183
As a community-oriented project, all contributions are greatly appreciated!
@@ -186,6 +199,8 @@ More information available at link:https://github.com/updatecli/updatecli/blob/m
186199
* 2023
187200
** FOSDEM (BE) - Cloud Native Dependencies link:https://fosdem.org/2023/schedule/event/continuous_update_everything/[Video]
188201
** CIVO Cloud (UK) - Onward a Continuously Updated Kubernetes Marketplace link:https://www.youtube.com/watch?v=B2wmA627E4w[Video]
202+
* 2024
203+
** DevOps Days 15 year anniversary celebration (BE) - Continuously Update Everything
189204

190205
== Links
191206

@@ -198,3 +213,6 @@ More information available at link:https://github.com/updatecli/updatecli/blob/m
198213

199214
link:https://github.com/updatecli/updatecli/graphs/contributors"[image:https://contrib.rocks/image?repo=updatecli/updatecli[]]
200215

216+
== Thanks to the sponsors ❤️
217+
218+
link:https://www.prefect.io/[image:https://avatars.githubusercontent.com/u/41086007?v=4[alt=PrefectHQ,height=200, width=200]]

0 commit comments

Comments
 (0)