Skip to content

Commit fe1e0f4

Browse files
amarantha-kamarantha-k
authored
Merge pull request #3042 from XRPLF/contribute-blog
Contribution guidelines for blog posts
2 parents e5f5509 + 7463ae6 commit fe1e0f4

File tree

6 files changed

+129
-0
lines changed

6 files changed

+129
-0
lines changed

‎@l10n/ja/translations.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,7 @@ topnav.resources.explorer: エクスプローラ
7474
topnav.resources.known-amendments: 既知のAmendment
7575
topnav.resources.contribute-code: コードへの貢献
7676
topnav.resources.contribute-documentation: ドキュメントへの貢献
77+
topnav.resources.contribute-blog: ブログに投稿する
7778
topnav.community.title: コミュニティ
7879
topnav.community.description: 話題に加わろう。
7980
topnav.community.get-involved: 参加する

‎redocly.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ ignore:
44
- _code-samples/*/README.md
55
- _code-samples/**/README.md
66
- _code-samples/create-amm/ts/tsconfig.json
7+
- resources/contribute-blog/_blog-template.md
78
l10n:
89
defaultLocale: en-US
910
locales:

‎resources/contribute-blog/_blog-template.md

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
---
2+
category: 2025
3+
date: 2025-mm-dd
4+
seo:
5+
title: SEO Optimized Title
6+
description: SEO optimized description (recommend < 155 characters) that accurately reflects the page's content.
7+
8+
labels:
9+
- General
10+
markdown:
11+
editPage:
12+
hide: true
13+
---
14+
# SEO Optimized Title
15+
16+
17+
Congrats on taking the first step toward drafting your blog post! Use this template as a starting point to organize your blog post.
18+
19+
<!-- BREAK -->
20+
21+
22+
Refer to [Contribute Blog](https://xrpl.org/resources/contribute-blog/) for detailed guidelines and examples.
23+
24+
NOTE: Blog posts are currently only available in English and are not yet translated.
25+
26+
## Section: Handy Reference
27+
28+
To help you get started quickly, here’s a handy guide to the syntax for some of the most frequently used components in a blog post — perfect for streamlining your writing process.
29+
30+
**Title**
31+
32+
Use title case for the title and headings on the blog post.
33+
34+
Choose an SEO optimized title for your blog post.
35+
36+
It is recommended to limit your title to under 50 characters and keep it same as the meta `seo -> title` field for consistency.
37+
38+
**Links**
39+
40+
To include an internal link, use a relative path. For example, to create a link to the Contributing Documentation topic, use the following syntax:
41+
42+
```
43+
[Contribute Documentation](../resources/contribute-documentation/index.md).
44+
```
45+
46+
To include an external link, use the absolute URL instead of a relative path as shown in the following example:
47+
48+
```
49+
[Contribute Documentation](https://xrpl.org/resources/contribute-documentation).
50+
```
51+
52+
**Lists**
53+
54+
To include an unordered list, use the following syntax:
55+
56+
- Item 1
57+
- Item 2
58+
59+
To include an ordered list, use the following syntax:
60+
61+
1. List item 1
62+
2. List item 2
63+
64+
65+
### Sub-section: Including Images In Your Blog Post
66+
67+
To include an image, use the following syntax:
68+
69+
```
70+
![image_description](/blog/img/my_image.png)
71+
```
72+
73+
It is recommended that you store graphics in the `/blog/img` directory.
74+
75+
For example, `![XRPL Developer Portal](/blog/img/docs-iav3/xrpl-docs-home.png)` renders as follows.
76+
77+
![XRPL Developer Portal](/blog/img/docs-iav3/xrpl-docs-home.png)
78+
79+
### Sub-section: Embedding Videos In Your Blog Post
80+
81+
For instructions to embed a video, refer to the [Contribute Documentation](https://xrpl.org/resources/contribute-documentation#videos) topic.

‎resources/contribute-blog/index.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
html: contribute-blog.html
3+
parent: resources.html
4+
seo:
5+
description: Contribution guide for XRPL Blog.
6+
labels:
7+
- Blockchain
8+
---
9+
# Contribute a Blog Post
10+
11+
Thanks for considering a contribution to the XRP Ledger Dev Blog!
12+
13+
This page includes high-level instructions to create a new blog post. Detailed instructions and guidelines to contribute to the XRPL Developer Portal are available in [Contribute Documentation](../contribute-documentation/index.md).
14+
15+
{% admonition type="info" name="Note" %}Blog posts are currently only available in English and are not yet translated.{% /admonition %}
16+
17+
18+
## Directory Structure for Blog Posts
19+
20+
The source files are located in the `blog` directory of the public `xrpl-dev-portal` repository.
21+
22+
The image files used in blog posts are located in the `blog/img` directory.
23+
24+
The blog posts are grouped by year, so all blog posts published in year 2025 are located in the `blog/2025` directory.
25+
26+
## Steps to Create a New Blog Post
27+
28+
To create a new post, follow these steps:
29+
30+
1. Before you begin, ensure that you pull the most recent updates from the upstream `master` branch of the `xrpl-dev-portal` repository.
31+
32+
2. Create a new branch for the blog post using the format `blog-<short-desc-of-update>`.
33+
34+
3. Create a new markdown file in the `blog/_current_year_` folder, for example https://github.com/XRPLF/xrpl-dev-portal/tree/master/blog/2025
35+
36+
4. Refer to the template file [`_blog_template.md`](https://github.com/XRPLF/xrpl-dev-portal/tree/master/resources/contribute-blog/_blog-template.md) to compose your draft blog.
37+
38+
5. Update the `blog/sidebar.yaml` file to include the newly created file.
39+
40+
6. Once the draft is ready for review, save and commit your updates.
41+
42+
7. Create a new PR to merge your changes to master.

‎sidebars.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -734,3 +734,4 @@
734734
- page: resources/contribute-documentation/creating-diagrams.md
735735
- page: resources/contribute-documentation/tutorial-guidelines.md
736736
- page: resources/contribute-documentation/tutorial-structure.md
737+
- page: resources/contribute-blog/index.md

‎top-nav.yaml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,9 @@
129129
- label: Contribute Documentation
130130
labelTranslationKey: topnav.resources.contribute-documentation
131131
href: /resources/contribute-documentation
132+
- label: Contribute Blog
133+
labelTranslationKey: topnav.resources.contribute-blog
134+
href: /resources/contribute-blog
132135

133136
- group: Community
134137
groupTranslationKey: navbar.community

0 commit comments

Comments
 (0)