mirror of
https://github.com/XRPLF/xrpl-dev-portal.git
synced 2025-11-14 00:35:50 +00:00
Merge pull request #3042 from XRPLF/contribute-blog
Contribution guidelines for blog posts
This commit is contained in:
@@ -74,6 +74,7 @@ topnav.resources.explorer: エクスプローラ
|
|||||||
topnav.resources.known-amendments: 既知のAmendment
|
topnav.resources.known-amendments: 既知のAmendment
|
||||||
topnav.resources.contribute-code: コードへの貢献
|
topnav.resources.contribute-code: コードへの貢献
|
||||||
topnav.resources.contribute-documentation: ドキュメントへの貢献
|
topnav.resources.contribute-documentation: ドキュメントへの貢献
|
||||||
|
topnav.resources.contribute-blog: ブログに投稿する
|
||||||
topnav.community.title: コミュニティ
|
topnav.community.title: コミュニティ
|
||||||
topnav.community.description: 話題に加わろう。
|
topnav.community.description: 話題に加わろう。
|
||||||
topnav.community.get-involved: 参加する
|
topnav.community.get-involved: 参加する
|
||||||
|
|||||||
@@ -4,6 +4,7 @@ ignore:
|
|||||||
- _code-samples/*/README.md
|
- _code-samples/*/README.md
|
||||||
- _code-samples/**/README.md
|
- _code-samples/**/README.md
|
||||||
- _code-samples/create-amm/ts/tsconfig.json
|
- _code-samples/create-amm/ts/tsconfig.json
|
||||||
|
- resources/contribute-blog/_blog-template.md
|
||||||
l10n:
|
l10n:
|
||||||
defaultLocale: en-US
|
defaultLocale: en-US
|
||||||
locales:
|
locales:
|
||||||
|
|||||||
81
resources/contribute-blog/_blog-template.md
Normal file
81
resources/contribute-blog/_blog-template.md
Normal file
@@ -0,0 +1,81 @@
|
|||||||
|
---
|
||||||
|
category: 2025
|
||||||
|
date: 2025-mm-dd
|
||||||
|
seo:
|
||||||
|
title: SEO Optimized Title
|
||||||
|
description: SEO optimized description (recommend < 155 characters) that accurately reflects the page's content.
|
||||||
|
|
||||||
|
labels:
|
||||||
|
- General
|
||||||
|
markdown:
|
||||||
|
editPage:
|
||||||
|
hide: true
|
||||||
|
---
|
||||||
|
# SEO Optimized Title
|
||||||
|
|
||||||
|
|
||||||
|
Congrats on taking the first step toward drafting your blog post! Use this template as a starting point to organize your blog post.
|
||||||
|
|
||||||
|
<!-- BREAK -->
|
||||||
|
|
||||||
|
|
||||||
|
Refer to [Contribute Blog](https://xrpl.org/resources/contribute-blog/) for detailed guidelines and examples.
|
||||||
|
|
||||||
|
NOTE: Blog posts are currently only available in English and are not yet translated.
|
||||||
|
|
||||||
|
## Section: Handy Reference
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
**Title**
|
||||||
|
|
||||||
|
Use title case for the title and headings on the blog post.
|
||||||
|
|
||||||
|
Choose an SEO optimized title for 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.
|
||||||
|
|
||||||
|
**Links**
|
||||||
|
|
||||||
|
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).
|
||||||
|
```
|
||||||
|
|
||||||
|
To include an external link, use the absolute URL instead of a relative path as shown in the following example:
|
||||||
|
|
||||||
|
```
|
||||||
|
[Contribute Documentation](https://xrpl.org/resources/contribute-documentation).
|
||||||
|
```
|
||||||
|
|
||||||
|
**Lists**
|
||||||
|
|
||||||
|
To include an unordered list, use the following syntax:
|
||||||
|
|
||||||
|
- Item 1
|
||||||
|
- Item 2
|
||||||
|
|
||||||
|
To include an ordered list, use the following syntax:
|
||||||
|
|
||||||
|
1. List item 1
|
||||||
|
2. List item 2
|
||||||
|
|
||||||
|
|
||||||
|
### Sub-section: Including Images In Your Blog Post
|
||||||
|
|
||||||
|
To include an image, use the following syntax:
|
||||||
|
|
||||||
|
```
|
||||||
|

|
||||||
|
```
|
||||||
|
|
||||||
|
It is recommended that you store graphics in the `/blog/img` directory.
|
||||||
|
|
||||||
|
For example, `` renders as follows.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
### Sub-section: Embedding Videos In Your Blog Post
|
||||||
|
|
||||||
|
For instructions to embed a video, refer to the [Contribute Documentation](https://xrpl.org/resources/contribute-documentation#videos) topic.
|
||||||
42
resources/contribute-blog/index.md
Normal file
42
resources/contribute-blog/index.md
Normal file
@@ -0,0 +1,42 @@
|
|||||||
|
---
|
||||||
|
html: contribute-blog.html
|
||||||
|
parent: resources.html
|
||||||
|
seo:
|
||||||
|
description: Contribution guide for XRPL Blog.
|
||||||
|
labels:
|
||||||
|
- Blockchain
|
||||||
|
---
|
||||||
|
# Contribute a Blog Post
|
||||||
|
|
||||||
|
Thanks for considering a contribution to the XRP Ledger Dev Blog!
|
||||||
|
|
||||||
|
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).
|
||||||
|
|
||||||
|
{% admonition type="info" name="Note" %}Blog posts are currently only available in English and are not yet translated.{% /admonition %}
|
||||||
|
|
||||||
|
|
||||||
|
## Directory Structure for Blog Posts
|
||||||
|
|
||||||
|
The source files are located in the `blog` directory of the public `xrpl-dev-portal` repository.
|
||||||
|
|
||||||
|
The image files used in blog posts are located in the `blog/img` directory.
|
||||||
|
|
||||||
|
The blog posts are grouped by year, so all blog posts published in year 2025 are located in the `blog/2025` directory.
|
||||||
|
|
||||||
|
## Steps to Create a New Blog Post
|
||||||
|
|
||||||
|
To create a new post, follow these steps:
|
||||||
|
|
||||||
|
1. Before you begin, ensure that you pull the most recent updates from the upstream `master` branch of the `xrpl-dev-portal` repository.
|
||||||
|
|
||||||
|
2. Create a new branch for the blog post using the format `blog-<short-desc-of-update>`.
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
5. Update the `blog/sidebar.yaml` file to include the newly created file.
|
||||||
|
|
||||||
|
6. Once the draft is ready for review, save and commit your updates.
|
||||||
|
|
||||||
|
7. Create a new PR to merge your changes to master.
|
||||||
@@ -734,3 +734,4 @@
|
|||||||
- page: resources/contribute-documentation/creating-diagrams.md
|
- page: resources/contribute-documentation/creating-diagrams.md
|
||||||
- page: resources/contribute-documentation/tutorial-guidelines.md
|
- page: resources/contribute-documentation/tutorial-guidelines.md
|
||||||
- page: resources/contribute-documentation/tutorial-structure.md
|
- page: resources/contribute-documentation/tutorial-structure.md
|
||||||
|
- page: resources/contribute-blog/index.md
|
||||||
@@ -129,6 +129,9 @@
|
|||||||
- label: Contribute Documentation
|
- label: Contribute Documentation
|
||||||
labelTranslationKey: topnav.resources.contribute-documentation
|
labelTranslationKey: topnav.resources.contribute-documentation
|
||||||
href: /resources/contribute-documentation
|
href: /resources/contribute-documentation
|
||||||
|
- label: Contribute Blog
|
||||||
|
labelTranslationKey: topnav.resources.contribute-blog
|
||||||
|
href: /resources/contribute-blog
|
||||||
|
|
||||||
- group: Community
|
- group: Community
|
||||||
groupTranslationKey: navbar.community
|
groupTranslationKey: navbar.community
|
||||||
|
|||||||
Reference in New Issue
Block a user