RealRichi3
commented
1 year ago @sandyguide this is the documentation structure i came up with, please review. We'll expand on some of the steps, this isn't the final work, just a guide.
-
Links to docs, and installation guide for Quarto
-
Fork repo
-
Create own branch
-
Clone the repository to your local machine
-
Choose your editing tool, it can be VS code, RStudio or any text editor, but preferrably VS Code
-
Navigate to /posts directory, this is the directory that contains all posts --( Add image showing new blog posts)
-
Create a new folder, the folder title should match the title of the blog post
-
Navigate to the new folder
-
Create an index.qmd file
-
If you want to add images make sure they are in the same folder as the index.qmd file, then reference them properly
-
In the index.qmd file you can start with the YAML structure, this gives shows the major details of the blog posts.
--- title: "My first blog postpost" description: "Post description" author: "Richie Goodnews" date: "07/12/2022" categories: - news - code - analysis ---title - The title of the post author - Author of the post date - The date of the post categories - The enabled categories, could be Outreachy, technology or anything that fits best There are different ways to add categories
categories: Outreachy
categories:
- Outreachy
- Introduction
- First postcategories: [Outreachy, Introduction, Firstpost]
-
if you don't want the post to be listed on the site yet, you can set the draft field to true
--- title: "Welcome To My Blog" author: "Richie Goodnews" date: "2022-12-07" categories: [Outreachy] draft: true --- -
After the YAML you can write your post
-
After writing your post, in the current dir run
quarto preview index.mdto preview your new post -
After writing the blog post you can commit the changes and push, and submit a PR for it.
-
You don't need to bother about deployment, it'll be handled by the netlify plugin if your PR is merged.
sandygudie
Description
Add documentation on how to add blog posts to the OSCSA Blog
This is meant to help newcomers to create a post in the OSCSA https://oscsa-en-blog.netlify.app/. It assumes that they have written a draft and would like to add it to the website. Please make it as easy as possible to newcomers who have limited knowledge in Open source or Quarto or even programming.