alan-turing-institute / TuringDataStories

TuringDataStories: An open community creating “Data Stories”: A mix of open data, code, narrative 💬, visuals 📊📈 and knowledge 🧠 to help understand the world around us.
Other
39 stars 12 forks source link

Add citations and style guide on story writing? #203

Open AoifeHughes opened 2 years ago

AoifeHughes commented 2 years ago

Summary

Suggestions for citations and style guide on story writing

  1. Can the current system support bibtex-style citations
  2. There is some instruction found here for writing a story, but perhaps it would be useful to supply a simple template?
    • It's also possible this exists already, and I've overlooked it
    • Something simple like
      1. Intro
      2. Data / Code setup
      3. Finding 1
      4. Finding 2
      5. Conclusion
      6. Discussion
    • This might seem obvious, but making it clear could help encourage wider participation?

What needs to be done?


Updates

AoifeHughes commented 2 years ago

Possibly through a plugin for fastpages?

AoifeHughes commented 2 years ago

Q: Who runs the fastpages implementation. Is there a straight-forward way we can test https://drscotthawley.github.io/blog/2020/07/01/Citations-Via-Bibtex.html ?

crangelsmith commented 2 years ago

Hey @AoifeHughes, here is a template we had as an example: https://github.com/alan-turing-institute/TuringDataStories/blob/master/stories/TDS-template.ipynb

I think it is not really referenced in the readme (and it should!) and can also be more detailed. Feel free to modify it!