Create a News Article
Create a News Article
We are using the blog feature of Docusaurus for the news on cardano.org. It creates a page for each blog post, but also a blog index page, a tag system, an RSS feed.
Guidelines for creating a News Article
All news articles on cardano.org are summaries that link to existing articles. Here's what we seek and will approve for content:
- Engagement Requests: Content should encourage active participation or action from the community.
- Simplify Complex Topics: Explain complex subjects (like finance, regulation, legal issues, governance, infrastructure, operations, resilience, or development) in simple terms. Summarize significant community events such as large meetups, workshops, working group activities, votes, polls, surveys, or governance actions.
- Non-Approved Content: We will not promote content focused on sales, self-promotion, vague or general event announcements, launching new tokens/platforms/apps/services, or unsubstantiated claims about being the best, first, largest, or fastest.
- Summary: Content should primarily benefit the community, not just individuals or companies, and must link back to a detailed blog or news article for more information.
Purpose of the Summary
- The summary of a news article aims to provide readers with a brief overview of the content and encourage them to read the full article.
Content of the Summary
- Keep the summary concise (40-60 words) and informative, highlighting the key points of the article.
- Avoid adding additional information or personal opinions not present in the article.
Use of Links
- Do not include additional links to external sources or resources within the summary. Links within the summary should only direct to internal pages of the website offering relevant content.
Formatting and Structure
- Write the summary in clear, understandable sentences.
- Ensure proper formatting for readability.
Review and Approval
- Before merging the pull request, the summary is reviewed for accuracy, relevance, and compliance with this guideline.
Why this guideline?
This guideline ensures that readers receive a concise and informative preview of the article without being distracted by external sources. Additionally, it helps prevent the attraction of individuals posting articles solely for Search Engine Optimization (SEO) purposes, maintaining the integrity of the platform's content.
Have a relevant news article, meetup recap, or blog post but not the technical know-how to create a pull request yourself? No problem! Just fill out our form, and we will review your suggestion. Please note that we only accept submissions that comply with the guidelines mentioned on this page.
Understanding the author file
Every news article needs an author. You can find the authors file in /blog/authors.yml. An example entry looks like:
builderfest:
name: Buidler Fest
url: https://buidl.2024.cardano.org
image_url: ../img/authors/builderfest.png
Required Frontmatter
Every news article must declare the following fields at the top of its index.md:
| Field | Purpose |
|---|---|
slug | The URL path under /news/. Must be unique across the site. |
title | The headline shown on the article page, in listings, and in social cards. |
description | A 140-160 character meta description used by search engines and social previews (Google snippet, OG card, Twitter card). This is not the same as the in-post summary. |
authors | One or more author handles defined in /blog/authors.yml. |
tags | Topical labels (specific to broad). |