Skip to content

Latest commit

 

History

History
47 lines (31 loc) · 1.36 KB

README.md

File metadata and controls

47 lines (31 loc) · 1.36 KB

tandy-blog

Data blog for Tandy Center for Ocean Forecasting

General guidelines

Follow this general guide New posts should follow this guide which explains about making sub-directories in the post/ directory.

Post naming

Please use the YYYY-mm-dd_my_post_name format.

To code or not to code?

To keep things light weight please do not include code in your index.qmd unless it is pseudo-code. If you want to have some code that will generate output to be inlcuded in you post, then please make a separate un-rendered file (like script.R or script.py).

An example post directory

<tandy-blog>/
  posts/
    2024-09-30_my_cool_post/
      index.qmd   
      script.R
      some_small_data.csv.gz
      some_image.png
      another_image.png

Categories

Let's be judicious in our use of categories (tags really) to facilitate searching by keywords. Let's start with these - add them to your post's index.qmd YAML header as you see fit.

categories:
  - news
  - code
  - analysis
  - data
  - packages

Programming examples vs tutorials

Tutorials probably belong elsewhere - like here - but brief examples are good for here.