Update source folder readme with more terminology and sub-crate #446
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
For better navigation to those clicking around exploring the GitHub repository
Codecov Report
@@ Coverage Diff @@
## main #446 +/- ##
=======================================
Coverage 60.55% 60.55%
=======================================
Files 24 24
Lines 2183 2183
=======================================
Hits 1322 1322
Misses 861 861 Continue to review full report at Codecov.
|
chb0github
previously approved these changes
Mar 2, 2022
prince-chrismc
commented
Mar 4, 2022
| @@ -1,16 +1,19 @@ | |||
| # Pyrsia Library | |||
|
|
|||
| Principale set of module making up the [Node](../pyrsia_node) and [CLI](../pyrsia_cli) | |||
| Principale set of module which make up the [Node](../pyrsia_node) and [CLI](../pyrsia_cli) components. | |||
|
|
|||
| ## Terminology | |||
There was a problem hiding this comment.
@prince-chrismc do you mean functionality wise or definition? for node we can define what actually means , what network protocol using, peer nodes discovery using kademlia dht and in future when we will have inclusion of central node vs normal node then we can add more context, about bootstrap nodes and net traversal protocols supported. @erwin1 what do you think?
From cli side we can just define different subcommands to talk to your local node and give information about that
There was a problem hiding this comment.
Definitely looking for definitions, I'd like to shy away from the technical details here.
Those technical details would go nicely with #462 and they can be linked to from here 👍
The goal here is to "explaining the folder names to someone randomly clicking around" this should help them navigate to whatever they are more interested in.
We dont want too many locations with details but just enough to help people find them 🤞
There was a problem hiding this comment.
I actually missed out on this mention here. I think there might be some good p2p and docker candidates to explain here in this section, but I'd need to think about it. You might as well go ahead with this PR and then I'll do another pass later on
betarelease
reviewed
Mar 9, 2022
betarelease
previously approved these changes
Mar 9, 2022
Co-authored-by: Sudhindra Rao <41690+betarelease@users.noreply.github.com>
824c6cd
AbhijithGanesh
previously approved these changes
Mar 9, 2022
erwin1
reviewed
Mar 9, 2022
Co-authored-by: Erwin Morrhey <erwin@lodgon.com>
erwin1
approved these changes
Mar 10, 2022
MitaliBo
approved these changes
Mar 10, 2022
AbhijithGanesh
added a commit
to AbhijithGanesh/pyrsia
that referenced
this pull request
Mar 16, 2022
* keep all logs in release build and default to DEBUG log output for demo (part of pyrsia#442) (pyrsia#480) * Provide and retrieve artifacts via the kademlia p2p network (pyrsia#477) * lookup blobs via kademlia content provisioning * use dial and identify to add new node to dht * add local peer_id to status * Update source folder readme with more terminology and sub-crate (pyrsia#446) Co-authored-by: Sudhindra Rao <41690+betarelease@users.noreply.github.com> Co-authored-by: Erwin Morrhey <erwin@lodgon.com> Co-authored-by: Sudhindra Rao <41690+betarelease@users.noreply.github.com> Co-authored-by: Erwin Morrhey <erwin@lodgon.com> * Bump clap from 3.1.5 to 3.1.6 (pyrsia#474) Bumps [clap](https://github.com/clap-rs/clap) from 3.1.5 to 3.1.6. - [Release notes](https://github.com/clap-rs/clap/releases) - [Changelog](https://github.com/clap-rs/clap/blob/master/CHANGELOG.md) - [Commits](clap-rs/clap@v3.1.5...v3.1.6) --- updated-dependencies: - dependency-name: clap dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Bump once_cell from 1.9.0 to 1.10.0 (pyrsia#485) Bumps [once_cell](https://github.com/matklad/once_cell) from 1.9.0 to 1.10.0. - [Release notes](https://github.com/matklad/once_cell/releases) - [Changelog](https://github.com/matklad/once_cell/blob/master/CHANGELOG.md) - [Commits](matklad/once_cell@v1.9.0...v1.10.0) --- updated-dependencies: - dependency-name: once_cell dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Introduce the `KeyBox` for consensus engine (pyrsia#464) * delete signed structs build passes * more traces of openssl * cargo fmt Co-authored-by: Erwin Morrhey <erwin@lodgon.com> Co-authored-by: Joeri Sykora <joeri@sertik.net> Co-authored-by: Chris Mc <christopherm@jfrog.com> Co-authored-by: Sudhindra Rao <41690+betarelease@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
AbhijithGanesh
added a commit
that referenced
this pull request
Mar 29, 2022
* Removal of OpenSSL dependencies - Signed_struct and Struct * Zap openssl (#20) * Keep all logs in release build and default to DEBUG log output for demo (part of #442) (#480) * Provide and retrieve artifacts via the kademlia p2p network (#477) * lookup blobs via kademlia content provisioning * use dial and identify to add new node to dht * add local peer_id to status * Update source folder readme with more terminology and sub-crate (#446) * Bump clap from 3.1.5 to 3.1.6 (#474) Bumps [clap](https://github.com/clap-rs/clap) from 3.1.5 to 3.1.6. - [Release notes](https://github.com/clap-rs/clap/releases) - [Changelog](https://github.com/clap-rs/clap/blob/master/CHANGELOG.md) - [Commits](clap-rs/clap@v3.1.5...v3.1.6) --- updated-dependencies: - dependency-name: clap dependency-type: direct:production update-type: version-update:semver-patch ... * Bump once_cell from 1.9.0 to 1.10.0 (#485) Bumps [once_cell](https://github.com/matklad/once_cell) from 1.9.0 to 1.10.0. - [Release notes](https://github.com/matklad/once_cell/releases) - [Changelog](https://github.com/matklad/once_cell/blob/master/CHANGELOG.md) - [Commits](matklad/once_cell@v1.9.0...v1.10.0) --- updated-dependencies: - dependency-name: once_cell dependency-type: direct:production update-type: version-update:semver-minor ... * Introduce the `KeyBox` for consensus engine (#464) * delete signed structs * more traces of openssl * cargo fmt * add `now_as_iso8601_string` for testing * Resolution of errors * Restoring ArtifactBuilder * Removal of _hash * Suggested changes - Chris * Update Dockerfile * fix clippy warning by move import to correct spot * fix import * Update src/docker/v2/handlers/manifests.rs * Update src/metadata_manager/metadata.rs * Update src/docker/v2/handlers/manifests.rs * Updates to signed functions * Cargo format fix * Updates to dev-dep * Changes of methods to fields Signed-off-by: Abhijith Ganesh <67182544+AbhijithGanesh@users.noreply.github.com> Co-authored-by: Erwin Morrhey <erwin@lodgon.com> Co-authored-by: Joeri Sykora <joeri@sertik.net> Co-authored-by: Chris Mc <christopherm@jfrog.com> Co-authored-by: Sudhindra Rao <41690+betarelease@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Chris Mc <prince.chrismc@gmail.com> Co-authored-by: Joeri Sykora <joeri.sykora@gluonhq.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
For better navigation to those clicking around exploring the GitHub repository
template makes no sense. just some doc 💄