For Authors



For Authors

This is fully open source blog, where you can propose and make any kind of changes: UI, UX, blog articles, and many others.

Short workflow for tech authors

  • Fork and clone our blog repository
  • Create new branch: git checkout -b my_new_article
  • Create folder inside src/pages with the name of your article
  • create index.md file inside your folder
  • Put article content and metadata using Markdown format inside index.md file
  • Add all nesessary article images to your folder
  • Commit your changes: git add . && git commit
  • Push to remote repository branch: git push origin my_new_article
  • Send pull request and review your changes

Keep your branch till we accept your changes.

If something needs to be done additionaly, simply make all necessary changes, then

  • Update your local commit git add . && git commit --amend --no-edit
  • Update remote branch git push -f origin my_new_article

Long way for non-tech authors

Here we'll show you a process of adding new article using GitHub Web interface.

Fork repository

First of all you need to fork our public repository: https://github.com/hands-on-cloud/hands-on.cloud. Go to repository page and press Fork button.

Fork Repository

If you're contriguting to multiple organizations, choose your personal GitHub account.

Fork Repository Destination

Give GitHub a couple of seconds to make a copy of our repository.

Fork Repository Process

Create an article

First of all, create a new branch, where you'll be working under your article. In our case we'll be using my_new_article branch name.

New branch

As soon as new branch created, we may start working unders our article.

Go to src/pages folder.

Blog Articles Folder

Here we need create an article foder, which will contain article images and content written in Markdown (index.md). Folder name will be automatically converted to an article URL (for example, folder New Interesting Article will be automatically converted to /new-interesting-article/ URL.

Let's create folder and index.md file.

Press Create new file button.

Create New File

Type folder name at input field.

Creat Folder - Step 1

Press / to start typing file name.

Inter index.md to a field.

Creat Folder - Step 2

Article text and metadata

Next, put your article content styled using Markdown syntax in the file body.

At the beginning of the file content, you need to add additional block

---
title: 'New Interesting Article'
date: '2019-05-11'
thumbnail: './New-Interesting-Article.png'
tags:
  - aws cloud
  - certification
  - aws
  - devops
category: 'aws'
authors:
  - John Doe
---

Which will add additional medadata to your post like:

  • title - title of your article
  • date - publication date
  • tags - list of post tags; list of already available tags can be found here
  • category - category of an article; list of already available tags can be found here
  • authors - list of authors; put your name here, you'll see how to add author information below

Switch to Preview tab to see your changes. Do not pay attention to invisible images for now. We'll upload them later. At the next step.

Article preview

As soon as you're ready to publish your changes, describe your changes at the Commit new file section and press Commit new file button.

Commit Article

As a result you should have something like that:

Article Without Images

Adding images to the article

Thumbnail template: You may use this template to create article tumbnails.

At post metadata we specified thumbnail image with the name New-Interesting-Article.png, so we need to use exactly the same file name for uploaded image, otherwise we'll not be able to see it in the article.

Press Upload files button and upload your image(s).

Uploading Images

Checking final result

After uploading all images you may click on your article index.md file to review, how it looks like

Pre pull request review

If everything looks good, you may submit pull request.

Adding author imformation

At post metadata we specified John Doe as an author name.

To add information about this author, we need to create file John Doe.json at src/data/authors folder of our project:

Authors folder

Press Create new file button and add John Doe.json to the file name field. Use the following template to add information about yourself:

{
  "name": "John Doe",
  "avatar": "https://avatars2.githubusercontent.com/u/1902417?s=460&v=4",
  "bio": {
    "short": "John is a passionate Cloud Solutions Architect with 8+ years of experience",
    "long": "John is Cloud Solutions Architect, blogger, mentor. He is trying to make modern technologies available to the masses!"
  },
  "linkedin": "https://www.linkedin.com/in/avmaksimov",
  "github": "https://github.com/andreivmaksimov",
  "facebook": "https://business.facebook.com/andrei.v.maksimov",
  "twitter": "https://twitter.com/andreivmaksimov",
  "instagram": "https://www.instagram.com/andrei_v_maksimov"
}

Here's the filds description:

  • name - Author name. Should be the same as the file name without extension. In our example John Doe
  • avatar - You may use your GitHub profile image or one from Gravatar
  • bio - short and long biography description
  • linkedin - link to your LinkedIn profile
  • github - link to your GitHub profile
  • facebook - link to your Facebook profile
  • twitter - link to your Twitter profile
  • instagram - link to your Instagram profile

Author information

Making pull request

To send us your changes, go to repository homepage and click Compare & pull request button.

Making pull request - 1

Describe the changes you've made and press Send pull request button

Making pull request - 2

You'll see, how our automation is working

Making pull request - 3

Next, somebody from our team will verify your changes and merge them.



Article author

Andrei Maksimov

Andrei is a passionate Cloud Solutions Architect with 8+ years of experience