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.

Sign up for GitHub

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

Jump to bottom

[refactor] Organisation of json files and readme. #1617

Merged
merged 6 commits into from
Nov 24, 2021
Merged

[refactor] Organisation of json files and readme. #1617

merged 6 commits into from
Nov 24, 2021

Conversation

appetrosyan
Copy link
Contributor

@appetrosyan appetrosyan commented Nov 17, 2021 •
edited
Loading

Signed-off-by: Aleksandr a-p-petrosyan@yandex.ru

Description of the Change

Updated documentation

Issue

Closes #1248
Closes #1237
Closes #1127

Benefits

  • Easier to read README.md.
  • Better-organised config files
  • Glossary with most commonly used terms.
  • Better generated documentation.

Possible Drawbacks

None

@appetrosyan appetrosyan marked this pull request as ready for review November 17, 2021 13:13
@appetrosyan appetrosyan changed the title [README.md] Updated Readme to conform to template. [docs] Updated Readme to conform to template. Nov 18, 2021
@appetrosyan appetrosyan added Documentation Documentation changes iroha2-dev The re-implementation of a BFT hyperledger in RUST labels Nov 18, 2021
s8sato
s8sato reviewed Nov 18, 2021
View reviewed changes
core/src/config.rs Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
KalitaAlexey
KalitaAlexey reviewed Nov 18, 2021
View reviewed changes
README.md Outdated Show resolved Hide resolved
core/docs/src/main.rs Outdated Show resolved Hide resolved
@s8sato
Copy link
Contributor

s8sato commented Nov 18, 2021

Regarding #1237,
some inconsistencies seem to remain as far as I search for
core/config, client/config, CONFIGURATION_PATH, etc.

s8sato
s8sato reviewed Nov 18, 2021
View reviewed changes
core/src/genesis.rs Outdated Show resolved Hide resolved
configs/config.json Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
cli/README.md Show resolved Hide resolved
scripts/setup_docker_test_env.sh Outdated Show resolved Hide resolved
@appetrosyan appetrosyan changed the title [docs] Updated Readme to conform to template. [refactor] Organisation of json files and readme. Nov 22, 2021
i1i1
i1i1 reviewed Nov 22, 2021
View reviewed changes
core/src/queue.rs Outdated Show resolved Hide resolved
i1i1
i1i1 reviewed Nov 22, 2021
View reviewed changes
core/src/torii/mod.rs Outdated Show resolved Hide resolved
@codecov
Copy link

codecov bot commented Nov 22, 2021 •
edited
Loading

Codecov Report

Merging #1617 (b3bf23e) into iroha2-dev (bc94a23) will decrease coverage by 0.32%.
The diff coverage is 89.95%.

Impacted file tree graph

@@              Coverage Diff               @@
##           iroha2-dev    #1617      +/-   ##
==============================================
- Coverage       74.74%   74.42%   -0.33%     
==============================================
  Files             119      120       +1     
  Lines           19629    19803     +174     
==============================================
+ Hits            14672    14738      +66     
- Misses           4957     5065     +108
Impacted Files Coverage Δ
core/docs/src/main.rs 1.53% <0.00%> (-0.13%) ⬇️
core/src/lib.rs 62.11% <0.00%> (ø)
core/src/wsv.rs 87.24% <ø> (ø)
core/test_network/tests/sumeragi_with_mock.rs 0.24% <0.00%> (ø)
crypto/src/signature.rs 75.34% <28.57%> (-1.25%) ⬇️
core/src/genesis.rs 93.54% <79.06%> (-4.51%) ⬇️
client/src/lib.rs 100.00% <100.00%> (ø)
core/src/config.rs 94.89% <100.00%> (ø)
core/src/queue.rs 97.83% <100.00%> (ø)
core/src/samples.rs 100.00% <100.00%> (ø)
... and 13 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update bc94a23...b3bf23e. Read the comment docs.

@appetrosyan appetrosyan added the Refactor Improvement to overall code quality label Nov 23, 2021
s8sato
s8sato reviewed Nov 23, 2021
View reviewed changes
Copy link
Contributor

@s8sato s8sato left a comment

