diff options
author | Daniil Baturin <daniil@baturin.org> | 2021-01-22 19:17:43 +0700 |
---|---|---|
committer | Daniil Baturin <daniil@baturin.org> | 2021-01-22 19:17:43 +0700 |
commit | 4d0294c643cd62e3d746f41b716a85ae5258da38 (patch) | |
tree | 7d6331b5462dcbc41b3341d398aa6a7402dc19fc | |
parent | 6d77563f8448abb9470edaacbcfa4218a0bec5d6 (diff) | |
download | community.vyos.net-4d0294c643cd62e3d746f41b716a85ae5258da38.tar.gz community.vyos.net-4d0294c643cd62e3d746f41b716a85ae5258da38.zip |
Add the section for contributors.
-rw-r--r-- | site/contribute.md | 53 | ||||
-rw-r--r-- | site/get/contributor-subscriptions.md | 28 | ||||
-rw-r--r-- | site/get/index.md | 11 | ||||
-rw-r--r-- | site/get/lts.md | 5 | ||||
-rw-r--r-- | soupault.conf | 11 |
5 files changed, 102 insertions, 6 deletions
diff --git a/site/contribute.md b/site/contribute.md new file mode 100644 index 0000000..3dca780 --- /dev/null +++ b/site/contribute.md @@ -0,0 +1,53 @@ +# Contributing to VyOS + +VyOS development process is open and transparent. We welcome everyone to contribute! +There's a lot of work to do: writing code, writing and editing documentation, +testing latest builds and more. + +## Why contribute? + +### Copyright stays with you + +Unlike some other projects, we intentionally do not use a contributor agreement +that would give us exclusive rights to your contributions. + +The copyrights to VyOS source code and documentation remain shared between +all contributors, so that no one (including its current maintainers) +can make a proprietary fork. + +### We have rewards + +Maintaining an LTS version is a hard, delicate, high-responsibility work. +Being a maintainer means not being able to refuse to work on the hard tasks. +We keep prebuilt LTS images behind a paywall for that reason, +but we are ready to share our work with everyone who helps us move the project forward. + +This includes everyone who contributes code, tests latest builds, writes documentation, +or promotes VyOS in the social media or at live events. + +Read about our contributor subscription [eligibility guidelines](/contributor-subscriptions). + +We also have [badges](https://www.youracclaim.com/organizations/vyos/badges)! + +## Where to start + +### Contributing to the code + +* Read [contributing guidelines](https://docs.vyos.io/en/latest/contributing/index.html). +* Browse [open tasks](https://phabricator.vyos.net/maniphest/query/YqwCUwoj7wWx/#R). + +### Contributing to the documentation + +* Fork the [vyos-documentation](https://github.com/vyos/vyos-documentation/) repo. +* Read the [guidelines](https://docs.vyos.io/en/latest/contributing/documentation.html). + +### Testing latest builds + +* Get a [nightly build](https://downloads.vyos.io/?dir=rolling/current) or a [snapshot](/get/snapshots) +* Reports bugs in [Phabricator](https://phabricator.vyos.net/maniphest). + +### Spreading the word + +* Write about VyOS in your own blog or website. +* Write about VyOS and share our posts on social media. +* Speak about VyOS at conferenced and meetups. diff --git a/site/get/contributor-subscriptions.md b/site/get/contributor-subscriptions.md new file mode 100644 index 0000000..19808b5 --- /dev/null +++ b/site/get/contributor-subscriptions.md @@ -0,0 +1,28 @@ +# Free LTS subscriptions for contributors + +We are happy to share our work on maintaining LTS releases with everyone who works together with us. +That's why we introduced free subscriptions for contributors. + +Our eligibility guidelines are as follows: + +<dl> +<dt>Programmers</dt> +<dd> +Three merged, non-trivial<fn>Non-trivial is relative of course. A single typo fix is trivial, while extensive proofreading of help strings and error messages definitely counts. Contact us if not sure.</fn> +pull requests to the source code within the last year. +</dd> + +<dt>Documentation writers</dt> +<dd> +Six merged, non-trivial pull requests to the documentation within the last year. +</dd> + +<dt>Evangelists</dt> +<dd> +A provable<fn>Many people tell us that they promote VyOS among friends and collegues. It may be true, but the problem is that anyone can say that. If you want to get a subscription as an evangelist, +please supply links to posts or recorded talks.</fn> track record of posting about VyOS (whether on your own site or on social media) +or speaking about it at live events (offline or online). Answering on the forums also counts. +</dd> + +<hr> +<div id="footnotes"> </div> diff --git a/site/get/index.md b/site/get/index.md index 1218474..4e267a1 100644 --- a/site/get/index.md +++ b/site/get/index.md @@ -24,8 +24,17 @@ They include all experimental features. We recommend them for home networks, lab use, and non-critical production routers. -Get them from our [snapshots page](/snapshots). +Get them from our [snapshots page](/get/snapshots). ## LTS release +Prebuilt LTS release images are available to people and companies who help us move the project forward. +There are many ways to get access: + +* Purchase a [software access subscription](https://vyos.io/subscriptions/software/). +* Get free access with a [support subscription](https://vyos.io/subscriptions/support/). +* Apply for a free subscription as a [contributor](/get/contributor-subscriptions). +* Apply for a free subscription as an [educational instutution](https://vyos.io/community/for-educational-institutions/), [non-profit](https://vyos.io/community/for-non-commercial-organizations/), or an [emergency service](http://vyos.io/community/for-first-responders/). + +Or you can build an LTS image from source. diff --git a/site/get/lts.md b/site/get/lts.md deleted file mode 100644 index 6a38031..0000000 --- a/site/get/lts.md +++ /dev/null @@ -1,5 +0,0 @@ -# VyOS long-term support release - -VyOS long-term support release source code is available for everyone. - -However, pre-built images are only available for people and companies who help us move the project forward. diff --git a/soupault.conf b/soupault.conf index 8738cc5..a8bda40 100644 --- a/soupault.conf +++ b/soupault.conf @@ -23,6 +23,17 @@ [widgets] +# Moves all elements with class="footnote" or tag name <fn> to <div id="footnotes"> +# and replaces them with numbered links. +[widgets.footnotes] + widget = "footnotes" + selector = "div#footnotes" + footnote_selector = [".footnote", "fn"] + footnote_link_class = "footnote" + back_links = true + link_id_prepend = "footnote-" + back_link_id_append = "-ref" + # Inserts the banner in main page only [widgets.insert-banner] widget = "include" |