This repository is the main place to write blog posts that are intended to be published on the adesso AG's blog https://blog.adesso.de.
If this is your first time writing a blog post for the adesso AG blog site, first you need to add your author information within the authors.yml file located in _data/authors.yml. This is required because Jekyll will take your author information from that file and use them when generating HTML files from the post files.
Please add your information accordingly to the end of the list inside authors.yml. Here is an example on how the author information should be formatted:
johndoe:
first_name: John
last_name: Doe
github_username: jondoe
email: [email protected]
bio: "A short description/biography about the author."
avatar_url: /assets/images/avatars/jondoe.png
github: https://github.com/johndoe
To ensure the uniqueness of an authors name, we recommend using your github username as the root key name of the list (johndoe:).
Also note that the indentations under johndoe: are important for Jekylls building process. The indentations are done with two whitespaces (press the space bar two times).
You may also add a profile picture inside the assets/images/avatars directory.
Required author data are: first_name, last_name, github_username
All post files are markdown files and are located inside the _posts directory.
---
# layout is required. Don't change.
layout: [post, post-xml]
# title is required.
title: "adesso AG Blog Post Example"
# date is required. If possible, also provide a time. e.g. 2017-08-10 10:25:00.
date: 2017-08-10 10:25:00
# If you are modifying an existing post, provide a date for it.
modified_date:
# author must be your name used in the _data/authors.yml file.
author: jondoe
# Categories are written inside square brackets '[cat1, cat2]' and are separated by comma.
# add at least one category name.
categories: [Technologie]
# Tags are written inside square brackets '[tag1, tag2]' and are separated by comma.
# tags are optional, but help to narrow down the subject of the blog post
tags: [Digitalisierung, Banken]
---
## A Post Example
You’ll find this post in the `_posts` directory.
To add new posts, simply add a file in the `_posts` directory that follows the convention `YYYY-MM-DD-name-of-post.markdown` and includes the necessary front matter. Take a look at the source for this post to get an idea about how it works.
Everything in between the first and second --- are part of the YAML Front Matter, and everything after the second --- will be rendered with Markdown and show up as “Content.”
Post files are markdown files. Hence the file extension is *.markdown. The name of the post file must start with the current date (format: YYYY-MM-DD) followed by the title of the blog post. Each word should be separated by a dash '-'.
A valid filename looks like this: 2017-08-10-title-of-the-post.markdown
- On the master branch of this repository, click on the
_postsdirectory to get to the area where the post files are. - click on "Create new file". An Editor will show up where you can write your post.
- In the input field above the editor, provide a file name. You must name your file according to the naming convention mentioned above.
- Copy and paste the Front Matter from the post example above and replace the field values with your data.
- You can also copy/paste the whole post example including the post content.
-
Start writing your post content. Use the markdown syntax (Link to CheatSheet) to format your content.
-
When you are done writing your post and want to publish it, you need to create a pull request.
6.1 Propose new file
To create a pull request, first you must "propose new file". For that, go to the bottom of the page. You will find an area with text fields for proposing a new file. Give a name and a description for the file (Or leave it as is. It will then take the default value as shown.) and click on the button Propose new file.
6.2 Create pull request
Github will then direct you to a site for creating a "Pull Request". If you have not forked this project yet, Github will automatically fork this repository in your Github account and create a branch named like "patch-1" that contains your new file or your file changes.
Then, you can click on the button "Create pull request".
An area with text fields will show up where you can add a message for the pull request. But you can leave the defaults as generated by Github. Click on the Button "Create pull request" to finish the request process.
The admins of the devblog repository will get a message notifying that there are changes that need a review. After they have reviewed and accepted your changes, you can view your post shortly after on adessos blog site https://blog.adesso.de
