Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reorganise chapters into subsections #468

Closed
20 tasks done
rainsworth opened this issue May 16, 2019 · 20 comments
Closed
20 tasks done

Reorganise chapters into subsections #468

rainsworth opened this issue May 16, 2019 · 20 comments
Labels
book-dash-mcr2019 Issues related to contributions made during the Manchester Book Dash good first issue Good issue for newcomers to fix or respond to reproducibility-book Content for reproducibility book

Comments

@rainsworth
Copy link
Collaborator

rainsworth commented May 16, 2019

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:
alan-turing-institute/the-turing-way-book#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

@rainsworth rainsworth added good first issue Good issue for newcomers to fix or respond to reproducibility-book Content for reproducibility book labels May 16, 2019
@jspickering
Copy link
Collaborator

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

@rainsworth
Copy link
Collaborator Author

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 :)

@rainsworth rainsworth added the book-dash-mcr2019 Issues related to contributions made during the Manchester Book Dash label May 17, 2019
@jspickering
Copy link
Collaborator

I've edited the Table of Contents file!

@rosiehigman
Copy link
Collaborator

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

@jspickering
Copy link
Collaborator

jspickering commented May 17, 2019

I'll restructure the Version Control chapter

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

@cassgvp
Copy link
Collaborator

cassgvp commented May 28, 2019

I'll restructure the Version Control chapter

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

  • I'll pick this up! 💃

@rosiehigman
Copy link
Collaborator

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

@masonlr
Copy link
Collaborator

masonlr commented May 28, 2019

I'll pick up the Reproducible Environments chapter with PR #575

@masonlr
Copy link
Collaborator

masonlr commented May 28, 2019

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)
    

@rainsworth
Copy link
Collaborator Author

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!

@masonlr
Copy link
Collaborator

masonlr commented May 28, 2019

@rainsworth can we decide whether manual TOC entries are still needed in the book? See a new issue here #581

@rosiehigman
Copy link
Collaborator

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

@rosiehigman
Copy link
Collaborator

I'll take the Testing chapter

@christopherlovell
Copy link
Collaborator

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

@masonlr
Copy link
Collaborator

masonlr commented Oct 24, 2019

@christopherlovell go for it.

@KirstieJane
Copy link
Collaborator

Thank you @christopherlovell!

@christopherlovell
Copy link
Collaborator

pull request submitted #729

(and my bad spelling fixed...)

@dblana
Copy link
Contributor

dblana commented Nov 20, 2019

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

@malvikasharan
Copy link
Collaborator

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.

@dingaaling
Copy link
Collaborator

Hello from 2022! Hope all is well with you, many months later. The TTW Core team is currently reviewing issues in our backlog to determine how they can best be taken forward. This issue looks like it has now been incorporated in the Turing Way in some way - #977 - or is no longer being actioned. Therefore we will now be closing this issue. If you have any questions or concerns, please comment below ✨ Thank you!

Outstanding Issues + Pull Requests Review automation moved this from Outstanding Issues to Done Oct 31, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
book-dash-mcr2019 Issues related to contributions made during the Manchester Book Dash good first issue Good issue for newcomers to fix or respond to reproducibility-book Content for reproducibility book
Development

No branches or pull requests

10 participants