Skip to content

Commit ab80762

Browse files
committed
chore: update docs
1 parent b0391dd commit ab80762

5 files changed

+31
-21
lines changed

author/configure-your-profile.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,6 @@ gouravkhunger: # replace gouravkhunger with the username you want
4646

4747
- After your are done, **Remove all the comments** (the `#`s and the text after them)
4848

49-
- Commit your changes make a pull request.
49+
- Commit the changes and make a pull request.
5050

5151
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"}.

author/creating-a-draft.md

+18-13
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Prerequisites:
1818

1919
---
2020

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!
2222

2323
## Create a new file in `_drafts` folder
2424

@@ -43,24 +43,27 @@ In the editor, give your file a name. Let's say you want to create a draft title
4343

4444
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.
4545

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:
4749

4850
```yml
4951
---
5052
layout: post
5153
title: "How to write a draft"
5254
excerpt: "The complete guide you'll need to refer to create mind blowing drafts."
53-
image: "https://cdn.hashnode.com/res/hashnode/image/upload/v1631596605889/xCcnwfFVk.png"
55+
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."
5457
hasCode: true
55-
category: content-writing
56-
tags: ["writing-skills", "tips"]
58+
category: coding
59+
tags: ["blogging", "tips"]
5760
author: gouravkhunger
5861
---
5962
```
6063

6164
**Omit any of the variables if you don't want to use them!**
6265

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`).
6467

6568
- `title` is the title of the post that will be shown in bold at the blog.
6669

@@ -96,29 +99,31 @@ notice: "**Markdown** is supported in this _one_ so you could do [such things](h
9699

97100
After you are done with the frontmatter, you can start writing the content of your post below the `---`.
98101

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.
100103

101104
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.
102105

103106
## ALERT!
104107

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.
106109

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.
108111

109112
## Previewing the draft
110113

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.
114115

115116
Once your PR is successfully merged, the draft will appear to a link similar too this:
116117

117118
```
118119
https://genicsblog.com/draft/how-to-write-a-draft
119120
```
120121

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.
122127

123128
## Next Steps
124129

author/publishing-the-post.md

+7-4
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,9 @@ permalink: /author/publishing-the-post
99

1010
# Publishing the draft post
1111

12-
Once you are assured that your draft is ready, you can publish it. This document provides the steps to do so.
13-
1412
Prerequisites:
1513

14+
- [Create a submission request](/author/create-a-submission-request)
1615
- [Create a draft post](/author/writing-the-article)
1716

1817
---
@@ -23,8 +22,12 @@ Once you think the draft is ready, it's the time to go back to the original [iss
2322

2423
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.
2524

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.
2730

2831
Congrats on getting your post published to the [Genics Blog](https://genicsblog.com){:target="_blank"}!
2932

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!

author/submission-request.md

+2
Original file line numberDiff line numberDiff line change
@@ -42,3 +42,5 @@ In this section, you can share some additional information if you wish to.
4242
---
4343

4444
Once you submit a request, someone from the Genics team would respond if you can start working on the initial draft of the article!
45+
46+
In the meantime, you can get familiar with the [UI components](/author/ui-components) that can be used in the article.

index.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ permalink: /
88

99
# Welcome
1010

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"}.
1212

1313
## Terminology
1414

@@ -18,7 +18,7 @@ Throughout this documentation, you'll find specific words whose meanings are as
1818

1919
- **Blog**: Refers to the [Genics Blog](https://genicsblog.com){:target="_blank"}.
2020

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>/`.
2222

2323
- **Repository**: (unless otherwise specified) The GitHub page at which the [code for the blog](https://github.com/genicsblog/genicsblog.com){:target="_blank"} is hosted.
2424

@@ -36,4 +36,4 @@ Check out these resources:
3636

3737
---
3838

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

Comments
 (0)