Documentation

This commit is contained in:
squidfunk 2023-08-24 18:39:12 +02:00
parent 20ce88af9e
commit 9259251377
No known key found for this signature in database
GPG Key ID: 5ED40BC4F9C436DF

View File

@ -79,15 +79,28 @@ Note that [$15] is the minimum amount to be granted access to Insiders.
[$15]: https://github.com/sponsors/squidfunk/sponsorships?tier_id=210638 [$15]: https://github.com/sponsors/squidfunk/sponsorships?tier_id=210638
[__How is my sponsorship contribution used to support the project?__](#sponsorship-support){ #sponsorship-support } [__How are sponsorship contributions used?__](#sponsorship-support){ #sponsorship-support }
Your sponsorship contribution directly supports the development and It's vital to recognize that the total sponsorship amount doesn't directly
maintenance of the project, by buying us maintainers time. It allows us to translate into the funds we have available for use. The way we allocate
dedicate more time and resources to enhance the project's features and sponsorship amounts is detailed as follows:
functionality. The additional funding helps us prioritize improvements and
updates, benefiting Insiders users and the wider community. We also actively 1. __Taxes__: Since we provide a service to our sponsors, we're of course
contribute to other upstream projects, fostering collaboration and giving legally obligated to pay sales tax. This requirement applies to all
back to the Open Source ecosystem. sponsorship contributions, aligning us with standard business practices
as for the rest of the world.
2. __Sponsorships__: A significant portion of our funding is redirected to
upstream projects. This cultivates collaboration and supports the broader
Open Source ecosystem. Those projects and their maintainers are essential
for the ongoing development of Material for MkDocs.
[Explore our sponsorships](https://github.com/squidfunk?tab=sponsoring).
3. __Funds__: We are in the process of forming a team devoted to Material for
MkDocs and are proactively compensating critical contributors. These
funds cover various aspects of the project, like the creation of new
features, bug resolution, support, and sponsor relations.
[__Are there any limitations on the number of sponsors for a particular tier?__](#sponsorship-limitations){ #sponsorship-limitations } [__Are there any limitations on the number of sponsors for a particular tier?__](#sponsorship-limitations){ #sponsorship-limitations }
@ -371,8 +384,8 @@ appearance of your site should be optional. Most Insiders features enhance the
overall experience, e.g., by adding icons to pages or providing a feedback overall experience, e.g., by adding icons to pages or providing a feedback
widget. While these features add value for your site's users, they should be widget. While these features add value for your site's users, they should be
optional for previewing when making changes to content. Currently, the only optional for previewing when making changes to content. Currently, the only
content-related features in Insiders that non-Insiders users can't properly content-related feature in Insiders that non-Insiders users can't properly
preview are [Annotations] and [Card grids]. preview are [Card grids].
This means that outside collaborators can build the documentation locally with This means that outside collaborators can build the documentation locally with
Material for MkDocs, and when they push their changes, your CI pipeline will Material for MkDocs, and when they push their changes, your CI pipeline will
@ -384,10 +397,8 @@ See the [getting started guide] for more information.
[configuration inheritance]: https://www.mkdocs.org/user-guide/configuration/#configuration-inheritance [configuration inheritance]: https://www.mkdocs.org/user-guide/configuration/#configuration-inheritance
[getting started guide]: ../insiders/getting-started.md#caveats [getting started guide]: ../insiders/getting-started.md#caveats
[Annotations]: ../reference/annotations.md?h=anno#annotations
[Card grids]: ../reference/grids.md?h=grids#using-card-grids [Card grids]: ../reference/grids.md?h=grids#using-card-grids
## Support ## Support
[__How can I contact support if I have questions about becoming a sponsor?__ ](#support-contact){ #support-contact } [__How can I contact support if I have questions about becoming a sponsor?__ ](#support-contact){ #support-contact }