The-turing-way: Reorganise chapters into subsections

Created on 16 May 2019  ·  19Comments  ·  Source: alan-turing-institute/the-turing-way

Summary

Currently, most of the chapters are one long page. We would like each chapter to be restructured into subsections like the chapter on Reproducibility which was done in this pull request:
https://github.com/alan-turing-institute/the-turing-way-book/pull/12

(*Note that we are no longer using a separate GitHub repository for the book, sorry for any confusion linking to a different repo pull request here!)

What needs to be done?

Who can help?


Updates

book-dash-mcr2019 good first issue reproducibility-book

All 19 comments

I'm going to try and restructure the Open Research chapter - my first pull request incoming in...some short time in the future :)

Thank you so much @jspickering! 👏 Would you be able to update the Table of Contents to reflect the new sections? If you've moved on to something else @pherterich or I could take a crack at it :)

I've edited the Table of Contents file!

I'm going to have a go at restructuring the Risk Assessment chapter

I'll restructure the Version Control chapter

Edit: I will leave this for someone at the London book dash! :)

I'll restructure the Version Control chapter

Edit: I will leave this for someone at the London book dash! :)

  • I'll pick this up! 💃

I'll pick up the Collaborating with GitHub/GitLab chapter

I'll pick up the Reproducible Environments chapter with PR https://github.com/alan-turing-institute/the-turing-way/pull/575

Please note:

  1. Each PR will need to update website/_data/toc.yaml

  2. Any table-of-contents markdown content will need to be edited to reference external files: for example if you had a reference to content in the current file

    - [Binder](#Binder_section)
    

    and then moved to a new file ./04/binder.md, you'll need to update the link to

    - [Binder](./04/binder#Binder_section)
    

Please note:

1. Each PR will need to update `website/_data/toc.yaml`

2. Any table-of-contents markdown content will need to be edited to reference external files: for example if you had a reference to content in the current file
   ```
   - [Binder](#Binder_section)
   ```


   and then moved to a new file `./04/binder.md`, you'll need to update the link to
   ```
   - [Binder](./04/binder#Binder_section)
   ```

Thank you @masonlr, I'll get these instructions added to the Contributing Guidelines!

@rainsworth can we decide whether manual TOC entries are still needed in the book? See a new issue here https://github.com/alan-turing-institute/the-turing-way/issues/581

I'll take the Reviewing chapter, will remove the manual TOC as per @masonlr suggestion in #581

I'll take the Testing chapter

I can reorganise the version control chapter if no one else is doing this?

@christopherlovell go for it.

Thank you @christopherlovell!

pull request submitted #729

(and my bad spelling fixed...)

I will attempt to restructure the Research Data Management chapter...

Thank you for working on these chapters. Many of these changes have been accepted to the current version, thanks to many of you. ❤️️

Please see #977 for the chapters with subsections. I will keep this issue open till we get the PR merged.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

sgibson91 picture sgibson91  ·  5Comments

ArielleBL picture ArielleBL  ·  4Comments

Ismael-KG picture Ismael-KG  ·  4Comments

sparkler0323 picture sparkler0323  ·  3Comments

KirstieJane picture KirstieJane  ·  4Comments