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

[Documentation] Updated the new contributor learning guide #305

Merged
merged 8 commits into from
Oct 24, 2022

Conversation

Olshansk
Copy link
Member

@Olshansk Olshansk commented Oct 17, 2022

Description

Improve the new-contributor learning-guide with the new links, better formatting and a technical foundation section. See the full list of changes below.

Issue

NA

Type of change

Please mark the relevant option(s):

  • New feature, functionality or library
  • Bug fix
  • Code health or cleanup
  • Major breaking change
  • Documentation
  • Other

List of changes

Made several modifications to docs/learning/README.md

  • Added a ToC (Table of Contents)
  • Minor edits & formatting improvements to make it easier to view & read
  • Added a few new elements (e.g. Roadmap) to getting started
  • Added a “Technical Foundation” section for junior/mid level engineers
  • Added a suggested reading on Eclipse attacks
  • Added a non-suggested read on DHTs for Merkle Trees
  • Added time estimations to every point in "Where to Start"
  • Added summaries / goals to every bullet point in "Where to start"

Testing

  • make develop_test
  • LocalNet w/ all of the steps outlined in the README

Required Checklist

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have tested my changes using the available tooling
  • I have updated the corresponding CHANGELOG

If Applicable Checklist

  • I have updated the corresponding README(s); local and/or global
  • I have added tests that prove my fix is effective or that my feature works
  • I have added, or updated, mermaid.js diagrams in the corresponding README(s)
  • I have added, or updated, documentation and mermaid.js diagrams in shared/docs/* if I updated shared/*README(s)

@Olshansk Olshansk added the documentation Improvements or additions to documentation label Oct 17, 2022
@Olshansk Olshansk requested a review from a team as a code owner October 17, 2022 02:18
@Olshansk
Copy link
Member Author

cc @ArtSabintsev as well

@Olshansk Olshansk changed the title Updated the new contributor learning guide [Documentation] Updated the new contributor learning guide Oct 17, 2022
docs/learning/README.md Outdated Show resolved Hide resolved
docs/learning/README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@Jasonyou1995 Jasonyou1995 left a comment

Choose a reason for hiding this comment

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

Please check the highlighted parts

docs/learning/README.md Outdated Show resolved Hide resolved
docs/learning/README.md Outdated Show resolved Hide resolved
docs/learning/README.md Outdated Show resolved Hide resolved
@Olshansk
Copy link
Member Author

@Jasonyou1995 Love all of the suggestions you made and pushed the corresponding changes! Please take another look when you have a chance again

@Olshansk
Copy link
Member Author

@Jasonyou1995 Please review again when you have a chance. Would appreciate your input here.

Copy link
Contributor

@Jasonyou1995 Jasonyou1995 left a comment

Choose a reason for hiding this comment

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

I added some more review comments for more readability, please see the high lights.

docs/learning/README.md Outdated Show resolved Hide resolved
docs/learning/README.md Outdated Show resolved Hide resolved
Comment on lines 50 to 54
- [Utility](https://docs.google.com/presentation/d/1NU0PnegtBm5ioLu0VQMiluWT4usHnavDKrGvS3p8QdM/edit)
- [Persistence](https://docs.google.com/presentation/d/1qDA-pRMT1KV9byUAU49bvd_5seaILPAh6i3vA7j5l8o/edit)
- [P2p](https://docs.google.com/presentation/d/1CLeAcGJbM_iP76vnCoHreU1chB9vFWIYWAwQHa-MPbc/edit)
- [Consensus](https://docs.google.com/presentation/d/18CtSxxLLHY1N7HEJtja633mVF1_a9blaE2fe2-WgGAo/edit)
-->
Copy link
Contributor

Choose a reason for hiding this comment

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

Here is a just my thoughts for a more intuitive structure: (might require restructuring and analyzing which existing/listed contents mainly belong to which)

  • Utility

Technical content 1 (related to utility)
Technical content 2

  • Persistence

Technical content 1 (related to persistence)
Technical content 2

  • P2P

Technical content 1 (related to P2P)
Technical content 2

  • Consensus

Technical content 1 (related to Consensus)
Technical content 2

Copy link
Member Author

Choose a reason for hiding this comment

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

Note that these are hidden (they're inside of comments) and not actually rendered on the README.

Otherwise, I'm not quite sure what the suggestion is. Where to Start? is meant to be a set of steps someone follows rather than a link dump of rerences.

@Olshansk Olshansk requested a review from Jasonyou1995 October 21, 2022 21:43
Copy link
Contributor

@deblasis deblasis left a comment

Choose a reason for hiding this comment

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

Very nice!

Damn it tho... how do I not click onto something I was told not to click on? (referring to non-suggested reads) 😁

@Olshansk
Copy link
Member Author

Going to merge this in and we can iterate further if/when need be.

@Olshansk Olshansk merged commit ff835d5 into main Oct 24, 2022
@Olshansk Olshansk deleted the update_new_hire_guide branch October 24, 2022 16:55
@Olshansk
Copy link
Member Author

Very nice!

Damn it tho... how do I not click onto something I was told not to click on? (referring to non-suggested reads) 😁

@deblasis Noted. Good lesson in getting people to do stuff.

Message to the community: w/e you do, make sure not to contribute to V1.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants