You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: author/configure-your-profile.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -46,6 +46,6 @@ gouravkhunger: # replace gouravkhunger with the username you want
46
46
47
47
- After your are done, **Remove all the comments** (the `#`s and the text after them)
48
48
49
-
- Commit your changes make a pull request.
49
+
- Commit the changes and make a pull request.
50
50
51
51
We'll merge your PR as soon as possible and your profile would be visible after about 10 minutes past the merge time, at `https://genicsblog.com/author/<your-username>/`: [example](https://genicsblog.com/author/gouravkhunger/){:target="_blank"}.
Copy file name to clipboardExpand all lines: author/creating-a-draft.md
+18-13
Original file line number
Diff line number
Diff line change
@@ -18,7 +18,7 @@ Prerequisites:
18
18
19
19
---
20
20
21
-
The content at genicsblog.com is written in [Markdown](https://en.wikipedia.org/wiki/Markdown){:target="_blank"}. This means that you can write your content in plain text and it will be rendered HTML automatically. Let's create a draft post in markdown!
21
+
The content at genicsblog.com is written in [Markdown](https://en.wikipedia.org/wiki/Markdown){:target="_blank"}. This means that you can write your content in plain text and it will be rendered to HTML automatically. Let's create a draft post in markdown!
22
22
23
23
## Create a new file in `_drafts` folder
24
24
@@ -43,24 +43,27 @@ In the editor, give your file a name. Let's say you want to create a draft title
43
43
44
44
Genics Blog requires each post/draft to have a frontmatter that defines the title, description, and other metadata. This is declared at the very top of the file within `---` quotations.
45
45
46
-
Here's an example of a minimal valid frontmatter that Genics Blog understands:
46
+
**Note**: To ease the process explained below, you can use the [frontmatter generator](https://genicsblog.com/tool/frontmatter-generator) tool and copy the generated content to the top of your file.
47
+
48
+
To manually generate frontmatter, here's an example of a minimal valid frontmatter that Genics Blog understands:
47
49
48
50
```yml
49
51
---
50
52
layout: post
51
53
title: "How to write a draft"
52
54
excerpt: "The complete guide you'll need to refer to create mind blowing drafts."
description: "This is shown to the search engines. If undefined, excerpt is used as the description."
56
+
image: "A url of the hosted image. Paste the image to a comment box on GitHub issues to generate a link quickly."
54
57
hasCode: true
55
-
category: content-writing
56
-
tags: ["writing-skills", "tips"]
58
+
category: coding
59
+
tags: ["blogging", "tips"]
57
60
author: gouravkhunger
58
61
---
59
62
```
60
63
61
64
**Omit any of the variables if you don't want to use them!**
62
65
63
-
-`layout` defines what kind of page it will be (here, a`post`).
66
+
-`layout` defines what kind of page it will be (for articles, always keep it`post`).
64
67
65
68
-`title` is the title of the post that will be shown in bold at the blog.
66
69
@@ -96,29 +99,31 @@ notice: "**Markdown** is supported in this _one_ so you could do [such things](h
96
99
97
100
After you are done with the frontmatter, you can start writing the content of your post below the `---`.
98
101
99
-
Check out the [UI Components guide](/author/ui-components) to learn how to add various elements to your post.
102
+
Please read the [UI Components guide](/author/ui-components) to learn how to add various elements to your post.
100
103
101
104
Also take a look at [other drafts](https://github.com/genicsblog/genicsblog.com/tree/main/_drafts){:target="_blank"} or [published posts](https://github.com/genicsblog/genicsblog.com/tree/main/_posts){:target="_blank"} to take a look at how the content is written.
102
105
103
106
## ALERT!
104
107
105
-
Please **DO NOT** edit any file outside the drafts folder while you are writing your draft, and **DO NOT** change with other author's drafts. This will cause the Pull request checks to fail and your draft won't be automatically published.
108
+
Please **DO NOT** edit any file outside the drafts folder while you are writing your draft, and **DO NOT** change with other author's drafts. This will cause the Pull request checks to fail and delay the review process because of the needed investigation.
106
109
107
-
Repeated attempts to bypass/hack the check system will result in a permanent ban from the site, the discord community and will result in deletion of your profile.
110
+
Repeated attempts to bypass/hack the CI system will result in a permanent ban from the site, the discord community and will result in deletion of your profile.
108
111
109
112
## Previewing the draft
110
113
111
-
At this point, you'll want to preview how the draft would look like on the site. To do so, commit your finalised changes and make a Pull Request to immediately publish the draft article to the blog. The draft will be published to a private page that is not indexed by search engines.
112
-
113
-
**A draft is accessible only if someone has its link**. This feature is for the authors to preview their posts before they are published and to share with only those whom they want to.
114
+
At this point, you'll want to preview how the draft would look like on the site.
114
115
115
116
Once your PR is successfully merged, the draft will appear to a link similar too this:
116
117
117
118
```
118
119
https://genicsblog.com/draft/how-to-write-a-draft
119
120
```
120
121
121
-
The slug is defined by the name of the file you made. You can preview your changes here, and if needed create new pull requests to publish your changes.
122
+
Replace `how-to-write-a-draft` with the sluggified name of your file.
123
+
124
+
**A draft is accessible only if someone has its link**. This feature is for the authors to preview their posts before they are published and to share with only those whom they want to.
125
+
126
+
The slug is defined by the name of the file you made. You can preview your changes here, and if needed create new pull requests to change the content of your draft.
Once you are assured that your draft is ready, you can publish it. This document provides the steps to do so.
13
-
14
12
Prerequisites:
15
13
14
+
-[Create a submission request](/author/create-a-submission-request)
16
15
-[Create a draft post](/author/writing-the-article)
17
16
18
17
---
@@ -23,8 +22,12 @@ Once you think the draft is ready, it's the time to go back to the original [iss
23
22
24
23
We'll go through the draft and make basic edits on grammar, styling, formatting and some SEO related things. Smaller changes will be made without your approval but if we need any clarification, we'll get back to you in the same issue thread.
25
24
26
-
Once your draft has gone through the review process, the draft file will be moved to the `_posts` folder which will get it published to the blog!
25
+
## Publishing process
26
+
27
+
Once your draft has gone through the review process, the draft file will be moved to the `_posts` folder under your username which will get it published to the blog! This step is done by our team.
28
+
29
+
We'll notify you on the same issue thread and mark it closed once the article is live on the site.
27
30
28
31
Congrats on getting your post published to the [Genics Blog](https://genicsblog.com){:target="_blank"}!
29
32
30
-
It is now live and you can share it with the world. People could add comments to the post to which you can add replies. Remember to use your full name to in the **Name** field to get identified as the author of the post in the comments section.
33
+
It is now live and you can share it with the world. We will [tweet](https://twitter.com/genicsblog) about your article within a week!
Copy file name to clipboardExpand all lines: index.md
+3-3
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ permalink: /
8
8
9
9
# Welcome
10
10
11
-
Welcome to the Genics Blog documentation! This documentation is the ultimate guide you need to refer to for publishing content at the [Genics Blog](https://genicsblog.com){:target="_blank"}.
11
+
Welcome to the Genics Blog documentation! This documentation is the ultimate guide you need to refer to become a contributor at the [Genics Blog](https://genicsblog.com){:target="_blank"}.
12
12
13
13
## Terminology
14
14
@@ -18,7 +18,7 @@ Throughout this documentation, you'll find specific words whose meanings are as
18
18
19
19
-**Blog**: Refers to the [Genics Blog](https://genicsblog.com){:target="_blank"}.
20
20
21
-
-**Author**: A person who contributes content to the blog. Each author gets their own unique page at `https://genicsblog.com/author/<username>`.
21
+
-**Author**: A person who contributes content to the blog. Each author gets their own unique page at `https://genicsblog.com/author/<username>/`.
22
22
23
23
-**Repository**: (unless otherwise specified) The GitHub page at which the [code for the blog](https://github.com/genicsblog/genicsblog.com){:target="_blank"} is hosted.
24
24
@@ -36,4 +36,4 @@ Check out these resources:
36
36
37
37
---
38
38
39
-
A list of open tasks can be found at the [Contribute page](https://genicsblog.com/contribute){:target="_blank"}. All kind of contributributions are heartily welcome!
39
+
A list of open tasks can be found at the [Contribute page](https://genicsblog.com/contribute){:target="_blank"}. All kind of contributions are heartily welcome!
0 commit comments