Skip to content

Commit

Permalink
Merge pull request #634 from Dasharo/des_documentation
Browse files Browse the repository at this point in the history
docs: Refactor for Dasharo Entry Subscription nomenclature
  • Loading branch information
pietrushnic authored Aug 18, 2023
2 parents d146233 + 6709d85 commit bade6e9
Show file tree
Hide file tree
Showing 6 changed files with 70 additions and 48 deletions.
5 changes: 2 additions & 3 deletions docs/dasharo-tools-suite/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,5 @@ on [Dasharo
issues](https://github.com/Dasharo/dasharo-issues/issues?q=is%3Aopen+is%3Aissue+label%3ADasharoToolsSuite).

And if you have already used this system and would be interested in supporting
the project, please check how to get [Supporters
Entrance](https://docs.dasharo.com/osf-trivia-list/dts/#what-is-dasharo-tools-suite-supporters-entrance),
which ensures delivery of Dasharo firmware updates.
the project, please check [How to support us?](../osf-trivia-list/dts.md#how-to-support-us)
section.
43 changes: 28 additions & 15 deletions docs/dev-proc/versioning.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,30 +4,43 @@ Dasharo Releases are versioned using [Semantic Versioning](https://semver.org/)
and [Keep A Changelog](https://keepachangelog.com/en/1.0.0/) to document
changes introduced in new releases.

Major version zero (0.y.z) is for initial development and may not support all
Dasharo Quality Criteria.
Major version zero (0.y.z) is for initial development or first release issued
and may not support all Dasharo Quality Criteria.

The only way to map Dasharo Version to version of Open Source Firmware
framework or other components included in Dasharo Release is through release
notes. Link to Dasharo Release Notes for your hardware platform can be found
in menu on the left side (Supported Hardware->Hardware Model->Releases).

## Dasharo Supporters releases
Dasharo Releases can be divided into two categories:

Dasharo Supporters receive firmware updates more frequently than the community.
Number of updates per year depends on the number of Dasharo Subscriptions sold
and the availability of other funding (e.g., NLNet, corporate sponsors,
community donations) but is less than 2 updates per year. Dasharo Supporters
updates are characterized by a changing patch version (`z`). Fixes and features
introduced in Dasharo Supporters releases will also be available later in
community releases. In short, being a Dasharo Supporter gives an early access to
the newest features and fixes.
* Dasharo Entry Subscription Releases (previous Dasharo Supporters Release for
Dasharo Support Entrance Subscribers)
* Dasharo Community Releases

## Community releases
## Dasharo Entry Subscription Releases

Community releases are built and published once a year. Each community release
has a zero patch version (`x.y.0`) and the only changing number is the minor
version `y`.
Dasharo Entry Subscription subscribers receive firmware updates more
frequently than the community. The number of updates per year depends on the
number of Dasharo Entry Subscriptions sold and the availability of other
funding (e.g., NLNet, corporate sponsors, community donations) but is less
than 2 updates per year. Dasharo Entry Subscription Releases are characterized
by a changing patch version (`z`). Fixes and features introduced in Dasharo
Entry Subscription Releases will also be available later as Dasharo Community
Releases with public pre-built binaries in the respective release pages. In
short, being a Dasharo Subscriber gives early access to the newest features
and fixes.

[How to become Dasharo Entry Subscription subscriber?](../ways-you-can-help-us.md#become-a-dasharo-entry-subscription-subscriber)

## Dasharo Community Releases

Dasharo Community Releases are built and published once a year. Each Dasharo
Community Release has a zero patch version (`x.y.0`) and the only changing
number is the minor version `y`. To be up-to-date with latest Dasharo
Community Release updates, one can subscribed to free of charge mailing list
for given hardware platform, for which the link can be found in menu on the
left side (Supported Hardware->Hardware Model->Releases).

## Signing keys

Expand Down
2 changes: 1 addition & 1 deletion docs/osf-trivia-list/dasharo.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ and maintain a high quality, and modular firmware, for the stability and
security of your platform.

For individuals Dasharo provides optional features in subscription model called
[Supporters Entrance](dts.md#how-to-get-dasharo-tools-suite-supporters-entrance).
[Dasharo Entry Subscription](../dev-proc/versioning.md#dasharo-entry-subscription-releases).

## Why 3mdeb created Dasharo?

Expand Down
27 changes: 15 additions & 12 deletions docs/osf-trivia-list/dts.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,23 @@
# Dasharo Tools Suite

## What is Dasharo Tools Suite Supporters Entrance
## What is Dasharo Tools Suite?

Dasharo Tools Suite Supporters Entrance (DTS SE) is an extended version of
[DTS](../dasharo-tools-suite/overview.md) provided to Dasharo Supporters via
the [Supporters Entrance subscription](../ways-you-can-help-us.md#become-a-dasharo-supporter).
DTS is like a swiss army knife for Dasharo firmware: you can execute initial
deployment, firmware update and even dump machine logs for debugging and
development support. But with SE you could get updates for your own, customized
build configurations.
Dasharo Tools Suite (DTS) is like a swiss army knife for Dasharo firmware: you
can execute initial deployment, firmware update and even dump machine logs for
debugging and development support.

## How to get Dasharo Tools Suite Supporters Entrance?
Also refer to [DTS Overview](../dasharo-tools-suite/overview.md).

DTS SE is available only to Dasharo Supporters for personal use. Commercial
use of DTS SE should be discussed directly with [3mdeb](mailto:[email protected])
or [Dasharo Team](mailto:[email protected]).
## How to get Dasharo Entry Subscription Releases using Dasharo Tools Suite?

Dasharo Entry Subscription Releases can be used to perform firmware updates
with DTS by providing Dasharo Entry Subscription credentials obtained after
buying a [Dasharo Entry Subscription](../ways-you-can-help-us.md#become-a-dasharo-entry-subscription-subscriber).

Commercial use of DTS should be discussed directly with
[3mdeb](mailto:[email protected]) or [Dasharo Team](mailto:[email protected]).

## How to support us?

In general there are three ways to support us:

Expand Down
4 changes: 2 additions & 2 deletions docs/unified/msi/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,9 +131,9 @@ The list of all supported memory modules is available in the

## What does the obligatory Dasharo Subscripion includes?

The Dasharo Bronze Subscription includes:
The Dasharo Subscription includes:

* The latest Dasharo release installed by Dasharo Team
* The latest Dasharo Entry Subscription release installed by Dasharo Team
* Dasharo Updates – number of updates depends on the number of Dasharo
Subscriptions sold and the availability of other funding (e.g., NLNet,
corporate sponsors, [community
Expand Down
37 changes: 22 additions & 15 deletions docs/ways-you-can-help-us.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,33 +66,40 @@ open-source firmware mission. It is straightforward if you don't have time for
other contributions, and there are multiple options - feel free to choose one
that works for you.

### Become a Dasharo Supporter
### Become a Dasharo Entry Subscription subscriber

Buy the Dasharo Supporters Entrance subscription if you own/use/buy a machine
running Dasharo firmware:
Buy the Dasharo Entry Subscription for Desktop if you own/use/buy a machine running
Dasharo firmware:

* [1-year subscription](https://shop.3mdeb.com/shop/open-source-hardware/subscription-for-dasharo-compatible-with-msi-pro-z-690a-ddr4/)
* [2-year subscription](https://shop.3mdeb.com/shop/open-source-hardware/2-year-dasharo-supporters-entrance-for-msi-pro-z690-a-ddr4/)
* [3-year subscription](https://shop.3mdeb.com/shop/open-source-hardware/3-year-dasharo-supporters-entrance-for-msi-pro-z690-a-ddr4/)
* [1-year subscription for Desktop](https://shop.3mdeb.com/shop/dasharo-entry-subscription/1year-desktop/)
* [2-year subscription for Desktop](https://shop.3mdeb.com/shop/dasharo-entry-subscription/2year-desktop/)
* [3-year subscription for Desktop](https://shop.3mdeb.com/shop/dasharo-entry-subscription/3year-desktop/)

Or buy the hardware including the subscriptions from us, e.g.:
[Link to all available subscriptions](https://shop.3mdeb.com/product-category/dasharo-entry-subscription/)

* [MSI PRO Z690-A DDR4 motherboard with Dasharo Supporters Entrance](https://shop.3mdeb.com/shop/open-source-hardware/dasharo-compatible-with-msi-pro-z-690a-ddr4-motherboard/)
* [MSI PRO Z690-A DDR4 with Dasharo Supporters Entrance – Full PC Build](https://shop.3mdeb.com/shop/open-source-hardware/dasharo-compatible-with-msi-pro-z-690a-ddr4-full-pc-build/)
Or buy the hardware including the Dasharo Entry Subscription from us, e.g.:

* [MSI PRO Z690-A DDR4 motherboard with Dasharo Entry Subscription](https://shop.3mdeb.com/shop/open-source-hardware/dasharo-compatible-with-msi-pro-z-690a-ddr4-motherboard/)
* [MSI PRO Z690-A DDR4 with Dasharo Entry Subscription – Full PC Build](https://shop.3mdeb.com/shop/open-source-hardware/dasharo-compatible-with-msi-pro-z-690a-ddr4-full-pc-build/)
* or other platforms

As a Dasharo Supporter you will get:
As a Dasharo Entry Subscription subscriber you will get:

* The latest Dasharo releases issued by Dasharo Team
* Special Dasharo Updates for Supporters – Community receives one update per
year, but Supporters are not limited to it. Number of updates depends on the
number of Dasharo Subscriptions sold and the availability of other funding
* The latest Dasharo Entry Subscription Releases issued by Dasharo Team
* Special Dasharo Updates for Dasharo Entry Subscription subscribers –
Community receives one update per year, but Dasharo Entry Subscription
subscribers are not limited to it. Number of updates depends on the number
of Dasharo Entry Subscriptions sold and the availability of other funding
(e.g., NLNet, corporate sponsors, community donations).
* Dasharo Primer Support through invite-only Matrix channel where we often
gather Supporters opinion and share exciting news about Dasharo direction
gather Dasharo Entry Subscription subscribers' opinion and share exciting
news about Dasharo direction
* Insider's view and influence on Dasharo features roadmap – you can have a
real impact on Dasharo development

If you are interested in other market segments than Desktop, please get in
touch with us with the specific hardware model you have in mind

### PayPal

<center>
Expand Down

0 comments on commit bade6e9

Please sign in to comment.