Skip to content

Latest commit

 

History

History
122 lines (82 loc) · 7.11 KB

contribute.mdx

File metadata and controls

122 lines (82 loc) · 7.11 KB
Raw
meta content tags cta
title description
Scaleway Write for the Community program
This page explains how to participate in the Scaleway Write for the Community program.
h1 paragraph
Write for the Community program
This page explains how to participate in the Scaleway Write for the Community program.
write-for-the-community community contribute git voucher
false

Join the Scaleway Write for the Community program, an initiative for making our open-source Documentation a truly collaborative knowledge center.

Become a contributor

Before creating your content, carefully read the instructions and conditions below:

  - Read our [contribution guidelines](https://github.com/scaleway/docs-content/blob/854cc72797d4103d0475f35f977f32339d6e94f5/docs/CONTRIBUTING.md), [writing guidelines](/guidelines/) and [code of conduct](https://github.com/scaleway/docs-content/blob/854cc72797d4103d0475f35f977f32339d6e94f5/docs/CODE_OF_CONDUCT.md).
  - To be rewarded with Scaleway credits, you must:
    - Submit a tutorial idea via a [documentation request issue](https://github.com/scaleway/docs-content/issues/new?assignees=&labels=Documentation+Request&template=doc_request.yaml&title=%5B%F0%9F%91%A9%E2%80%8D%F0%9F%92%BB+Documentation+Request%5D%3A+).
    - Write the content yourself and submit it following our [contribution process](https://github.com/scaleway/docs-content/blob/main/docs/CONTRIBUTING.md).
    - Your content must be merged and published by our team.
  - The reward depends on the content length:
    - **Between 500 and 1000 words**: €100 cloud credits.
    - **More than 1000 words**: up to €200 cloud credits.
  - Your contribution voucher is credited directly to your Scaleway account in the month following the publication and is **valid for up to three calendar months**.

    You are now ready to start contributing.

1. Clone our [public documentation repository](https://github.com/scaleway/docs-content/blob/main/docs/CONTRIBUTING.md/#use-repository-locally) on GitHub.
2. Create a new [documentation request issue](https://github.com/scaleway/docs-content/issues/new?assignees=&labels=Documentation+Request&template=doc_request.yaml&title=%5B%F0%9F%91%A9%E2%80%8D%F0%9F%92%BB+Documentation+Request%5D%3A+) to explain your idea. Include a short briefing of what you want to share in the tutorial.
    <Message type="tip">
      - Feel free to [join our Slack #documentation channel](https://scaleway-community.slack.com/archives/C01J2BT8TGX) to discuss your ideas directly with the team and our community.
      - You can also suggest documentation updates or report bugs by creating a [documentation bug issue](https://github.com/scaleway/docs-content/issues/new?assignees=&labels=Documentation+Bug&template=doc_bug.yaml&title=%5B%F0%9F%90%9E+Documentation+Bug%5D%3A+). Reports are not eligible for a paid reward but are welcomed nonetheless.
    </Message>
3. Our team reviews your issue and approves your request.
You can then write your content and submit it via a [pull request](https://github.com/scaleway/docs-content/pulls) in our repository.

#### How can I share my idea for a tutorial?

Open a [new issue](https://github.com/scaleway/docs-content/issues/new?assignees=&labels=Documentation+Request&template=doc_request.yaml&title=%5B%F0%9F%91%A9%E2%80%8D%F0%9F%92%BB+Documentation+Request%5D%3A+) in our GitHub repository using the documentation request template.
    <Message type="important">
      Do not forget to include your [Organization ID](/identity-and-access-management/iam/concepts/#organization-id) to receive your cloud credits.
    </Message>
You can also create a pull request directly in the [docs-content GitHub repository](https://github.com/scaleway/docs-content/pulls) but remember that only content approved via a documentation request issue is eligible for rewards.

#### How much do I get for writing a tutorial?

If you write a tutorial that gets published on our website, you will receive a voucher of **up to €200 cloud credits** in your Scaleway account.

Note that for receiving a reward, you must have:
  - Submitted your tutorial idea via a [documentation request issue](https://github.com/scaleway/docs-content/issues/new?assignees=&labels=Documentation+Request&template=doc_request.yaml&title=%5B%F0%9F%91%A9%E2%80%8D%F0%9F%92%BB+Documentation+Request%5D%3A+), which included your [Organization ID](https://www.scaleway.com/en/docs/identity-and-access-management/iam/how-to/accept-invitation-to-orga/) and was approved by our team.
  - Written the content yourself and followed our [contribution process](https://github.com/scaleway/docs-content/blob/main/docs/CONTRIBUTING.md).
  - Had your content merged and published by our team.

#### When will I receive my contribution reward?

Your contribution voucher is credited directly to your Scaleway account in the month following the publication, and is valid for up to three calendar months.

#### What can I write about?

You can write any tutorial that you think could be useful for Scaleway users. It must involve a Scaleway product and any third-party tools the tutorial involves must be free to use and open-source.

Need some inspiration? Read our [existing tutorials](/tutorials/) to see the kind of content we publish, and try checking our [documentation requests](https://github.com/scaleway/docs-content/issues) or [asking for ideas on the Community Slack](https://scaleway-community.slack.com/archives/C01J2BT8TGX).


#### Can I write in a language other than English?

No, all our content is published in English only.

#### Do I need to complete any additional paperwork after publication?

No, you are all set.

#### Can I post my content elsewhere?

No. If you submit content to us, this must be uniquely for the Scaleway Documentation website.

#### What about copyright, do I still own the content?

Scaleway considers any content our own after we publish it and compensate you.

#### What if I have an idea but do not want to write the content myself?

You are still welcome to get in touch with us.

[Submit your idea or suggestion](https://github.com/scaleway/docs-content/issues/new/choose) by opening a documentation request or bug issue, and specify that you do not plan on writing the content yourself.

You do not need to include your Organization ID, as you will not be eligible for a reward.

#### Do you have style guide that I should follow?

Yes! See our [guidelines](/guidelines/) page.