Skip to content

Commit af0daca

Browse files
committed
Add note about translations
1 parent 31f0591 commit af0daca

File tree

2 files changed

+30
-8
lines changed

2 files changed

+30
-8
lines changed

resources/contribute-blog/_blog-template.md

Lines changed: 26 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ category: 2025
33
date: 2025-mm-dd
44
seo:
55
title: SEO Optimized Title
6-
description: SEO optimized description for the blog post that can be displayed in search results.
6+
description: SEO optimized description (recommend < 155 characters) that accurately reflects the page's content.
77

88
labels:
99
- General
@@ -18,17 +18,34 @@ Congrats on taking the first step toward drafting your blog post! Use this templ
1818

1919
<!-- BREAK -->
2020

21+
2122
Refer to [Contribute Blog](https://xrpl.org/resources/contribute-blog/) for detailed guidelines and examples.
2223

24+
NOTE: Blog posts are currently only available in English and are not yet translated.
25+
2326
## Section: Handy Reference
2427

2528
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.
2629

27-
Choosing an SEO optimized title helps boost your blog post. It is recommended to limit your title to under 50 characters and keep it same as the meta `seo -> title` field for consistency.
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**
2839

29-
To include an internal link, use a relative path. For example, to create a link to the Contributing Documentation topic, use the following syntax: [Contribute Documentation](../resources/contribute-documentation/index.md).
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:
3041

31-
To include an external link, use the absolute URL instead of a relative path. For example, [Contribute Documentation](https://xrpl.org/resources/contribute-documentation).
42+
[Contribute Documentation](../resources/contribute-documentation/index.md).
43+
44+
To include an external link, use the absolute URL instead of a relative path as shown in the following example:
45+
46+
[Contribute Documentation](https://xrpl.org/resources/contribute-documentation).
47+
48+
**Lists**
3249

3350
To include an unordered list, use the following syntax:
3451

@@ -45,11 +62,13 @@ To include an ordered list, use the following syntax:
4562

4663
To include an image, use the following syntax:
4764

48-
Store your graphics in the `/blog/img` directory. Embed graphics using the syntax:
49-
5065
![image_description](/blog/img/my_image.png)
5166

52-
For example, ![XRPL Developer Portal](/blog/img/docs-iav3/xrpl-docs-home.png) renders as follows.
67+
It is recommended that you store graphics in the `/blog/img` directory.
68+
69+
For example, `![XRPL Developer Portal](/blog/img/docs-iav3/xrpl-docs-home.png)` renders as follows.
70+
71+
![XRPL Developer Portal](/blog/img/docs-iav3/xrpl-docs-home.png)
5372

5473
### Sub-section: Embedding Videos In Your Blog Post
5574

resources/contribute-blog/index.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ Thanks for considering a contribution to the XRP Ledger Dev Blog!
1212

1313
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).
1414

15+
{% admonition type="info" name="Note" %}Blog posts are currently only available in English and are not yet translated.{% /admonition %}
16+
17+
1518
## Directory Structure for Blog Posts
1619

1720
The source files are located in the `blog` directory of the public `xrpl-dev-portal` repository.
@@ -36,4 +39,4 @@ To create a new post, follow these steps:
3639

3740
6. Once the draft is ready for review, save and commit your updates.
3841

39-
7. Create a new PR to merge your changes to master.
42+
7. Create a new PR to merge your changes to master.

0 commit comments

Comments
 (0)