-
Notifications
You must be signed in to change notification settings - Fork 63
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add blog guide for posting to our community resources
- Loading branch information
Showing
2 changed files
with
106 additions
and
0 deletions.
There are no files selected for viewing
98 changes: 98 additions & 0 deletions
98
docs/contributing/opensauced-writers-guide/how-to-add-your-post.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,98 @@ | ||
--- | ||
id: writers-guide | ||
title: "OpenSauced Writers Guide" | ||
sidebar_label: "OpenSauced Writers Guide" | ||
keywords: | ||
- "writers guide" | ||
- "open source writers guide" | ||
- "open source writer" | ||
--- | ||
|
||
Welcome to our Writers Contributor Guide. This will walk you through the steps of how to add your blog post to our community resources using the docs repository. | ||
|
||
## Repeat Authors: Adding to `authors.yml` | ||
|
||
For regular blog post authors, we should declare those authors globally in the configuration file: | ||
|
||
**Location:** `/blog/authors.yml` | ||
|
||
**Example:** | ||
```yaml | ||
BekahHW: | ||
name: Bekah Hawrot Weigel | ||
title: Developer Experience Lead | ||
url: https://twitter.com/BekahHW | ||
image_url: https://github.com/BekahHW.png | ||
email: [email protected] | ||
twitter: BekahHW | ||
|
||
nickytonline: | ||
name: Nick Taylor | ||
title: AI Engingeer | ||
url: https://www.nickyt.co/ | ||
image_url: https://github.com/nickytonline.png | ||
``` | ||
## Adding Blog Posts | ||
To publish in the blog, create a Markdown file within the blog directory. Note that we have subdirectories for each year, so writers should add their post to the folder that corresponds with the year. | ||
**Example Path:** `/blog/2024/06-03-welcome-opensauced.md` | ||
|
||
|
||
:::info | ||
|
||
You'll notice that many of the files include the year. These were created before we started using the year subdirectories. Either way works, but we're moving towards the year subdirectories for organization and omitting the year in the file name. | ||
|
||
::: | ||
|
||
**Markdown Example:** | ||
```markdown | ||
docs/blog/2024/06-03-welcome-opensauced.md | ||
--- | ||
title: Welcome to OpenSauced | ||
description: This is my first post on OpenSauced. | ||
slug: welcome-opensauced | ||
authors: BekahHW | ||
tags: [hello, opensauced] | ||
hide_table_of_contents: false | ||
--- | ||
Welcome to this blog. This blog is created with [**OpenSauced**](https://opensauced.pizza). | ||
<!-- truncate --> | ||
This is my first post on OpenSauced. | ||
A whole bunch of exploration to follow. | ||
``` | ||
|
||
The front matter is useful to add more metadata to your blog post, for example, author information, but OpenSauced will be able to infer all necessary metadata without the front matter. For all possible fields, see the API documentation. | ||
|
||
### Blog List | ||
|
||
The blog's index page (a custom path for OpenSauced at `/community-resources`) is the blog list page, where all blog posts are collectively displayed. | ||
|
||
Use the `<!--truncate-->` marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. Anything above `<!--truncate-->` will be part of the summary. Note that the portion above the truncate marker must be standalone renderable Markdown. For example: | ||
|
||
**Example Path:** `website/blog/my-post.md` | ||
|
||
**Markdown Example:** | ||
```markdown | ||
website/blog/my-post.md | ||
--- | ||
title: Markdown blog truncation example | ||
--- | ||
All these will be part of the blog post summary. | ||
<!-- truncate --> | ||
But anything from here on down will not be. | ||
``` | ||
|
||
### Image Usage | ||
|
||
We are not going to use images in the front matter. The rest of the post should be in markdown format. | ||
|
||
By following these guidelines, you will ensure consistency and ease of maintenance across our blog posts. Happy writing! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters