Skip to content

Commit 571ec8f

Browse files
authored
feat: added a guide for new blog posts (#108)
* feat: added a README guide for new blog posts
1 parent 2e6d3e9 commit 571ec8f

File tree

1 file changed

+59
-0
lines changed

1 file changed

+59
-0
lines changed

README.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,3 +59,62 @@ You can substitute the `bun` commands with whatever package manager of your choi
5959
### 👀 Want to learn more?
6060

6161
Check out [Starlight’s docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [Astro Discord server](https://astro.build/chat).
62+
63+
Thank You for Contributing! We appreciate your effort to write a blog post and share your expertise with the community!
64+
65+
## Writing a blog post
66+
67+
**Goal:** Educate, drive adoption, and grow strategic influence.
68+
69+
**Typical Target Audience:**
70+
71+
* Technically-inclined users interested in Interledger development.
72+
* Technically-inclined users interested in financial services technologies, innovations, or developments.
73+
* Users keen on topics like APIs, data analytics, metrics, analysis, and quantitative assessment for digital networks.
74+
* Users interested in privacy and related technologies.
75+
76+
**Possible Content Framework:**
77+
78+
If you're unsure how to structure your writing, you can use this as a guide.
79+
80+
* Introduction / main point
81+
* Context - Interledger’s perspective / stance / commitment on the topic being written [broader categories like privacy, metrics for growth, Digital Financial Inclusion etc.]
82+
* The Challenge (or) The Problem
83+
* The Solution
84+
* The How / implementation
85+
* Roadmap - short-term / long-term
86+
* Note: A call to action (CTA) will be included automatically at the bottom of every post.
87+
88+
Ideal Word Count: Between 1,000 and 2,500 words, with links to relevant documents/pages for a deeper understanding.
89+
90+
### Getting Started
91+
92+
Discuss Ideas: Before starting, share your blog post ideas with the tech team to ensure alignment and awareness.
93+
94+
Copy the Template: Begin your draft using [this Google Doc template](https://docs.google.com/document/d/1L7vzsYORg9xmf72ljTdmyekpq2vJ7eQZ9atM2uAXgUM/edit?usp=sharing) to maintain a consistent format.
95+
96+
Review Process##
97+
98+
Initial Reviews:
99+
100+
* Once your draft is ready, request specific reviewers or ask for feedback on the #tech-team Slack channel.
101+
* Incorporate feedback and refine the blog post.
102+
103+
Finalizing:
104+
105+
* When the draft is stable, create a pull request in the [interledger.org-developers](https://github.com/interledger/interledger.org-developers) GitHub repo.
106+
* Please add links where appropriate so people can easily click to learn more about the concepts you reference.
107+
* Include all images used in the post in the PR.
108+
* No-one is expected to know the ins and outs of Astro (the framework that powers our site), so please tag Sarah as a reviewer to ensure everything Astro-related is in order.
109+
110+
### Working with Visuals
111+
112+
* If you need an illustration, submit a design request in advance to Madalina via the #design Slack channel using the design request form.
113+
* Before uploading images to GitHub, run them through an image optimizer such as [TinyPNG](https://tinypng.com/).
114+
* Ensure images are appropriately sized; feel free to ask Madalina or Sarah for assistance.
115+
116+
### Publishing Your Blog Post
117+
118+
* Remember: merging the pull request will publish the blog post immediately.
119+
* Ensure the publishing date in the blog post metadata matches the intended release date.
120+
* Check with Ioana to confirm the publishing date and keep a consistent posting schedule. Ioana will also handle social media promotion.

0 commit comments

Comments
 (0)