Choose a reason for hiding this comment

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

Adding about configs to the top description would help as it is significant part of this PR

configs/peer/config.json Outdated Show resolved Hide resolved
configs/peer/genesis.json Outdated Show resolved Hide resolved
cli/README.md Show resolved Hide resolved
core/src/samples.rs Outdated Show resolved Hide resolved
scripts/setup_docker_test_env.sh Show resolved Hide resolved
docs/source/references/glossary.md Outdated Show resolved Hide resolved
@appetrosyan appetrosyan force-pushed the i2-configs branch 3 times, most recently from 15d74ba to e1442e8 Compare November 23, 2021 16:09
i1i1
i1i1 reviewed Nov 23, 2021
View reviewed changes
core/src/genesis.rs Outdated Show resolved Hide resolved
i1i1
i1i1 reviewed Nov 23, 2021
View reviewed changes
core/src/genesis.rs Outdated Show resolved Hide resolved
@appetrosyan
[README.md] Updated Readme to conform to template.
a9c5610 
Signed-off-by: Aleksandr <a-p-petrosyan@yandex.ru>
@appetrosyan
Fixed tests to use the new locations.
3d6abfc 
Signed-off-by: Aleksandr <a-p-petrosyan@yandex.ru>
@appetrosyan
Improved documentation generator.
5183e94 
Signed-off-by: Aleksandr <a-p-petrosyan@yandex.ru>
@appetrosyan
Added a table for system requirements.
579db85 
Signed-off-by: Aleksandr <a-p-petrosyan@yandex.ru>

Removed redundant configuration files.

Signed-off-by: Aleksandr <a-p-petrosyan@yandex.ru>

Added glossary entries.

Signed-off-by: Aleksandr <a-p-petrosyan@yandex.ru>

Final consolidation.

Signed-off-by: Aleksandr <a-p-petrosyan@yandex.ru>

Removed JSONs from tests.

Signed-off-by: Aleksandr <a-p-petrosyan@yandex.ru>

Hard-coded configurations to not use JSON.

Made tests pass.

Signed-off-by: Aleksandr <a-p-petrosyan@yandex.ru>

Added glossary entries.

Signed-off-by: Aleksandr <a-p-petrosyan@yandex.ru>
@appetrosyan appetrosyan force-pushed the i2-configs branch 5 times, most recently from d19b46a to bf8c6b7 Compare November 24, 2021 05:18
@appetrosyan appetrosyan removed the request for review from GaroRobe November 24, 2021 05:31
@appetrosyan appetrosyan force-pushed the i2-configs branch 3 times, most recently from bd117e1 to 034936c Compare November 24, 2021 07:54
@appetrosyan
Added glossary entries.
52a74a0 
Signed-off-by: Aleksandr <a-p-petrosyan@yandex.ru>
i1i1
i1i1 previously approved these changes Nov 24, 2021
View reviewed changes
s8sato
s8sato reviewed Nov 24, 2021
View reviewed changes
Copy link
Contributor

@s8sato s8sato left a comment

Choose a reason for hiding this comment

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

I'm about to approve except:
Regarding #1127 (glossary),
this is an update of the dedicated doc instead of an addition to the whitepaper as the issue title says.
On this point is there an agreement between you @eadventurous ?

@appetrosyan
Added glossary to whitepaper.
b3bf23e 
Signed-off-by: Aleksandr <a-p-petrosyan@yandex.ru>
@appetrosyan appetrosyan enabled auto-merge (squash) November 24, 2021 13:02
@appetrosyan appetrosyan merged commit 3285d53 into hyperledger:iroha2-dev Nov 24, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@i1i1 i1i1 i1i1 approved these changes

@s8sato s8sato s8sato approved these changes

@e-ivkov e-ivkov Awaiting requested review from e-ivkov

@mversic mversic Awaiting requested review from mversic

@KalitaAlexey KalitaAlexey Awaiting requested review from KalitaAlexey

Assignees
No one assigned
Labels
Documentation Documentation changes iroha2-dev The re-implementation of a BFT hyperledger in RUST Refactor Improvement to overall code quality
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@appetrosyan @s8sato @KalitaAlexey @i1i1