Writing in the OpenCraft Blog¶
Members of the OpenCraft team publish blog posts on our website. Such blog posts provide news about OpenCraft, updates about the Open edX platform, technical tutorials, and other news. If you have an idea and would like to prepare and publish a blog post, you are welcome to!
Who at OpenCraft is responsible for maintaining the blog?¶
Contact him if you have any questions!
Blog Publishing Process¶
The following is the procedure to publish an article on the OpenCraft Blog.
Share your idea¶
Have an idea for a blog post? Create a public thread on the OpenCraft Discussion Forum, draft a small brief for your blog post, and ping the Marketing Specialist. There is no formal approval process, but team members might request that you refine your idea.
Create a ticket¶
- Create a ticket to prepare the blog post. The epic should be OC-5152, and the Account should be Marketing.
- Find a reviewer
- Assign the Marketing Specialist as 2nd reviewer
The budget for the ticket should be 10h. The budget is distributed as follows:
- 6h for preparing the blog post (assignee)
- 3h for the review process and proofreading (reviewers)
- 1h for publishing (Marketing Specialist)
Write a draft¶
Write a draft in a Google Doc. Make sure the doc is in the following folder, and set permissions so that any member of OpenCraft can edit the doc.
Once ready for review, ping your reviewers.
Once the draft has been reviewed and the comments addressed, it's time to have your copy proofead. Follow the steps from proofreading procedure in the Handbook to have your copy proofread.
It's now time to create the blog post in Wordpress.
- Log into https://opencraft.com/login (if you don't have an account, ask the Marketing Specialist to create one for you)
- Go to Posts -> Add New
- Add a title
- Start the post with This article was written by team member [name] (github link) -> example
- Paste your copy. Headings will be used to generate a table of contents -> example
- In the right-hand vertical menu:
- Pick a Category
- Add relevant Tags
- Set a Featured Image. This image will be used as the cover image for your article. Make sure you have permission to use the image (Unsplash) is great for this)
- Attribute credits for the image at the end of your post
- Save draft and ping the Marketing Specialist on your Jira ticket when ready.
Do not publish the post! The Marketing Specialist will do it, as per the schedule.
SEO process (optional but recommended)¶
Our blogging platform in Wordpress uses a Search Engine Optimization (SEO) tool called Yoast to review your copy and suggest changes that will increase the searchability and placement of your article on search engines.
Once your copy is in Wordpress, the Yoast tool will automatically review the copy and suggest SEO improvements. The suggestions can be found in the post creation tool, in the right-hand vertical menu, under "SEO Analysis".
We encourage you to take the suggestions into accounts, and do the necessary changes to your text to improve SEO readability. You can ping your reviewers for one last quick review after this, if necessary.