Skip to content

Commit cdf798f

Browse files
sanjay-kvsanjay-kv
committed
added the step 6 and 7 for blogs
1 parent b9b3d74 commit cdf798f

3 files changed

Lines changed: 69 additions & 20 deletions

File tree

‎docs/assets/blog-05-new-issue.png‎

66.6 KB
Loading

‎docs/assets/blog-06-new-issue.png‎

122 KB
Loading

‎docs/getting_started.md‎

Lines changed: 69 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -59,41 +59,64 @@ Head to the the GitHub issue on this [repository](https://github.com/recodehive/
5959
#### Just follow the steps on forking the repositories and installing the dependencies on your local repository, if you dont know refer the steps 2 to 6 on [welcome page](https://www.recodehive.com/docs/).
6060
---
6161

62-
## Step 3: Create a New Branch
62+
## Step 5: Create a New Branch
63+
64+
Open your code editor and head into terminal and check current branch
65+
Never commit directly to `main`. Create a dedicated branch for your blog post:
6366

64-
Never commit directly to `main`. Create a dedicated branch for your blog post: test
6567

6668
```bash
6769
git checkout -b blog/your-blog-title
6870
```
6971

70-
Use a short, descriptive name — for example `blog/intro-to-docker` or `blog/react-hooks-guide`.
72+
<BrowserWindow url="https://github.com/recodehive/recode-website/issues" bodyStyle={{padding: 0}}>
73+
[![Github](assets/blog-05-new-issue.png)](https://github.com/recodehive/recode-website/issues)
74+
</BrowserWindow>
75+
76+
:::info
77+
the best practice, Use a short, descriptive name for example `blog/intro-to-docker` or `blog/react-hooks-guide`.
78+
:::
79+
7180

7281
---
7382

74-
:::tip Blog Quality Checklist
75-
Before starting any development, make sure your blog meets **all** of the following criteria. Your blog can be **rejected** if any requirement is not fulfilled:
83+
## Step 6: Add your name to Author list : optional
84+
:::info
85+
If you are first time contributing to blog section, add yourself as author, this gives you good visibility on Google search and better career opportunities.
86+
:::
87+
Open your code editor and head into sidebar and expand the `blog` folder
88+
and open the file `authors.yml`. Refer the below image and copy paste the code into the yml as shown.
89+
Replace my name with your name and respective website links of yours.
7690

77-
- 1. 5 backlinks to different external websites to support our documentation.
78-
- 2. 5 internal backlinks to other articles on recodehive.
91+
```bash
92+
sanjay-kv:
93+
name: Sanjay Viswanthan
94+
title: Founder at recode hive
95+
url: www.sanjaykv.com
96+
image_url: https://avatars.githubusercontent.com/u/30715153?v=4
97+
email: sanjay@recodehive.com
98+
page: true # Turns the feature on
99+
description: >
100+
I'm a Software Engineer turned into a Data Engineer and Program Manager🚀, 🏆 Google ML Facilitator & Ex- GitHub CE who delivered 100+ talks on ML and open source and developer advocacy at various events and platforms.
79101
80-
- 3. **No generic content** — avoid surface-level topics like "what is Azure" or "difference between X and Y". Write pure, high-depth technical articles with images. See [this example](https://www.recodehive.com/docs/GitHub/Maintainer-guide/milestone) for the standard we aim for. (Tip: tools like [Snagit](https://www.techsmith.com/screen-capture.html) help produce great annotated screenshots.)
102+
socials:
103+
x: https://x.com/sanjay_kv_
104+
linkedin: sanjay-k-v
105+
github: sanjay-kv
106+
stackoverflow: 8332327
107+
instagram: nomad_brains
108+
newsletter: https://recodehive.substack.com
109+
bluesky: sanjaykv.bsky.social
110+
```
81111
82-
- 4. Image filenames must be descriptive and SEO-friendly — no random names like `screenshot123.png`.
83-
- 5. **Content-to-code ratio**: text should be more than code. Adsense flags pages at 60% code / 40% text - keep it the opposite. If code is long, link to GitHub and reference it in comments instead.
112+
<BrowserWindow url="vs-code-terminal" bodyStyle={{padding: 0}}>
113+
[![Github](assets/blog-06-new-issue.png)](vs-code-terminal)
114+
</BrowserWindow>
84115
85-
- 6. Include a **bulleted summary section** at the top of the blog post.
86-
- 7. Include a **FAQ section** at the bottom.
87-
- 8. Use Docusaurus admonitions (`:::tip`, `:::info`, `:::note`) for callouts, tips, and cautions (see formatting guidelines below).
88-
- 9. Tables must be **center-aligned** - wrap them in an `:::info` block to achieve this in Docusaurus.
89-
- 10. Use **named code blocks** with a filename label when showing code (e.g., ` ```java title="Sample.java" `).
90-
- 11. When showing a query and its output together, use a **Tabs** block with separate "Query" and "Output" tabs.
91-
- 12. Screenshots must follow the naming convention and size guidelines below.
92-
:::
93116
94117
---
95118
96-
## Step 4: Create the Blog Folder and File
119+
## Step 7: Create the Blog Folder and File
97120
98121
All blog posts live inside the `blog/` directory. Each post gets its own folder.
99122
@@ -103,7 +126,7 @@ All blog posts live inside the `blog/` directory. Each post gets its own folder.
103126
blog/
104127
└── your-blog-title/
105128
├── index.md ← your blog content
106-
└── images/ ← screenshots and images (optional)
129+
└── assets/ ← screenshots and images (optional png or jpeg)
107130
├── cover.png
108131
└── step-01.png
109132
```
@@ -117,6 +140,32 @@ touch blog/your-blog-title/index.md
117140
118141
---
119142
143+
144+
145+
146+
147+
:::tip Blog Quality Checklist
148+
Before starting any development, make sure your blog meets **all** of the following criteria. Your blog can be **rejected** if any requirement is not fulfilled:
149+
150+
- 1. 5 backlinks to different external websites to support our documentation.
151+
- 2. 5 internal backlinks to other articles on recodehive.
152+
153+
- 3. **No generic content** — avoid surface-level topics like "what is Azure" or "difference between X and Y". Write pure, high-depth technical articles with images. See [this example](https://www.recodehive.com/docs/GitHub/Maintainer-guide/milestone) for the standard we aim for. (Tip: tools like [Snagit](https://www.techsmith.com/screen-capture.html) help produce great annotated screenshots.)
154+
155+
- 4. Image filenames must be descriptive and SEO-friendly — no random names like `screenshot123.png`.
156+
- 5. **Content-to-code ratio**: text should be more than code. Adsense flags pages at 60% code / 40% text - keep it the opposite. If code is long, link to GitHub and reference it in comments instead.
157+
158+
- 6. Include a **bulleted summary section** at the top of the blog post.
159+
- 7. Include a **FAQ section** at the bottom.
160+
- 8. Use Docusaurus admonitions (`:::tip`, `:::info`, `:::note`) for callouts, tips, and cautions (see formatting guidelines below).
161+
- 9. Tables must be **center-aligned** - wrap them in an `:::info` block to achieve this in Docusaurus.
162+
- 10. Use **named code blocks** with a filename label when showing code (e.g., ` ```java title="Sample.java" `).
163+
- 11. When showing a query and its output together, use a **Tabs** block with separate "Query" and "Output" tabs.
164+
- 12. Screenshots must follow the naming convention and size guidelines below.
165+
:::
166+
167+
168+
120169
## Step 5: Write the Frontmatter
121170
122171
Open `blog/your-blog-title/index.md` and add the following frontmatter at the very top of the file:

0 commit comments

Comments
 (0)