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

Simplify the concepts/nodes/ page to make it easier to understand for new IPFS users. #951

Closed
sowagn9886 opened this issue Nov 30, 2021 · 7 comments
Assignees
Labels
dif/hard Having worked on the specific codebase is important effort/hours Estimated to take one or several hours kind/enhancement A net-new feature or an improvement to an existing feature P2 Medium: Good to have, but can wait until someone steps up status/ready Ready to be worked topic/docs Documentation

Comments

@sowagn9886
Copy link

Could use more context on the details of nodes, if possible. For a semi-technical person, this content is much less accessible than all previous chapters.

@welcome
Copy link

welcome bot commented Nov 30, 2021

Thank you for submitting your first issue to this repository! A maintainer will be here shortly to triage and review.
In the meantime, please double-check that you have provided all the necessary information to make this process easy! Any information that can help save additiona round trips is useful! We currently aim to give initial feedback within two business days. If this does not happen, feel free to leave a comment.
Please keep an eye on how this issue will be labeled, as labels give an overview of priorities, assignments and additional actions requested by the maintainers:

  • "Priority" labels will show how urgent this is for the team.
  • "Status" labels will show if this is ready to be worked on, blocked, or in progress.
  • "Need" labels will indicate if additional input or analysis is required.

Finally, remember to use https://discuss.ipfs.io if you just need general support.

@johnnymatthews johnnymatthews changed the title [DOCS ISSUE] (add your title here!) Explain Nodes. Nov 30, 2021
@johnnymatthews
Copy link
Contributor

Have you taken a look at the nodes page? If you have, and you still found it confusing, what kind of content would you like to see in there? This'll help us define a clear task list for this issue.

@johnnymatthews johnnymatthews added the kind/support A question or request for support label Nov 30, 2021
@sowagn9886
Copy link
Author

Hi, thanks for responding!

Yeah the nodes page was what i was referring to. Everything up to that point in the tutorial seemed to build a comprehensive understanding of the concepts from the ground up, but this chapter references a ton of technical terms, which seem like a foreign language at first glance.... QUIC, /ws/, WSS, TLS, etc. And each subsection of Types was quite complicated as well.

I think more written explanation of the concepts, as done in the previous chapters, would be really helpful. As well as some background on some of the terms mentioned above, if possible.

@johnnymatthews
Copy link
Contributor

this chapter references a ton of technical terms

Agreed. This page was actually taken from a HackMD post created by some of the core IPFS engineers to help explains things during hackathons and similar events. But you're absolutely right that this page should be easier to understand.

@johnnymatthews johnnymatthews changed the title Explain Nodes. Simplify the concepts/nodes/ page to make it easier to understand for new IPFS users. Dec 2, 2021
@johnnymatthews johnnymatthews added dif/hard Having worked on the specific codebase is important effort/hours Estimated to take one or several hours kind/enhancement A net-new feature or an improvement to an existing feature P2 Medium: Good to have, but can wait until someone steps up status/ready Ready to be worked topic/docs Documentation and removed kind/support A question or request for support labels Dec 2, 2021
@Annamarie2019
Copy link
Contributor

See PR #1031, where a few changes were submitted for usability.

@Annamarie2019
Copy link
Contributor

Annamarie2019 commented Feb 25, 2022

@sorenwagner and @johnnymatthews While adding the definitions for nodes for issue #683: List the Multiple Definitions of Node I also reorganized a bit and did some word smithing. Does this satisfy the need for this issue to simplify the page as well, see: Nodes, if so, we can close this PR.

@johnnymatthews
Copy link
Contributor

Does this satisfy the need for this issue to simplify the page as well, see: Nodes, if so, we can close this PR.

I believe so. Closing.

@Annamarie2019 Annamarie2019 self-assigned this Mar 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dif/hard Having worked on the specific codebase is important effort/hours Estimated to take one or several hours kind/enhancement A net-new feature or an improvement to an existing feature P2 Medium: Good to have, but can wait until someone steps up status/ready Ready to be worked topic/docs Documentation
Projects
None yet
Development

No branches or pull requests

3 participants