Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Community content #26

Merged
merged 6 commits into from
Mar 19, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
The diff you're trying to view is too large. We only load the first 3000 changed files.
189 changes: 44 additions & 145 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,145 +1,44 @@
![](/assets/banner.png)

# Strapi Tutorials

Strapi is very excited to gather a collection of tutorials on the new [Strapi Tutorials page](https://strapi.io/tutorials)

## How to add a tutorial

There are different cases for adding a tutorial:

1. You want to list an existing tutorial on the web
- Create a new branch: `git checkout -b request/<name-of-tutorial>`
- Create a `<name-of-tutorial>.yml` inside the `tutorials` folder and fill it like the example under
- Create a pull request
2. You want to add your own tutorial
- [How to write a tutorial](#how-to-write-a-tutorial)

This one is an example of the Strapi-Gatsby tutorial

```yaml
- title: Building a Static Blog using Gatsby and Strapi
link: https://blog.strapi.io/building-a-static-website-using-gatsby-and-strapi/
formats:
- article
language: en
date: 2018-01-18
authors:
- David Kartuzinski
github_authors:
- davidkartuzinski
source: 'https://blog.strapi.io/'
image_url: 'https://blog.strapi.io/content/images/2018/11/gatsby-strapi.png'
topics:
- gatsby
- strapi
- blog
version: beta
```

### How to request a tutorial

- Create an issue with the template `Request a tutorial`
- Assign all the necessary labels including the `To do` label

### How to consult tutorials ideas

- Go on the Github repository and consult either the issue or the project

## How to write a tutorial

If you intend to create a tutorial, please check our [guidelines](https://github.com/Mcastres/tutorials/blob/master/GUIDELINES.md) first.

There are different cases:

1. The tutorial hasn't been proposed yet
- Create an issue with the template `Create a tutorial`
- Create a new branch: `git checkout -b create/<name-of-tutorial>`
- Create the tutorial and make a pull request by adding a new folder inside `tutorials` containing the content of your tutorial as well as the `<name-of-tutorial>.yml` file. (the .yml file must be **inside** your new tutorial folder)
- We will update the issue from **In progress** to **Done**
2. The tutorial is looking for an author (you are doing a proposed tutorial)
- Create a new branch: `git checkout -b create/<name-of-tutorial>`
- Create the tutorial and make a pull request by adding a new folder inside `tutorials` containing the content of your tutorial as well as the `<name-of-tutorial>.yml` file. (the .yml file must be **inside** your new tutorial folder)
- We will update the issue from **Looking for author** to **Done**

**Please follow this format and indentation:**

```yaml
- title: Building a Static Blog using Gatsby and Strapi
link: https://blog.strapi.io/building-a-static-website-using-gatsby-and-strapi/
formats:
- article
language: en
date: 2018-01-18
authors:
- David Kartuzinski
github_authors:
- davidkartuzinski
source: 'https://blog.strapi.io/'
image_url: 'https://blog.strapi.io/content/images/2018/11/gatsby-strapi.png'
topics:
- gatsby
- strapi
- blog
version: beta
```

- `title` - Title of tutorial (`string`; **required**)
- `link` - Working URL where tutorial can be found (`string`; **required**)
- `formats` - Media format of tutorial (`array` of `strings` with values `video`, `audio` or `article`; **required**)
- `language` - Spoken/written language of the tutorial (`string` with a two-letter [ISO 639-1 language code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes); optional)
- `date` - Date tutorial was published (`string` in `YYYY-MM-DD` format; optional)
- `authors` - Name of author(s) or speaker(s) (`array` of `strings`; **required**)
- `github_authors` - Github username of author(s) or speaker(s) (`array` of `strings`; optional)
- `source` - Source of the tutorial (`string`; optional)
- `image_url` - Url image of the tutorial (`string`; optional)
- `topics` - Main topic(s) covered by the tutorial (`array` of `strings`; **required**)
- `version` - Version of Strapi used in the tutorial (`string`; require)

## Why write for us?

Here are few things that writing for strapi can do for you:

- Learn while sharing your knowledge. You know how to create an application with Strapi and Nuxt? Pass this knowledge to others!
- Get your name on this repository README
- Get access to a private slack channel `makers`
- Get a custom emoji on our slack channel
- Get some strapi goodies (stickers, cap, t-shirt)

**By making a tutorial for us you participate in the growth of an open source project.**

## Makers

Thank you to all the people who made tutorials for the community!

<p float="left">
<img src="https://github.com/iam4x.png" width="80" height="80" />
<img src="https://github.com/ryanbelke.png" width="80" height="80" />
<img src="https://github.com/bahdcoder.png" width="80" height="80" />
<img src="https://github.com/john-smilga.png" width="80" height="80" />
<img src="https://github.com/pappinvijak.png" width="80" height="80" />
<img src="https://github.com/jlengstorf.png" width="80" height="80" />
<img src="https://github.com/rpragana.png" width="80" height="80" />
<img src="https://github.com/pgmichael.png" width="80" height="80" />
<img src="https://github.com/shahinrostami.png" width="80" height="80" />
<img src="https://github.com/tamirandtom.png" width="80" height="80" />
<img src="https://github.com/femithz.png" width="80" height="80" />
<img src="https://github.com/reedbarger.png" width="80" height="80" />
<img src="https://github.com/davidkartuzinski.png" width="80" height="80" />
<img src="https://github.com/pierreburgy.png" width="80" height="80" />
<img src="https://github.com/mcastres.png" width="80" height="80" />
<img src="https://github.com/fabio-nettis.png" width="80" height="80" />
<img src="https://github.com/pouyamiralayi.png" width="80" height="80" />
<img src="https://github.com/ivandoric.png" width="80" height="80" />
<img src="https://github.com/GalloDaSballo.png" width="80" height="80" />
<img src="https://github.com/Nauman440.png" width="80" height="80" />
<img src="https://github.com/rajdip34.png" width="80" height="80" />
<img src="https://github.com/derrickmehaffy.png" width="80" height="80" />
<img src="https://github.com/soupette.png" width="80" height="80" />
<img src="https://github.com/enBonnet.png" width="80" height="80" />
<img src="https://github.com/juanpablogdl.png" width="80" height="80" />
<img src="https://github.com/ghoshnirmalya.png" width="80" height="80" />

</p>

[Join them by creating your tutorial](https://github.com/strapi/strapi-tutorials/issues/new?assignees=Mcastres&labels=In+progress&template=create-a-tutorial.md&title=%5BCREATE%5D)
![Community content](/assets/banner-community-content.png)

# Community content

Contribute and collaborate on educational content for the Strapi Community

- [Tutorials](#Tutorials)
- [Articles](#Articles)
- [Showcase](#Showcase)

## Tutorials

Follow along with our community tutorials to get you up and running with Strapi.

- [Request a tutorial](https://github.com/strapi/community-content/issues/new?assignees=Mcastres&labels=To+do&template=request-a-tutorial.md&title=%5BREQUEST%5D)
- [Create a tutorial](https://github.com/strapi/community-content/issues/new?assignees=Mcastres&labels=In+progress&template=create-a-tutorial.md&title=%5BCREATE%5D)
- [Improve a tutorial](https://github.com/strapi/community-content/issues/new?assignees=Mcastres&labels=To+do&template=update-a-tutorial.md&title=%5BUPDATE%5D)
- [Translate a tutorial](https://github.com/strapi/community-content/issues/new?assignees=Mcastres&template=translate-a-tutorial.md&title=%5BTRANSLATE%5D)


[Tutorials](https://github.com/strapi/community-content/tree/master/tutorials)


## Articles

Write about your experience with Strapi.

We're looking for writers who'd like to talk about their experience using Strapi, JAMstack or open source related things. Although we're mostly looking for experienced authors who have already published blog posts on websites such as [Medium](https://medium.com), [Dev.to](http://dev.to/), [Hackernoon](https://hackernoon.com), [Scotch.io](http://scotch.io/) or your personal blog, we're also supportive of people who have never published anything but interesting in a writing their first technical piece.

You will definitely pick our interest if you can write articles that go quite in-depth and include a significant number of learning nuggets. We're absolutely NOT looking for promotional pieces or marketing pitches. It's all about interesting thins to tell to the community concerning everything that operate in the Strapi environment.

[Articles](https://github.com/strapi/community-content/tree/master/articles)


## Showcase

Show to the community what your project looks like

The entire Strapi team is very curious to see what you guy's can build using our product and it may be the same for people in the community who want to reassure themselves about what we can create with Strapi.

We decided to create a [Showcase](https://github.com/strapi/community-content/tree/master/showcase) section where anyone can list his site that has been made with love, and Strapi off course! This list will be displayed on our website soon.


[Showcase](https://github.com/strapi/community-content/tree/master/showcase)
34 changes: 34 additions & 0 deletions articles/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
![Articles](/assets/banner-articles.png)

# Articles

Write about your experience with Strapi.

We're looking for writers who'd like to talk about their experience using Strapi, JAMstack or open source related things. Although we're mostly looking for experienced authors who have already published blog posts on websites such as [Medium](https://medium.com), [Dev.to](http://dev.to/), [Hackernoon](https://hackernoon.com), [Scotch.io](http://scotch.io/) or your personal blog, we're also supportive of people who have never published anything but interesting in a writing their first technical piece.

You will definitely pick our interest if you can write articles that go quite in-depth and include a significant number of learning nuggets. We're absolutely NOT looking for promotional pieces or marketing pitches. It's all about interesting thins to tell to the community concerning everything that operate in the Strapi environment.

## How to add an article

- First of all, verify that this article is not already listed. You never know, someone could have done it before you.
- Edit the `articles.yml` file by adding your submission with the following format:

```yaml
- title: Title of the article
url: https://medium.com/strapi-single-types
source: https://medium.com/
description: Nicely written article explaining how Single Types work
categories:
- Feature
written_by: John smith
written_by_url: https://john-smith.io
```


- `title` - Title of the article (`string`; **required**)
- `url` - Url of the article (`string`; **required**)
- `source` - Source of the article (`string`; **required**)
- `description` - Little description (`string`; **required**)
- `categories` - Categories of the article (`array` of `strings`; **required**)
- `written_by` - Who wrote this awesome article? (`string`; **required**)
- `written_by_url` - Url of the person/agency who wrote this article (`string`; **required**)
File renamed without changes.
Binary file added assets/banner-articles.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/banner-community-content.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/banner-showcase.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/banner-tutorials.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed assets/banner.png
Binary file not shown.
37 changes: 37 additions & 0 deletions showcase/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
![Showcase](/assets/banner-showcase.png)

# Showcase

Show to the community what your Strapi project looks like!

Show to the community what your project looks like

The entire Strapi team is very curious to see what you guy's can build using our product and it may be the same for people in the community who want to reassure themselves about what we can create with Strapi.

We decided to create a [Showcase](https://github.com/strapi/community-content/tree/master/showcase) section where anyone can list his site that has been made with love, and Strapi off course! This list will be displayed on our website soon.

## How to add your site

- First of all, verify that your site is not already listed. You never know, someone could have done it before you.
- Edit the `sites.yml` file by adding your submission with the following format:

```yaml
- title: Title of your Site
url: https://yourawesomesite.com
description: This awesome website is using Strapi for managing the content of my Nuxt.js application
categories:
- Corporate website
frontend:
- Nuxt.js
- UIkit
made_by: John smith
made_by_url: https://john-smith.io
```

- `title` - Title of your site (`string`; **required**)
- `url` - Url of your site (`string`; **required**)
- `description` - Little description (`string`; **required**)
- `categories` - Categories of your site (`array` of `strings`; **required**)
- `frontend` - Frontend teck used in your site (`array` of `strings`; **required**)
- `made_by` - Who made this awesome website? (`string`; **required**)
- `made_by_url` - Url of the person/agency who made this site (`string`; **required**)
File renamed without changes.
File renamed without changes.
121 changes: 121 additions & 0 deletions tutorials/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
![Tutorials](/assets/banner-tutorials.png)

# Tutorials

Follow along with our community tutorials to get you up and running with Strapi: [https://strapi.io/tutorials](https://strapi.io/tutorials)

## How to add a tutorial

There are different cases for adding a tutorial:

1. You want to list an **existing tutorial** on the web
- Edit the `tutorials.yml` file by adding the tutorial.
2. You want to add your own tutorial
- [How to write a tutorial](#how-to-write-a-tutorial)

### How to request a tutorial

- Create an issue with the template [Request a tutorial](https://github.com/strapi/community-content/issues/new?assignees=Mcastres&labels=To+do&template=request-a-tutorial.md&title=%5BREQUEST%5D)
- Assign all the necessary labels including the `To do` label

### How to consult tutorials ideas

- Go on the Github repository and consult either the issue or the project

## How to write a tutorial

If you intend to create a tutorial, please check our [guidelines](https://github.com/Mcastres/tutorials/blob/master/GUIDELINES.md) first.

There are different cases:

1. The tutorial hasn't been proposed yet
- Create an issue with the template `Create a tutorial`
- Create a new branch: `git checkout -b create/<name-of-tutorial>`
- Create the tutorial and make a pull request by adding a new folder inside `tutorials/code` containing the code of your tutorial as well as editing the `tutorials.yml` file by listing your creation.
- We will update the issue from **In progress** to **Done**
2. The tutorial is looking for an author (you are doing a requested tutorial)
- Create a new branch: `git checkout -b create/<name-of-tutorial>`
- Create the tutorial and make a pull request by adding a new folder inside `tutorials/code` containing the code of your tutorial as well as editing the `tutorials.yml` file by listing your creation.
- We will update the issue from **Looking for author** to **Done**

**Please follow this format and indentation:**

```yaml
- title: Building a Static Blog using Gatsby and Strapi
link: https://blog.strapi.io/building-a-static-website-using-gatsby-and-strapi/
formats:
- article
language: en
date: 2018-01-18
authors:
- David Kartuzinski
github_authors:
- davidkartuzinski
source: 'https://blog.strapi.io/'
image_url: 'https://blog.strapi.io/content/images/2018/11/gatsby-strapi.png'
topics:
- gatsby
- strapi
- blog
version: beta
```

- `title` - Title of tutorial (`string`; **required**)
- `link` - Working URL where tutorial can be found (`string`; **required**)
- `formats` - Media format of tutorial (`array` of `strings` with values `video`, `audio` or `article`; **required**)
- `language` - Spoken/written language of the tutorial (`string` with a two-letter [ISO 639-1 language code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes); optional)
- `date` - Date tutorial was published (`string` in `YYYY-MM-DD` format; optional)
- `authors` - Name of author(s) or speaker(s) (`array` of `strings`; **required**)
- `github_authors` - Github username of author(s) or speaker(s) (`array` of `strings`; optional)
- `source` - Source of the tutorial (`string`; optional)
- `image_url` - Url image of the tutorial (`string`; optional)
- `topics` - Main topic(s) covered by the tutorial (`array` of `strings`; **required**)
- `version` - Version of Strapi used in the tutorial (`string`; require)

## Why write for us?

Here are few things that writing for strapi can do for you:

- Learn while sharing your knowledge. You know how to create an application with Strapi and Nuxt? Pass this knowledge to others!
- Get your name on this repository README.md
- Get access to a private slack channel `makers`
- Get some strapi goodies (stickers, cap, t-shirt)
- Get a complete Strapi course

**By making a tutorial for us you participate in the growth of an open source project.**

## Makers

Thank you to all the people who made tutorials for the community!

<p float="left">
<img src="https://github.com/iam4x.png" width="80" height="80" />
<img src="https://github.com/ryanbelke.png" width="80" height="80" />
<img src="https://github.com/bahdcoder.png" width="80" height="80" />
<img src="https://github.com/john-smilga.png" width="80" height="80" />
<img src="https://github.com/pappinvijak.png" width="80" height="80" />
<img src="https://github.com/jlengstorf.png" width="80" height="80" />
<img src="https://github.com/rpragana.png" width="80" height="80" />
<img src="https://github.com/pgmichael.png" width="80" height="80" />
<img src="https://github.com/shahinrostami.png" width="80" height="80" />
<img src="https://github.com/tamirandtom.png" width="80" height="80" />
<img src="https://github.com/femithz.png" width="80" height="80" />
<img src="https://github.com/reedbarger.png" width="80" height="80" />
<img src="https://github.com/davidkartuzinski.png" width="80" height="80" />
<img src="https://github.com/pierreburgy.png" width="80" height="80" />
<img src="https://github.com/mcastres.png" width="80" height="80" />
<img src="https://github.com/fabio-nettis.png" width="80" height="80" />
<img src="https://github.com/pouyamiralayi.png" width="80" height="80" />
<img src="https://github.com/ivandoric.png" width="80" height="80" />
<img src="https://github.com/GalloDaSballo.png" width="80" height="80" />
<img src="https://github.com/Nauman440.png" width="80" height="80" />
<img src="https://github.com/rajdip34.png" width="80" height="80" />
<img src="https://github.com/derrickmehaffy.png" width="80" height="80" />
<img src="https://github.com/soupette.png" width="80" height="80" />
<img src="https://github.com/enBonnet.png" width="80" height="80" />
<img src="https://github.com/juanpablogdl.png" width="80" height="80" />
<img src="https://github.com/ghoshnirmalya.png" width="80" height="80" />

</p>

[Join them by creating your tutorial](https://github.com/strapi/strapi-tutorials/issues/new?assignees=Mcastres&labels=In+progress&template=create-a-tutorial.md&title=%5BCREATE%5D)
Loading