diff --git a/_data/navigation.yml b/_data/navigation.yml index bd9820b757e9c0672f39e00c866bf65b4aa712db..4b7e26ec444114f74783fcd924bd6897c32e1fb6 100644 --- a/_data/navigation.yml +++ b/_data/navigation.yml @@ -5,3 +5,5 @@ main: url: https://code.eliotberriot.com/funkwhale/funkwhale - title: "Documentation" url: https://docs.funkwhale.audio + - title: "Contribute" + url: /contribute diff --git a/_posts/2017-06-21-welcome-to-jekyll.markdown b/_posts/2017-06-21-welcome-to-jekyll.markdown deleted file mode 100644 index 3c84a0464c24e283fbd94098253b5bea082fa757..0000000000000000000000000000000000000000 --- a/_posts/2017-06-21-welcome-to-jekyll.markdown +++ /dev/null @@ -1,25 +0,0 @@ ---- -layout: post -title: "Welcome to Jekyll!" -date: 2017-06-21 21:55:19 +0200 -categories: jekyll update ---- -You’ll find this post in your `_posts` directory. Go ahead and edit it and re-build the site to see your changes. You can rebuild the site in many different ways, but the most common way is to run `jekyll serve`, which launches a web server and auto-regenerates your site when a file is updated. - -To add new posts, simply add a file in the `_posts` directory that follows the convention `YYYY-MM-DD-name-of-post.ext` and includes the necessary front matter. Take a look at the source for this post to get an idea about how it works. - -Jekyll also offers powerful support for code snippets: - -{% highlight ruby %} -def print_hi(name) - puts "Hi, #{name}" -end -print_hi('Tom') -#=> prints 'Hi, Tom' to STDOUT. -{% endhighlight %} - -Check out the [Jekyll docs][jekyll-docs] for more info on how to get the most out of Jekyll. File all bugs/feature requests at [Jekyll’s GitHub repo][jekyll-gh]. If you have questions, you can ask them on [Jekyll Talk][jekyll-talk]. - -[jekyll-docs]: https://jekyllrb.com/docs/home -[jekyll-gh]: https://github.com/jekyll/jekyll -[jekyll-talk]: https://talk.jekyllrb.com/ diff --git a/contribute.md b/contribute.md new file mode 100644 index 0000000000000000000000000000000000000000..9a4ba89503c94d6c47dbe21c413f62cd49a695c9 --- /dev/null +++ b/contribute.md @@ -0,0 +1,70 @@ +--- +layout: single +permalink: /contribute +title: Contribute to funkwhale development +--- + +Funkwhale is a community project run by volunteers. There are many ways to help + the project, regardless of your skills, wealth or available free time. + +## Get in touch + +We love hearing your feedback and questions, and this is the most simple yet +effective thing you can do to help us. Reach us on the following platforms: + +- Matrix: [#funkwhale:matrix.org](https://riot.im/app/#/room/#funkwhale:matrix.org) +- Mastodon: [@eliotberriot@masodon.eliotberriot.com](https://mastodon.eliotberriot.com/@eliotberriot) +- Email: contact@eliotberriot.com + +## Use funkwhale and report bugs + +By simply using funkwhale and [report bugs](https://code.eliotberriot.com/funkwhale/funkwhale/issues) you encounter, you can also help +us improve the quality of the project for all its users. + +This is quite easy to do, and do not require any technical knowledge. When +you think there is a problem, simply share it with us, give us some context +and we'll fix it. + +## Hack the software + +Funkwhale is built on top of free and open-source technologies, which means +anyone may look at the source code, modify it's behaviour, fix bugs. + +At the moment, all the development is handled by a single person which is not +sustainable, of course. Therefore, we're looking for new contributors to make +funkwhale a community project and allow us to move faster. + +We're working with interesting technologies such as Docker, Python, Django, + Channels, Websocket, Javascript, Semantic UI and Vue JS. + There are a lot of small issues you can start with, and also many learning opportunities. + +We're also eager to get more UX/UI design skills in the team to improve +the quality of our front-end application from a user perspective. + +If you're even remotely interested in contributing code to the project, don't +hesitate to ask questions. We'll find something interesting for you, and useful for the project. + +## Host a funkwhale instance + +By hosting a funkwhale instance, you can help us increase the size of the +community which will, in turn, attract more contributors. As more instances +will open, we'll have more opportunities to detect bugs and improve the +stability of the project. + +It's also a great way to discover new music and meet people ;) + +## Talk about it + +As a quite young project, funkwhale really needs some visibility. Sharing it +(responsibly) with other people will also help us bring fresh blood in the +community, regardless of the medium or format you chose. + +## Contribute financially + +You can give money to the project on those platforms: + +- [Liberapay](https://liberapay.com/funkwhale) +- Duniter: we accept Ğ1 donations on our wallet [7f9rNMjdg9x4WHKNBzCWCQ42xm2iFQdvLr5oX2rHYEKK](https://g1.duniter.fr/#/app/wot/7f9rNMjdg9x4WHKNBzCWCQ42xm2iFQdvLr5oX2rHYEKK/Funkwhale) + +While we have no fixed goals yet, donations will make it possible for +contributors to dedicate more time for the project and get paid for their work.