mirror of
https://github.com/squidfunk/mkdocs-material.git
synced 2024-11-30 18:24:35 +01:00
Documentation (#6342)
* Merge * Deleted Community Ambassadors * Updated faq list
This commit is contained in:
parent
283938a5b5
commit
86c76c4461
@ -1,12 +1,12 @@
|
|||||||
# Sponsoring FAQs
|
# Sponsoring FAQs
|
||||||
|
|
||||||
Do you have questions about Material for MkDocs Insiders? We do our best to
|
Do you have questions about Material for MkDocs Insiders? We do our best to
|
||||||
answer all of your questions on this page. If you can't find your question
|
answer all of your questions on this page. If you can't find your question
|
||||||
below, ask it on our [discussion board]!
|
below, ask it on our [discussion board]!
|
||||||
|
|
||||||
[discussion board]: https://github.com/squidfunk/mkdocs-material/discussions/new/chooses
|
[discussion board]: https://github.com/squidfunk/mkdocs-material/discussions/new/chooses
|
||||||
|
|
||||||
## General
|
## General
|
||||||
|
|
||||||
[__Why is the Insiders edition offered as a subscription model?__](#insiders-subscription){ #insiders-subscription }
|
[__Why is the Insiders edition offered as a subscription model?__](#insiders-subscription){ #insiders-subscription }
|
||||||
|
|
||||||
@ -19,18 +19,18 @@ In order to sustain the project and add new and useful features more frequently,
|
|||||||
we decided to create the [Insiders] edition, with early access to the latest and
|
we decided to create the [Insiders] edition, with early access to the latest and
|
||||||
greatest features of Material for MkDocs. The subscription-based model of the
|
greatest features of Material for MkDocs. The subscription-based model of the
|
||||||
Insiders edition allows us to dedicate more time and resources to the project,
|
Insiders edition allows us to dedicate more time and resources to the project,
|
||||||
which benefits all
|
which benefits all
|
||||||
users of Material for MkDocs. Once our funding goals based on monthly
|
users of Material for MkDocs. Once our funding goals based on monthly
|
||||||
subscriptions are hit, the Insiders features of those^ funding goals are released
|
subscriptions are hit, the Insiders features of those^ funding goals are released
|
||||||
to the community edition, letting everyone benefit from them.
|
to the community edition, letting everyone benefit from them.
|
||||||
|
|
||||||
Maintaining both the community and Insiders editions is an ongoing process, and
|
Maintaining both the community and Insiders editions is an ongoing process, and
|
||||||
we rely on our sponsors to support us on a monthly basis, which makes this whole
|
we rely on our sponsors to support us on a monthly basis, which makes this whole
|
||||||
project possible.
|
project possible.
|
||||||
|
|
||||||
[__What features are included in the Insiders edition?__](#insiders-features){ #insiders-features }
|
[__What features are included in the Insiders edition?__](#insiders-features){ #insiders-features }
|
||||||
|
|
||||||
The Insiders edition includes more than 20 additional features. You can find an
|
The Insiders edition includes more than 20 additional features. You can find an
|
||||||
overview of these features on our [Insiders page], which is updated when new
|
overview of these features on our [Insiders page], which is updated when new
|
||||||
features are added and released.
|
features are added and released.
|
||||||
|
|
||||||
@ -43,7 +43,7 @@ We try to keep our open issue count low, fixing known bugs quickly. Both our
|
|||||||
repositories, the community and Insiders edition, are constantly updated with
|
repositories, the community and Insiders edition, are constantly updated with
|
||||||
bug fixes and new features.
|
bug fixes and new features.
|
||||||
|
|
||||||
## Sponsorship
|
## Sponsorship
|
||||||
|
|
||||||
[__Can I sponsor the project without a GitHub account?__](#sponsorship-account){ #sponsorship-account }
|
[__Can I sponsor the project without a GitHub account?__](#sponsorship-account){ #sponsorship-account }
|
||||||
|
|
||||||
@ -57,11 +57,11 @@ Insiders repository in your environment once you have access.
|
|||||||
|
|
||||||
[__Which sponsoring tier should I choose?__](#sponsorship-tier){ #sponsorship-tier }
|
[__Which sponsoring tier should I choose?__](#sponsorship-tier){ #sponsorship-tier }
|
||||||
|
|
||||||
The sponsoring tiers are divided into non-commercial and commercial tiers. If
|
The sponsoring tiers are divided into non-commercial and commercial tiers. If
|
||||||
you are an individual or organization using Material for MkDocs for private or
|
you are an individual or organization using Material for MkDocs for private or
|
||||||
__non-commercial__ Open Source projects, you have two tiers to choose from,
|
__non-commercial__ Open Source projects, you have two tiers to choose from,
|
||||||
depending on the number of sites you want to build. For companies using
|
depending on the number of sites you want to build. For companies using
|
||||||
Material for MkDocs, we offer three different __commercial__ tiers, from which
|
Material for MkDocs, we offer three different __commercial__ tiers, from which
|
||||||
you can choose depending on your requirements.
|
you can choose depending on your requirements.
|
||||||
|
|
||||||
Also, please read what is considered [commercial use].
|
Also, please read what is considered [commercial use].
|
||||||
@ -108,7 +108,7 @@ No, there are no limitations on the number of sponsors for any tier. You can
|
|||||||
sponsor the project at any tier regardless of how many other sponsors are
|
sponsor the project at any tier regardless of how many other sponsors are
|
||||||
already there.
|
already there.
|
||||||
|
|
||||||
## Payment & billing
|
## Payment & billing
|
||||||
|
|
||||||
[__Is there a trial period for the Insiders edition?__](#insiders-trial){ #insiders-trial }
|
[__Is there a trial period for the Insiders edition?__](#insiders-trial){ #insiders-trial }
|
||||||
|
|
||||||
@ -118,16 +118,16 @@ first give the Insiders edition a try, you can sponsor on the [$15] tier with a
|
|||||||
personal account for non-commercial evaluation purposes.
|
personal account for non-commercial evaluation purposes.
|
||||||
|
|
||||||
Additionally, our subscription model allows you to cancel your sponsorship
|
Additionally, our subscription model allows you to cancel your sponsorship
|
||||||
anytime. If you decide to cancel, your sponsorship will remain active until
|
anytime. If you decide to cancel, your sponsorship will remain active until
|
||||||
the end of your billing cycle.
|
the end of your billing cycle.
|
||||||
|
|
||||||
[__What payment options do you accept?__](#insiders-payment){ #insiders-payment }
|
[__What payment options do you accept?__](#insiders-payment){ #insiders-payment }
|
||||||
|
|
||||||
We manage all our transactions and sponsorships through [GitHub Sponsors] and
|
We manage all our transactions and sponsorships through [GitHub Sponsors] and
|
||||||
[Ko-fi]. To become a sponsor of Material for MkDocs on GitHub, visit
|
[Ko-fi]. To become a sponsor of Material for MkDocs on GitHub, visit
|
||||||
[our sponsors' page]. On there, you can choose from five different sponsorship
|
[our sponsors' page]. On there, you can choose from five different sponsorship
|
||||||
tiers and pay by credit card. Please note that as of the beginning of 2023,
|
tiers and pay by credit card. Please note that as of the beginning of 2023,
|
||||||
[GitHub no longer supports PayPal] payments. If you wish to pay with PayPal,
|
[GitHub no longer supports PayPal] payments. If you wish to pay with PayPal,
|
||||||
you can find a selection of our sponsorship tiers on [Ko-fi]. Both platforms
|
you can find a selection of our sponsorship tiers on [Ko-fi]. Both platforms
|
||||||
provide you with a payment receipt once your purchase is successful.
|
provide you with a payment receipt once your purchase is successful.
|
||||||
|
|
||||||
@ -141,34 +141,34 @@ please don't hesitate to reach out to sponsors@squidfunk.com.
|
|||||||
|
|
||||||
[__Are discounts available for the Insiders edition, such as student discounts?__](#insiders-discounts){ #insiders-discounts }
|
[__Are discounts available for the Insiders edition, such as student discounts?__](#insiders-discounts){ #insiders-discounts }
|
||||||
|
|
||||||
Unfortunately, we are not able to offer any discounts for the Material for
|
Unfortunately, we are not able to offer any discounts for the Material for
|
||||||
MkDocs Insiders program. To ensure that everyone can afford the Insiders program
|
MkDocs Insiders program. To ensure that everyone can afford the Insiders program
|
||||||
and keep the barrier as low as possible, we have set prices as low as [$15] a
|
and keep the barrier as low as possible, we have set prices as low as [$15] a
|
||||||
month for non-commercial use.
|
month for non-commercial use.
|
||||||
|
|
||||||
[__Do you offer free access to Insiders for Open Source projects?__](#insiders-open-source){ #insiders-open-source }
|
[__Do you offer free access to Insiders for Open Source projects?__](#insiders-open-source){ #insiders-open-source }
|
||||||
|
|
||||||
No, we do not offer free access to our Material for MkDocs Insiders edition.
|
No, we do not offer free access to our Material for MkDocs Insiders edition.
|
||||||
We understand that non-profit organizations may have limited budgets and may
|
We understand that non-profit organizations may have limited budgets and may
|
||||||
need to prioritize their spending on other projects or organizations. However,
|
need to prioritize their spending on other projects or organizations. However,
|
||||||
it's important to note that Material for MkDocs is maintained by a small team,
|
it's important to note that Material for MkDocs is maintained by a small team,
|
||||||
investing a lot of time and resources into constantly improving this project.
|
investing a lot of time and resources into constantly improving this project.
|
||||||
Material for MkDocs and its core features are free to the community through our
|
Material for MkDocs and its core features are free to the community through our
|
||||||
Open Source model. Therefore, Material for MkDocs itself is already free.
|
Open Source model. Therefore, Material for MkDocs itself is already free.
|
||||||
|
|
||||||
However, we do offer an affordable sponsorship tier starting at [$15] a month,
|
However, we do offer an affordable sponsorship tier starting at [$15] a month,
|
||||||
which is meant for individuals and non-profit organizations using Material for
|
which is meant for individuals and non-profit organizations using Material for
|
||||||
MkDocs to build 1-2 sites for non-commercial purposes. This tier provides access
|
MkDocs to build 1-2 sites for non-commercial purposes. This tier provides access
|
||||||
to all new features, benefiting you from our ongoing development efforts.
|
to all new features, benefiting you from our ongoing development efforts.
|
||||||
|
|
||||||
[__Is Insiders free for those who contribute to this project?__](#insiders-contributors){ #insiders-contributors }
|
[__Is Insiders free for those who contribute to this project?__](#insiders-contributors){ #insiders-contributors }
|
||||||
|
|
||||||
Great question! We can not offer free access to "drive-by" contributors that
|
Great question! We can not offer free access to "drive-by" contributors that
|
||||||
only fix minor issues like typos or add new languages. These contributions are
|
only fix minor issues like typos or add new languages. These contributions are
|
||||||
always welcome, but as we need to review them, they result in a higher time
|
always welcome, but as we need to review them, they result in a higher time
|
||||||
investment from our side and don't compensate for this work. However, as this
|
investment from our side and don't compensate for this work. However, as this
|
||||||
project keeps growing, we always seek for individuals to support us. In return,
|
project keeps growing, we always seek for individuals to support us. In return,
|
||||||
we offer financial compensation or/and Insiders access. If you are interested
|
we offer financial compensation or/and Insiders access. If you are interested
|
||||||
and have experience in the technologies and paradigms listed below, please get
|
and have experience in the technologies and paradigms listed below, please get
|
||||||
in touch with us at sponsors@squidfunk.com:
|
in touch with us at sponsors@squidfunk.com:
|
||||||
|
|
||||||
@ -184,12 +184,12 @@ users with access to Insiders.
|
|||||||
|
|
||||||
[__How can I set my billing to monthly or yearly?__](#insiders-billing-cycle){ #insiders-billing-cycle }
|
[__How can I set my billing to monthly or yearly?__](#insiders-billing-cycle){ #insiders-billing-cycle }
|
||||||
|
|
||||||
You can sponsor Material for MkDocs on a monthly or yearly basis. Depending on
|
You can sponsor Material for MkDocs on a monthly or yearly basis. Depending on
|
||||||
your billing cycle you automatically become a monthly or yearly sponsor. Your
|
your billing cycle you automatically become a monthly or yearly sponsor. Your
|
||||||
[billing cycle] is an account-level setting that you can easily change in your
|
[billing cycle] is an account-level setting that you can easily change in your
|
||||||
account. If, for some reason, you cannot make this change, you can create a
|
account. If, for some reason, you cannot make this change, you can create a
|
||||||
dedicated bot account with a yearly billing cycle on GitHub, which you only use
|
dedicated bot account with a yearly billing cycle on GitHub, which you only use
|
||||||
for sponsoring (some sponsors already do that). If you have any problems or
|
for sponsoring (some sponsors already do that). If you have any problems or
|
||||||
further questions, please contact us at sponsors@squidfunk.com.
|
further questions, please contact us at sponsors@squidfunk.com.
|
||||||
|
|
||||||
[billing cycle]: https://docs.github.com/en/github/setting-up-and-managing-billing-and-payments-on-github/changing-the-duration-of-your-billing-cycle
|
[billing cycle]: https://docs.github.com/en/github/setting-up-and-managing-billing-and-payments-on-github/changing-the-duration-of-your-billing-cycle
|
||||||
@ -198,7 +198,7 @@ further questions, please contact us at sponsors@squidfunk.com.
|
|||||||
|
|
||||||
Right now, we can't provide you with an invoice for your sponsoring transaction,
|
Right now, we can't provide you with an invoice for your sponsoring transaction,
|
||||||
as [GitHub Sponsors] handles all transactions for us. However, both payment
|
as [GitHub Sponsors] handles all transactions for us. However, both payment
|
||||||
platforms, [GitHub] and [Ko-Fi], automatically send you a payment receipt
|
platforms, [GitHub] and [Ko-Fi], automatically send you a payment receipt
|
||||||
via mail once the sponsorship is active.
|
via mail once the sponsorship is active.
|
||||||
|
|
||||||
Furthermore, we are working on a solution to optimize access management and more
|
Furthermore, we are working on a solution to optimize access management and more
|
||||||
@ -210,8 +210,8 @@ reach out as soon as we are live.
|
|||||||
|
|
||||||
[__Can I switch between different sponsoring tiers?__](#insiders-switch-tiers){ #insiders-switch-tiers }
|
[__Can I switch between different sponsoring tiers?__](#insiders-switch-tiers){ #insiders-switch-tiers }
|
||||||
|
|
||||||
Yes, you can switch between different sponsoring tiers at any time. Simply go
|
Yes, you can switch between different sponsoring tiers at any time. Simply go
|
||||||
to the [GitHub Sponsors] page and change your sponsoring tier. Once you make
|
to the [GitHub Sponsors] page and change your sponsoring tier. Once you make
|
||||||
that change, you will immediately change to the new tier.
|
that change, you will immediately change to the new tier.
|
||||||
|
|
||||||
If you change to a higher tier, the amount will be prorated according to your
|
If you change to a higher tier, the amount will be prorated according to your
|
||||||
@ -220,13 +220,13 @@ billing cycle.
|
|||||||
[__Can I sponsor the project for a specific feature or development goal?__](#insiders-goals){ #insiders-goals }
|
[__Can I sponsor the project for a specific feature or development goal?__](#insiders-goals){ #insiders-goals }
|
||||||
|
|
||||||
While sponsoring specific goals directly is not possible, our sponsoring goals
|
While sponsoring specific goals directly is not possible, our sponsoring goals
|
||||||
are connected to specific features or development goals aligned with the
|
are connected to specific features or development goals aligned with the
|
||||||
project's roadmap. You can find an [overview of these sponsoring goals] and their
|
project's roadmap. You can find an [overview of these sponsoring goals] and their
|
||||||
associated features on our website. Insider users have early access to all
|
associated features on our website. Insider users have early access to all
|
||||||
already developed features, including those associated with higher funding goals
|
already developed features, including those associated with higher funding goals
|
||||||
that will be reached at a later stage. If you're interested in accessing these
|
that will be reached at a later stage. If you're interested in accessing these
|
||||||
features, becoming a sponsor is the way to go. If you have a feature in mind
|
features, becoming a sponsor is the way to go. If you have a feature in mind
|
||||||
that you would like to see on the list, we encourage you to
|
that you would like to see on the list, we encourage you to
|
||||||
[initiate a new discussion] to evaluate it with others.
|
[initiate a new discussion] to evaluate it with others.
|
||||||
|
|
||||||
[overview of these sponsoring goals]: ../insiders/index.md#goals
|
[overview of these sponsoring goals]: ../insiders/index.md#goals
|
||||||
@ -234,48 +234,48 @@ that you would like to see on the list, we encourage you to
|
|||||||
|
|
||||||
[__What happens if I reach my sponsoring limit for my current tier?__](#insiders-limit){ #insiders-limit }
|
[__What happens if I reach my sponsoring limit for my current tier?__](#insiders-limit){ #insiders-limit }
|
||||||
|
|
||||||
If you extend the number of sites that are in your current sponsoring limit,
|
If you extend the number of sites that are in your current sponsoring limit,
|
||||||
please [upgrade your sponsorship] to a higher tier to continue using the
|
please [upgrade your sponsorship] to a higher tier to continue using the
|
||||||
Insiders version and build more sites. The change will be effective immediately.
|
Insiders version and build more sites. The change will be effective immediately.
|
||||||
|
|
||||||
[upgrade your sponsorship]: https://docs.github.com/en/billing/managing-billing-for-github-sponsors/upgrading-a-sponsorship
|
[upgrade your sponsorship]: https://docs.github.com/en/billing/managing-billing-for-github-sponsors/upgrading-a-sponsorship
|
||||||
|
|
||||||
[__Do you offer refunds for sponsoring payments?__](#insiders-refunds){ #insiders-refunds }
|
[__Do you offer refunds for sponsoring payments?__](#insiders-refunds){ #insiders-refunds }
|
||||||
|
|
||||||
Unfortunately, we cannot offer any refund for sponsorship payments.
|
Unfortunately, we cannot offer any refund for sponsorship payments.
|
||||||
[GitHub Sponsors] and [Ko-Fi] manage all sponsoring transactions. Because of
|
[GitHub Sponsors] and [Ko-Fi] manage all sponsoring transactions. Because of
|
||||||
that, we do not have any insights into the details of the funds and cannot access
|
that, we do not have any insights into the details of the funds and cannot access
|
||||||
them. If you have any payment issues, please get in touch with the GitHub
|
them. If you have any payment issues, please get in touch with the GitHub
|
||||||
or Ko-Fi support team, as they can help you.
|
or Ko-Fi support team, as they can help you.
|
||||||
|
|
||||||
## Access management
|
## Access management
|
||||||
|
|
||||||
[__How do I gain access to the private Insiders repository?__](#access-account){ #access-account }
|
[__How do I gain access to the private Insiders repository?__](#access-account){ #access-account }
|
||||||
|
|
||||||
If you sponsored with your __individual account__, you should have received an
|
If you sponsored with your __individual account__, you should have received an
|
||||||
email invitation to the private Material for MkDocs Insiders repository right
|
email invitation to the private Material for MkDocs Insiders repository right
|
||||||
after you initiated your sponsorship. Simply accept the invitation within seven
|
after you initiated your sponsorship. Simply accept the invitation within seven
|
||||||
days to gain access.
|
days to gain access.
|
||||||
|
|
||||||
If you sponsored using an __organization account__, please note we need
|
If you sponsored using an __organization account__, please note we need
|
||||||
an individual account that we can list as a collaborator of the private Insiders
|
an individual account that we can list as a collaborator of the private Insiders
|
||||||
repository. After you initiate your sponsorship, please email us at
|
repository. After you initiate your sponsorship, please email us at
|
||||||
sponsors@squidfunk.com with the name of the individual or bot account. Once you
|
sponsors@squidfunk.com with the name of the individual or bot account. Once you
|
||||||
provide us with this information, we will add the account as a collaborator, and
|
provide us with this information, we will add the account as a collaborator, and
|
||||||
after you accept the invitation, you will gain access to the repository.
|
after you accept the invitation, you will gain access to the repository.
|
||||||
|
|
||||||
If you have yet to receive the email or the invitation link has expired, please
|
If you have yet to receive the email or the invitation link has expired, please
|
||||||
contact us, the maintainers, at sponsors@squidfunk.com. We're working on a
|
contact us, the maintainers, at sponsors@squidfunk.com. We're working on a
|
||||||
solution that will allow you to manage collaborator status yourself.
|
solution that will allow you to manage collaborator status yourself.
|
||||||
|
|
||||||
[__Why can't our whole organization get access to Insiders?__](#access-organization){ #access-organization }
|
[__Why can't our whole organization get access to Insiders?__](#access-organization){ #access-organization }
|
||||||
|
|
||||||
Currently, it is not possible to grant access to an organizational account, as
|
Currently, it is not possible to grant access to an organizational account, as
|
||||||
GitHub only allows for adding individual user accounts. We are working on a
|
GitHub only allows for adding individual user accounts. We are working on a
|
||||||
solution ourselves to simplify access for organizations. For now, to ensure that
|
solution ourselves to simplify access for organizations. For now, to ensure that
|
||||||
access is not tied to a particular individual, we recommend creating a bot
|
access is not tied to a particular individual, we recommend creating a bot
|
||||||
account, i.e., a GitHub account that does not belong to a specific individual
|
account, i.e., a GitHub account that does not belong to a specific individual
|
||||||
but is listed as the owner of the organizational account and using this account
|
but is listed as the owner of the organizational account and using this account
|
||||||
for sponsorship.
|
for sponsorship.
|
||||||
|
|
||||||
[__Do I need to fork the repository to use it?__](#access-fork){ #access-fork }
|
[__Do I need to fork the repository to use it?__](#access-fork){ #access-fork }
|
||||||
@ -289,12 +289,12 @@ your fork.
|
|||||||
|
|
||||||
[__Can I share my Insiders access with others?__](#access-share){ #access-share }
|
[__Can I share my Insiders access with others?__](#access-share){ #access-share }
|
||||||
|
|
||||||
At the moment, it is not possible to directly share your collaborator status
|
At the moment, it is not possible to directly share your collaborator status
|
||||||
for the private Insiders repository with other accounts. However, if you are
|
for the private Insiders repository with other accounts. However, if you are
|
||||||
working with a team and would like them to access Insiders, you can share the
|
working with a team and would like them to access Insiders, you can share the
|
||||||
Insiders repository by utilizing options such as [cloning], [forking], or
|
Insiders repository by utilizing options such as [cloning], [forking], or
|
||||||
[mirroring]. By doing so, you can start collaborating with your team members on
|
[mirroring]. By doing so, you can start collaborating with your team members on
|
||||||
the new repository you have shared. This way, you can collectively benefit
|
the new repository you have shared. This way, you can collectively benefit
|
||||||
from the Insiders features and work together on the project.
|
from the Insiders features and work together on the project.
|
||||||
|
|
||||||
[cloning]: https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository
|
[cloning]: https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository
|
||||||
@ -302,30 +302,30 @@ from the Insiders features and work together on the project.
|
|||||||
[mirroring]: https://docs.github.com/en/repositories/creating-and-managing-repositories/duplicating-a-repository
|
[mirroring]: https://docs.github.com/en/repositories/creating-and-managing-repositories/duplicating-a-repository
|
||||||
|
|
||||||
|
|
||||||
## Runtime & cancellation
|
## Runtime & cancellation
|
||||||
|
|
||||||
[__How long is my sponsorship valid?__](#sponsorship-runtime){ #sponsorship-runtime }
|
[__How long is my sponsorship valid?__](#sponsorship-runtime){ #sponsorship-runtime }
|
||||||
|
|
||||||
Your sponsorship is valid for as long as your monthly or yearly subscription
|
Your sponsorship is valid for as long as your monthly or yearly subscription
|
||||||
is valid. If you choose to cancel your sponsorship, you will lose access to
|
is valid. If you choose to cancel your sponsorship, you will lose access to
|
||||||
the Insiders edition once your cancelation is active and will be automatically
|
the Insiders edition once your cancelation is active and will be automatically
|
||||||
removed by GitHub as a collaborator from the private repository.
|
removed by GitHub as a collaborator from the private repository.
|
||||||
|
|
||||||
[__How do I cancel my sponsorship?__](#sponsorship-cancellation){ #sponsorship-cancellation }
|
[__How do I cancel my sponsorship?__](#sponsorship-cancellation){ #sponsorship-cancellation }
|
||||||
|
|
||||||
To cancel your sponsorship, follow the [step-by-step guide] provided by GitHub.
|
To cancel your sponsorship, follow the [step-by-step guide] provided by GitHub.
|
||||||
If you sponsored using an organizational account, please ensure that you cancel
|
If you sponsored using an organizational account, please ensure that you cancel
|
||||||
your sponsorship using the same organizational account rather than your
|
your sponsorship using the same organizational account rather than your
|
||||||
individual account.
|
individual account.
|
||||||
|
|
||||||
[step-by-step guide]: https://docs.github.com/en/billing/managing-billing-for-github-sponsors/downgrading-a-sponsorship
|
[step-by-step guide]: https://docs.github.com/en/billing/managing-billing-for-github-sponsors/downgrading-a-sponsorship
|
||||||
|
|
||||||
[__What happens when I cancel my sponsorship?__](#sponsorship-cancellation-effective){ #sponsorship-cancellation-effective }
|
[__What happens when I cancel my sponsorship?__](#sponsorship-cancellation-effective){ #sponsorship-cancellation-effective }
|
||||||
|
|
||||||
If you choose to cancel your subscription to Insiders, you will be
|
If you choose to cancel your subscription to Insiders, you will be
|
||||||
automatically removed by GitHub as a collaborator on the day your cancellation is
|
automatically removed by GitHub as a collaborator on the day your cancellation is
|
||||||
effective. From that day on, you will no longer receive future updates. However,
|
effective. From that day on, you will no longer receive future updates. However,
|
||||||
you are __welcome to continue using the latest version__ that was available to
|
you are __welcome to continue using the latest version__ that was available to
|
||||||
you at the time of your cancellation for as long as you like.
|
you at the time of your cancellation for as long as you like.
|
||||||
|
|
||||||
Please note that [GitHub deletes private forks], so you may want to take steps to ensure
|
Please note that [GitHub deletes private forks], so you may want to take steps to ensure
|
||||||
@ -333,15 +333,15 @@ that you have a backup of the software if necessary and use the locally installe
|
|||||||
|
|
||||||
[GitHub deletes private forks]: https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/removing-a-collaborator-from-a-personal-repository#deleting-forks-of-private-repositories
|
[GitHub deletes private forks]: https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/removing-a-collaborator-from-a-personal-repository#deleting-forks-of-private-repositories
|
||||||
|
|
||||||
## Licensing
|
## Licensing
|
||||||
|
|
||||||
[__What constitutes commercial use of the Insiders version?__](#commercial-use){ #commercial-use }
|
[__What constitutes commercial use of the Insiders version?__](#commercial-use){ #commercial-use }
|
||||||
|
|
||||||
Commercial use refers to any use of the software for a business or for-profit
|
Commercial use refers to any use of the software for a business or for-profit
|
||||||
purpose. This includes any use by a corporation or other organization, whether
|
purpose. This includes any use by a corporation or other organization, whether
|
||||||
or not they generate revenue directly from the software. We offer different
|
or not they generate revenue directly from the software. We offer different
|
||||||
pricing tiers for commercial use, each tailored to the needs of different
|
pricing tiers for commercial use, each tailored to the needs of different
|
||||||
businesses. It's important to note that internal use of the software within your
|
businesses. It's important to note that internal use of the software within your
|
||||||
organization is also considered commercial use, as with all commercial software.
|
organization is also considered commercial use, as with all commercial software.
|
||||||
|
|
||||||
[__What constitutes non-commercial use of the Insiders version?__](#non-commercial-use){ #non-commercial-use }
|
[__What constitutes non-commercial use of the Insiders version?__](#non-commercial-use){ #non-commercial-use }
|
||||||
@ -349,28 +349,28 @@ organization is also considered commercial use, as with all commercial software.
|
|||||||
Non-commercial use of our Material for MkDocs refers to private use. This
|
Non-commercial use of our Material for MkDocs refers to private use. This
|
||||||
includes individuals using the Insiders edition for private or purely
|
includes individuals using the Insiders edition for private or purely
|
||||||
non-commercial Open Source projects. We offer two different tiers for
|
non-commercial Open Source projects. We offer two different tiers for
|
||||||
non-commercial use, depending on the number of sites you want to build.
|
non-commercial use, depending on the number of sites you want to build.
|
||||||
|
|
||||||
[__What is your fair use policy?__](#fair-use-policy){ #fair-use-policy }
|
[__What is your fair use policy?__](#fair-use-policy){ #fair-use-policy }
|
||||||
|
|
||||||
Our fair use policy includes the following guidelines:
|
Our fair use policy includes the following guidelines:
|
||||||
|
|
||||||
- Please refrain from __distributing the source code__ of Insiders. While you
|
- Please refrain from __distributing the source code__ of Insiders. While you
|
||||||
may use the software for public, private, or commercial projects and may
|
may use the software for public, private, or commercial projects and may
|
||||||
privately fork or mirror it, we ask that you keep the source code private. This
|
privately fork or mirror it, we ask that you keep the source code private. This
|
||||||
is important to our sponsorware strategy, which helps us fund ongoing
|
is important to our sponsorware strategy, which helps us fund ongoing
|
||||||
development and support of the software. If this guidelines is violated,
|
development and support of the software. If this guidelines is violated,
|
||||||
everybody loses, as it will reduce the time of us maintainers we can set aside
|
everybody loses, as it will reduce the time of us maintainers we can set aside
|
||||||
to push this project forward.
|
to push this project forward.
|
||||||
|
|
||||||
- As our sponsoring tiers are based on the number of sites you want to build,
|
- As our sponsoring tiers are based on the number of sites you want to build,
|
||||||
please make sure to [upgrade your sponsorship] once your current sponsoring tier
|
please make sure to [upgrade your sponsorship] once your current sponsoring tier
|
||||||
limit has been reached.
|
limit has been reached.
|
||||||
|
|
||||||
[__Does the Insiders version have a different license?__](#insiders-license){ #insiders-license }
|
[__Does the Insiders version have a different license?__](#insiders-license){ #insiders-license }
|
||||||
|
|
||||||
No. Whether you're an individual or a company, you may use Material for
|
No. Whether you're an individual or a company, you may use Material for
|
||||||
MkDocs Insiders precisely under the same terms as Material for MkDocs, which are
|
MkDocs Insiders precisely under the same terms as Material for MkDocs, which are
|
||||||
given by the [MIT license].
|
given by the [MIT license].
|
||||||
|
|
||||||
[MIT license]: ../license.md
|
[MIT license]: ../license.md
|
||||||
@ -379,18 +379,18 @@ given by the [MIT license].
|
|||||||
|
|
||||||
Yes. Insiders is compatible with Material for MkDocs. Almost all new features
|
Yes. Insiders is compatible with Material for MkDocs. Almost all new features
|
||||||
and configuration options are either backward-compatible or implemented behind
|
and configuration options are either backward-compatible or implemented behind
|
||||||
feature flags. When working with outside collaborators, changing the general
|
feature flags. When working with outside collaborators, changing the general
|
||||||
appearance of your site should be optional. Most Insiders features enhance the
|
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 feature in Insiders that non-Insiders users can't properly
|
content-related feature in Insiders that non-Insiders users can't properly
|
||||||
preview are [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
|
||||||
build it with Insiders. When using built-in plugins exclusive to Insiders, it's
|
build it with Insiders. When using built-in plugins exclusive to Insiders, it's
|
||||||
recommended to split configuration into a base `mkdocs.yml` and one with plugin
|
recommended to split configuration into a base `mkdocs.yml` and one with plugin
|
||||||
overrides via [configuration inheritance].
|
overrides via [configuration inheritance].
|
||||||
|
|
||||||
See the [getting started guide] for more information.
|
See the [getting started guide] for more information.
|
||||||
@ -399,12 +399,12 @@ See the [getting started guide] for more information.
|
|||||||
[getting started guide]: ../insiders/getting-started.md#caveats
|
[getting started guide]: ../insiders/getting-started.md#caveats
|
||||||
[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 }
|
||||||
|
|
||||||
If you have any questions and would like to contact us before starting your
|
If you have any questions and would like to contact us before starting your
|
||||||
sponsorship, we are happy to answer all your non-technical questions about the
|
sponsorship, we are happy to answer all your non-technical questions about the
|
||||||
Insiders program via email at sponsors@squidfunk.com.
|
Insiders program via email at sponsors@squidfunk.com.
|
||||||
|
|
||||||
All technical questions should be asked openly on our [discussion board].
|
All technical questions should be asked openly on our [discussion board].
|
||||||
@ -414,15 +414,15 @@ All technical questions should be asked openly on our [discussion board].
|
|||||||
[__Is additional support available for Material for MkDocs Insiders users?__](#support-additional){ #support-additional }
|
[__Is additional support available for Material for MkDocs Insiders users?__](#support-additional){ #support-additional }
|
||||||
|
|
||||||
Yes, we provide non-technical support related to sponsoring at
|
Yes, we provide non-technical support related to sponsoring at
|
||||||
sponsors@squidfunk.com. For technical questions, please submit an issue openly
|
sponsors@squidfunk.com. For technical questions, please submit an issue openly
|
||||||
on our [issue tracker] or start a discussion on our [discussion board]. Issues
|
on our [issue tracker] or start a discussion on our [discussion board]. Issues
|
||||||
and discussions from our organizational sponsors, sponsoring on
|
and discussions from our organizational sponsors, sponsoring on
|
||||||
__The Organization__ tier or higher will be prioritized.[^1]
|
__The Organization__ tier or higher will be prioritized.[^1]
|
||||||
|
|
||||||
[^1]:
|
[^1]:
|
||||||
Priority support means we will prioritize your issue, meaning we will look
|
Priority support means we will prioritize your issue, meaning we will look
|
||||||
into it and do our best to solve your issue asap. However, the prioritized bug
|
into it and do our best to solve your issue asap. However, the prioritized bug
|
||||||
support does not mean that we can solve your issue before any others since
|
support does not mean that we can solve your issue before any others since
|
||||||
some issues might take more time to solve.
|
some issues might take more time to solve.
|
||||||
|
|
||||||
[issue tracker]: https://github.com/squidfunk/mkdocs-material/issues
|
[issue tracker]: https://github.com/squidfunk/mkdocs-material/issues
|
||||||
@ -433,49 +433,75 @@ If your sponsorship tier includes logo placement, and you would like us to
|
|||||||
display your logo in the [list of premium sponsors] and have it linked to your
|
display your logo in the [list of premium sponsors] and have it linked to your
|
||||||
site, please contact us via mail. Simply send us a horizontal SVG or PNG version
|
site, please contact us via mail. Simply send us a horizontal SVG or PNG version
|
||||||
of your logo making sure it displays the name of your company and the logo to
|
of your logo making sure it displays the name of your company and the logo to
|
||||||
sponsors@squidfunk.com.
|
sponsors@squidfunk.com.
|
||||||
|
|
||||||
[list of premium sponsors]: https://github.com/squidfunk/mkdocs-material#user-content-premium-sponsors
|
[list of premium sponsors]: https://github.com/squidfunk/mkdocs-material#user-content-premium-sponsors
|
||||||
|
|
||||||
[__Is logo placement optional?__](#sponsorship-logo-placement-optional){ #sponsorship-logo-placement-optional }
|
[__Is logo placement optional?__](#sponsorship-logo-placement-optional){ #sponsorship-logo-placement-optional }
|
||||||
|
|
||||||
Yes, all of our commercial benefits, such as logo placement and backlinks, are
|
Yes, all of our commercial benefits, such as logo placement and backlinks, are
|
||||||
optional and can be opted in or out at any time. You can keep your sponsorship
|
optional and can be opted in or out at any time. You can keep your sponsorship
|
||||||
completely private.
|
completely private.
|
||||||
|
|
||||||
[__How can I report a bug in the Insiders version?__](#insiders-bugs){ #insiders-bugs }
|
[__How can I report a bug in the Insiders version?__](#insiders-bugs){ #insiders-bugs }
|
||||||
|
|
||||||
If you encounter a bug in the Insiders edition, we kindly request that you
|
If you encounter a bug in the Insiders edition, we kindly request that you
|
||||||
report it on our [issue tracker] in the public community repository. When
|
report it on our [issue tracker] in the public community repository. When
|
||||||
submitting the bug report, please ensure that you do not include any private
|
submitting the bug report, please ensure that you do not include any private
|
||||||
Insiders' source code, as we want to uphold our fair use policy.
|
Insiders' source code, as we want to uphold our fair use policy.
|
||||||
|
|
||||||
|
[__How can I report an issue in my customizations?__](#customizations-issues){ #costumisations-issues }
|
||||||
|
|
||||||
## Privacy
|
Please note, that we do not offer support for customizations as they vary
|
||||||
|
widely and are specific to individual cases. Our support is primarily focused on
|
||||||
|
assisting with our core features. When reporting an issue, please remove all
|
||||||
|
customizations to ensure effective problem diagnosis with a minimal reproduction
|
||||||
|
[.zip file], as described in our bug reporting guide. Our [built-in info plugin],
|
||||||
|
which is essential when creating a reproduction, will not function correctly
|
||||||
|
with customizations in place. For questions and issues with customizations,
|
||||||
|
please use our [discussion board] to engage with the community.
|
||||||
|
|
||||||
|
[.zip file]: ../guides/creating-a-reproduction.md
|
||||||
|
[built-in info plugin]: https://squidfunk.github.io/mkdocs-material/guides/creating-a-reproduction/#creating-a-zip-file
|
||||||
|
|
||||||
|
## Privacy
|
||||||
|
|
||||||
[__Will you sign an NDA for sponsorships?__](#nda){ #nda }
|
[__Will you sign an NDA for sponsorships?__](#nda){ #nda }
|
||||||
|
|
||||||
Unfortunately, we cannot sign any NDA or vendor agreement form. As a small team
|
Unfortunately, we cannot sign any NDA or vendor agreement form. As a small team
|
||||||
working on Material for MkDocs, we have limited resources and cannot review
|
working on Material for MkDocs, we have limited resources and cannot review
|
||||||
and sign agreements.
|
and sign agreements.
|
||||||
|
|
||||||
|
[__Will you fill out our companys forms?__](#forms){ #forms }
|
||||||
|
|
||||||
|
To dedicate more time and resources to the development of our projects, we have
|
||||||
|
implemented measures to minimize administrative overhead for our small team. As
|
||||||
|
part of this approach, we have adopted GitHub Sponsors to efficiently handle all
|
||||||
|
transactions for us. Consequently, we have decided to introduce a setup fee for
|
||||||
|
any additional administrative tasks other than those handled by GitHub Sponsors
|
||||||
|
that require our attention and involve the completion of forms or adherence to
|
||||||
|
company processes when purchasing Material for MkDocs Insiders. If your purchase
|
||||||
|
departmenz requires additional time and effort from our team, please be aware
|
||||||
|
that the setup fee will apply. For detailed information and specific inquiries,
|
||||||
|
please reach out to us at sponsors@squidfunk.com.
|
||||||
|
|
||||||
[__Can I sponsor privately?__](#sponsorship-private){ #sponsorship-private }
|
[__Can I sponsor privately?__](#sponsorship-private){ #sponsorship-private }
|
||||||
|
|
||||||
Yes, you can. GitHub gives you the option to set your sponsorship to [private]
|
Yes, you can. GitHub gives you the option to set your sponsorship to [private]
|
||||||
when you set up your sponsorship. Additionally, we have a recommended workflow
|
when you set up your sponsorship. Additionally, we have a recommended workflow
|
||||||
for you: We suggest you create a new GitHub bot account. This bot account should
|
for you: We suggest you create a new GitHub bot account. This bot account should
|
||||||
not be tied to a particular individual and should be privately listed as an
|
not be tied to a particular individual and should be privately listed as an
|
||||||
owner of your GitHub organization. This account can then be used to sponsor
|
owner of your GitHub organization. This account can then be used to sponsor
|
||||||
Material for MkDocs privately. As a bot account, it will automatically be listed
|
Material for MkDocs privately. As a bot account, it will automatically be listed
|
||||||
as a collaborator of the private Insiders repository. You can clone, fork, or
|
as a collaborator of the private Insiders repository. You can clone, fork, or
|
||||||
mirror using this account. All information will be kept confidential; only the
|
mirror using this account. All information will be kept confidential; only the
|
||||||
bot account and us maintainers will have insights into his sponsorship.
|
bot account and us maintainers will have insights into his sponsorship.
|
||||||
|
|
||||||
[private]: https://docs.github.com/en/sponsors/sponsoring-open-source-contributors/managing-your-sponsorship#managing-the-privacy-setting-for-your-sponsorship
|
[private]: https://docs.github.com/en/sponsors/sponsoring-open-source-contributors/managing-your-sponsorship#managing-the-privacy-setting-for-your-sponsorship
|
||||||
|
|
||||||
[__Are there any geographical restrictions on becoming a sponsor?__](#sponsorship-geo){ #sponsorship-geo }
|
[__Are there any geographical restrictions on becoming a sponsor?__](#sponsorship-geo){ #sponsorship-geo }
|
||||||
|
|
||||||
No, there are no geographical restrictions for becoming a sponsor. We welcome
|
No, there are no geographical restrictions for becoming a sponsor. We welcome
|
||||||
sponsorships from individuals and organizations worldwide. As long as your
|
sponsorships from individuals and organizations worldwide. As long as your
|
||||||
credit card is valid and accepted by GitHub or Ko-Fi, you are eligible to become
|
credit card is valid and accepted by GitHub or Ko-Fi, you are eligible to become
|
||||||
a sponsor and support the project, regardless of your location.
|
a sponsor and support the project, regardless of your location.
|
@ -255,6 +255,7 @@ nav:
|
|||||||
- Insiders:
|
- Insiders:
|
||||||
- insiders/index.md
|
- insiders/index.md
|
||||||
- Getting started: insiders/getting-started.md
|
- Getting started: insiders/getting-started.md
|
||||||
|
- FAQ: insiders/faq/sponsoring.md
|
||||||
- Changelog:
|
- Changelog:
|
||||||
- insiders/changelog/index.md
|
- insiders/changelog/index.md
|
||||||
- How to upgrade: insiders/upgrade.md
|
- How to upgrade: insiders/upgrade.md
|
||||||
|
Loading…
Reference in New Issue
Block a user