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

Restructuring version control chapter #729

Closed
wants to merge 5 commits into from
Closed

Restructuring version control chapter #729

wants to merge 5 commits into from

Conversation

christopherlovell
Copy link
Collaborator

@christopherlovell christopherlovell commented Oct 25, 2019

Summary

Addresses (but does not close) #468.

List of changes proposed in this PR (pull-request)

  • Restructure Reproducible Environments chapter
  • Update TOCs

What should a reviewer concentrate their feedback on?

  • Everything looks ok?

Acknowledging contributors

Thanks!

@netlify
Copy link

netlify bot commented Oct 25, 2019

Deploy preview for the-turing-way ready!

Built with commit 4667a56

https://deploy-preview-729--the-turing-way.netlify.com

@christopherlovell christopherlovell changed the title Restructuing version control chapter Restructuring version control chapter Oct 25, 2019
@KirstieJane KirstieJane mentioned this pull request Nov 20, 2019
3 tasks
KirstieJane
KirstieJane previously approved these changes Nov 20, 2019
Copy link
Collaborator

@KirstieJane KirstieJane left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is so great! Thank you so much @christopherlovell!!

Merge away!! 🚀 👾 🌟

@KirstieJane KirstieJane added enhancement New feature or request reproducibility-book Content for reproducibility book labels Nov 20, 2019
@KirstieJane
Copy link
Collaborator

Hi @allcontributors! Please could you add @christopherlovell for infrastructure!

@allcontributors
Copy link
Contributor

@KirstieJane

I've put up a pull request to add @christopherlovell! 🎉

@christopherlovell
Copy link
Collaborator Author

christopherlovell commented Nov 20, 2019

This PR currently breaks all the links in this chapter 😬 @KirstieJane and I spoke about the best approach to adding links between sections in chapters when split in to multiple files, and we weren't sure.

I've since found the following discussion on the jupyter-book repo:

executablebooks/jupyter-book#298

Essentially, it's tricky! If you put in hardcoded links to the markdown, these links break when compiled in to html. You can hard code the links to the .html compiled versions, but the question is do we want to also have the correct links to the original markdown?


As you work on you project you will make more and more commits.
Without any other information it can be hard to remember which version of your project is in which.
Storing past versions is useless if you ca not understand them, and figuring out what they contain by inspecting the code is frustrating and takes valuable time.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Storing past versions is useless if you ca not understand them, and figuring out what they contain by inspecting the code is frustrating and takes valuable time.
Storing past versions is useless if you can not understand them, and figuring out what they contain by inspecting the code is frustrating and takes valuable time.

@jbteves
Copy link

jbteves commented May 27, 2020

Hello @christopherlovell! I'm not part of the Turing Way but I did participate on one of the collaboration cafes last month and chatted with @KirstieJane about the git chapter, and she pointed me to this PR. I corrected a small typo but didn't offer any other inline suggestions.

I'd like to add as an outsider that it might make sense to walk people through a little more global config setup, particularly handling the autoclrf problem that Windows users experience, and setting up the default editor. The editor gets a little funny if you use a GUI program like Notepad, because the program will continue with a save instead of with a quit since it launches outside of the terminal. So maybe some guidance there would be good, new users can be confused there.

I'm happy to open a PR to your fork to add those changes if you think they're worth discussing further.

@christopherlovell
Copy link
Collaborator Author

Hi @jbteves, thanks for taking a look! This PR was just for restructuring the files so that the content was not just in one single enormous file / page. I didn't have any involvement in editing the content, perhaps you could raise a PR for that separately?

Not sure if this PR is still relevant as I imagine there has been a lot of work on the content that these changes would significantly break. Probably worth closing this and attempting again....

@malvikasharan
Copy link
Collaborator

These changes have been integrated into the current version of the book. Thank you all for your contribution.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request PR: unreviewed reproducibility-book Content for reproducibility book
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants