In my previous post I introduced the use of Git and its powerful way to keep a print on every updates that happens on a material. As I have said we were already used to use Git for managing our software projects source code. But now we wanted to extend its usage to other materials. In this post I will tell you how you can use the new blogging environment based on Git in order to write new article or just suggest improvements on existing contents. By using Git for our blogging environment we allow anyone to be able to contribute on the blog content even those that are not actual members of Forge’it.
The new blogging environment
Here we go. Git is a distributed version control system means your project is actually stored in a repository of files and anytime you commit new modifications, the Git repository records a print of the update so that anybody that contribute to the project can actually go backward in the repository history and see all the updates that applied from the whole contributors and those from the very beginning of the project. Although the Git repository can be duplicated and make the materials data decentralized, we still require a Git hosting server to expose the repository online, so people can fetch it and contribute. Several services exist such as Github, Bitbucket, Gitlab, Gogs or just setting up an adhoc Git server. At Forge’it we made the choice to use Gitlab, first because compared with most of its competitors it’s entirely Open Sourced. At anytime you can install your own instance of Gitlab on your own server and transfer the whole content. And second, because it offers very powerful features such as Merge Requests Approving flow. I am going to detail this later. Therefore there is a group on Gitlab called 4ge.it that stores all the Git repository based projects including the current blog of Forge’it.
Signing up on Gitlab.com
If you already have a Google, Twitter, Github or Bitbucket account, you can actually connect to Gitlab without having to create a new account.
Once your account is created, you can sign in anytime just by filling the Sign in form with your Gitlab username and password.
Once you are successfully signed in, you should see the Gitlab dashboard with no existing projects yet.
Now you are ready to get access to the public 4ge.it Gitlab group. Most of the Forge’it, as long as there is no obvious reason to keep repositories private, are public, so anybody online can see the source code of the projects and even contribute on them. If you are willing to become a member of the group and contribute actively on the projects, you will need to request your will to become a member of the group by clicking on the Request Access button. All the members will therefore get notified by email and they should approve your membership very quickly.
Being a member of the group gives you a few more privileges. You will be able to access to the private repositories of the group such as the content of the Forge’it Team Blog we keep internally. Now, from the Forge’it Group page, you should see the public project blog.
You can click on the project and get access to the Blog project board.
The Gitlab project board allows to access to all the information related with the project repository and additionally provides tools such as an Issues Tracker and some others that I will eventually explain in my future posts. For now, we only need to know how we can create a post on the blog. Therefore you need to access to the files hierarchy of the project repository by going on the Repository section. You should see the following files hierarchy appearing on your screen.
Something important to know is that all the posts of the blog are actually stored as a textual file within the folder named _posts. So before create a new post, you will need to click on the _posts folder. Lost? Here is a link to access directly to the _posts folder.
From the _posts folder, you can click on the plus button available on the top (see the following screenshot) and select the option New file in the dropdown menu in order to create a new post.
You will therefore be directed to a new page in order to create your new file.
Interesting things start now. First some concepts need to be explained here. A Git repository can have several branches that enable to have different versions of the project repository. In software development, Git branches are commonly used to separate the development version of the product from the production one. What is interesting to remember so far is that the master branch is actually the default and the main branch of any Git repository. Another interesting feature of branches is that you can actually merge two branches, one into another. This is very useful, for instance if you want to improve something in your own branch without polluting the master branch and only merge to the master once you finished.
At Forge’it, we are protecting all the Git repositories master branch so nobody even our members are not allowed to merge their branches to the Forge’it group projects master branches. But that’s not all, they cannot also directly make changes on the files available in the master branch thanks to a protected branch feature.
So how can someone contribute to the repository and suggest an update, create a new blog post? The short answer is by using Fork and Merge Request. Since you are not allowed to make directly changes to the Blog project, once you created a new file, Gitlab automatically Forked (duplicated) the project and put the duplicated project into your user space with you own branch. And once you will commit your changes (at this stage by creating a new file) to your version of the project, you will be then invited to create a merge request, in order to request a merge of your version of the repository with the original Blog project repository.
Sending a merge request with your new post doesn’t mean that your post will be automatically merged within the original Blog project. Indeed, it requires actually a minimum of approvals from the group members in order to be approved. The Merge Requests section of the project allowed to follow up the status of the request. You will also know if some improvements are required before approving it or if it does not respect the Contributing Guide.
Create a new post
Fair enough, we are ready to create our new blog post now. The Blog posts use the Markdown styling syntax to decorate the content in order to add headlines, bold and italic texts, links, images and tables into your post. If you are not familiar with the Markdown styling syntax, you can take a look to this guide to have a complete documentation about the possibility offered by Markdown though I will list some syntaxes below.
First, since your post will be stored in the project as a file, you will be required to name your post file. Here are some examples of file names we already used for our past posts:
Basically, the file name should only contains alphanumerical characters without accents and whitespaces and use instead dashes to separate words. The file name is prefix with the current date in the ISO format (e.g. 2016-07-09) followed by a dash and the post title you want to use as a title for your new post, and suffixed with .md file extension (Markdown file extension).
Before starting to write your blog post, a last step is needed. You need to add the following header variables in the top of your post content.
--- layout: post title: How Can I Write a Post ? subtitle: On the Forge'it Blog date: "2016-07-06 17:26:00" tags: [git,blog,post] author: caner header-img: "img/blogging.jpg" ---
You can update the header variables according to your post and following these rules:
- the post header must have the
---line before and after.
- the variable
layouthave to keep the value
post. I will introduce in another post the Static Generator Engine of the blog and how to create new layout.
- the variable
titleis the actual title of your blog post.
- the variable
subtitleis a subtitle for your blog post.
- the variable
dateis the publication date of your post following the ISO format (YYYY-MM-DD hh:mm:ss).
- the variable
tagsis a list of tags related with your post. You have to use the
]before and after the list and separate each tag by a comma.
- the variable
authoris an ID used to define the author of the post. You should also add your own information such as your name, email address, etc in another file I will explain later.
- the variable
header-imgis the path to the post banner image. I will show you later how to upload the image to the repository.
Now you are ready to write your post content. You can find below some examples of Markdown syntax usage in order to be familiar with it.
- To bold your text, you need to use the mark
**around your text as follows:
- To write in italic your text, you need to use the mark
*around your text as follows:
- To add a link to your text, you need to use the following syntax:
[some words](https://www.awesome-website.xyz). You place between
]the text of the link and between
), the actual URL of the link.
- To add a buddeted list of items, you just need to use the mark
*at the beginning of the line followed by a whitespace as follows:
* item 1.
- To add an image, use the following syntax:
![some words to describe the image](https://www.awesome-website.xyz/images/my-awesome-image.png)
- To add a headline, you just need to use the mark
###according to your headline size followed by the actual headline title.
#is the biggest size. For instance:
## My title.
- To add a code sample in your post, you have two ways to do it, either inlined or in a block. For inlined code, you can use the mark ` around your code sample which may give as a result:
My code example. For block of code, you can use the mark ``` around the code block as follows:
<html> <body></body> </html>
Go ahead write you post content and when you have finished you can keep reading the rest of the explanation.
When you finished you can click on the green Commit Changes button, on the bottom of the page. You should be directed to a new page where you are invited to sent a Merge Request.
You can edit the Merge Request title and add a description to describe the reason you want the team members to merge your new post and click on the green Submit merge request button.
You are done, your new post merge request has been sent, now the team members will need to approve it in order to merge your post into the Blog project.