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

Add the draft for project design overview #1936

Merged
merged 62 commits into from
Jul 3, 2021
Merged

Conversation

malvikasharan
Copy link
Collaborator

@malvikasharan malvikasharan commented May 20, 2021

Summary

Fixes #1395

  • Add the draft by Mariana from her HackMD along with my notes for the initial chapters

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

What should a reviewer concentrate their feedback on?

  • Covers all topics
  • Refers to different chapters
  • Everything looks ok?

Acknowledging contributors

@netlify
Copy link

netlify bot commented May 20, 2021

✔️ Deploy Preview for the-turing-way ready!

🔨 Explore the source changes: c2aaccc

🔍 Inspect the deploy log: https://app.netlify.com/sites/the-turing-way/deploys/60df19020d518b000782e1c7

😎 Browse the preview: https://deploy-preview-1936--the-turing-way.netlify.app/communication/citable

@malvikasharan
Copy link
Collaborator Author

malvikasharan commented May 20, 2021

@marianaiv Nina offered to review this so I have moved all the materials in this PR. Let me know if the structure looks good to you.
Crossreference to the different chapters in the second subchapter is missing and I am leaving it commented that we can update when Kirstie finishes revamping the collaboration guide. Though for first release, it is not essential.

Copy link
Collaborator

@ninadicara ninadicara left a comment

Choose a reason for hiding this comment

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

Hiya, I've got as far as the repo chapter for now - so much work and writing has gone into this!
Most of the comments I've left are really minor things so I've put them as suggested changes. Hope that's okay!
I've really enjoyed reading it so far - it's great having so many links out to other sections ✨

book/website/project-design/pd-overview.md Outdated Show resolved Hide resolved
book/website/project-design/pd-overview.md Outdated Show resolved Hide resolved
book/website/project-design/pd-overview.md Outdated Show resolved Hide resolved
book/website/project-design/pd-overview.md Outdated Show resolved Hide resolved
marianaiv and others added 14 commits May 21, 2021 09:54
Co-authored-by: Nina <44364127+ninadicara@users.noreply.github.com>
Co-authored-by: Nina <44364127+ninadicara@users.noreply.github.com>
Co-authored-by: Nina <44364127+ninadicara@users.noreply.github.com>
Co-authored-by: Nina <44364127+ninadicara@users.noreply.github.com>
Co-authored-by: Nina <44364127+ninadicara@users.noreply.github.com>
Co-authored-by: Nina <44364127+ninadicara@users.noreply.github.com>
Co-authored-by: Nina <44364127+ninadicara@users.noreply.github.com>
Co-authored-by: Nina <44364127+ninadicara@users.noreply.github.com>
Co-authored-by: Nina <44364127+ninadicara@users.noreply.github.com>
Co-authored-by: Nina <44364127+ninadicara@users.noreply.github.com>
Co-authored-by: Nina <44364127+ninadicara@users.noreply.github.com>
Co-authored-by: Nina <44364127+ninadicara@users.noreply.github.com>
Co-authored-by: Nina <44364127+ninadicara@users.noreply.github.com>
@malvikasharan
Copy link
Collaborator Author

@ninadicara Really helpful suggestions and edits.
I have divided the first chapter into three sections. It does give a better and more cohesive structure to the document.

Thank you so much for such thorough and constructive feedback. 🙏

@malvikasharan
Copy link
Collaborator Author

@all-contributors please add @ninadicara for review and edits

@allcontributors
Copy link
Contributor

@malvikasharan

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

@malvikasharan
Copy link
Collaborator Author

@all-contributors please add @marianaiv for content

@allcontributors
Copy link
Contributor

@malvikasharan

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

book/website/_toc.yml Outdated Show resolved Hide resolved
@malvikasharan
Copy link
Collaborator Author

This from my side is ready to merge. @marianaiv please go ahead and merge it when you are ready! 🌷

@marianaiv marianaiv merged commit 0dadc62 into master Jul 3, 2021
@marianaiv marianaiv deleted the project-design-overview branch July 3, 2021 01:29
@pr-triage pr-triage bot added the PR: merged label Jul 3, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
book-dash-may21 This Label is for Book Dash May 2021 related issues and PRs PR: merged PR: unreviewed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Introduction to the "Project Design Handbook"
3 participants