Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

[documentation]: remove auto-generated configuration reference #4127

Merged

Conversation

0x009922
Copy link
Contributor

@0x009922 0x009922 commented Dec 8, 2023

Description

This PR removes auto-generated configuration reference and everything related to it.

The motivation is to make one step forward towards the new reference (hyperledger-iroha/iroha-2-docs#392).

After merge of this PR, there will be no configuration reference available for some time. We decided that it is fine and will streamline further process according to the RFC (#2585).

Should be reviewed and merged after:

@0x009922 0x009922 added iroha2-dev The re-implementation of a BFT hyperledger in RUST Documentation Documentation changes config-changes Changes in configuration and start up of the Iroha labels Dec 8, 2023
@0x009922 0x009922 self-assigned this Dec 8, 2023
@coveralls
Copy link

coveralls commented Dec 8, 2023

Pull Request Test Coverage Report for Build 7188221761

  • 17 of 17 (100.0%) changed or added relevant lines in 16 files are covered.
  • 7092 unchanged lines in 125 files lost coverage.
  • Overall coverage decreased (-3.3%) to 56.133%

Files with Coverage Reduction New Missed Lines %
config/base/derive/src/view.rs 1 99.37%
core/src/smartcontracts/isi/block.rs 1 87.5%
ffi/src/option.rs 2 71.43%
config/src/genesis.rs 3 72.92%
config/src/logger.rs 3 92.68%
data_model/derive/src/has_origin.rs 3 95.16%
data_model/src/events/execute_trigger.rs 3 30.77%
data_model/src/peer.rs 3 47.62%
ffi/src/ir.rs 3 80.0%
ffi/src/lib.rs 3 93.46%
Totals Coverage Status
Change from base Build 5423219773: -3.3%
Covered Lines: 22787
Relevant Lines: 40595

💛 - Coveralls

@0x009922 0x009922 changed the title [docs] #0000: remove auto-generated configuration reference [documentation]: remove auto-generated configuration reference Dec 11, 2023
@0x009922 0x009922 changed the title [documentation]: remove auto-generated configuration reference [documentation]: remove auto-generated configuration reference (?) Dec 11, 2023
@0x009922 0x009922 changed the title [documentation]: remove auto-generated configuration reference (?) [documentation]: remove auto-generated configuration reference Dec 11, 2023
@0x009922 0x009922 force-pushed the remove-config-documentation branch from a2cb97c to 434411e Compare December 12, 2023 09:21
@0x009922 0x009922 marked this pull request as ready for review December 12, 2023 09:21
README.md Show resolved Hide resolved
config/base/derive/src/lib.rs Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
config/base/derive/src/lib.rs Show resolved Hide resolved
@DCNick3 DCNick3 self-assigned this Dec 12, 2023
Signed-off-by: Dmitry Balashov <43530070+0x009922@users.noreply.github.com>
@0x009922 0x009922 force-pushed the remove-config-documentation branch from 434411e to 78a2c3d Compare December 12, 2023 22:50
@0x009922 0x009922 merged commit a2ff9a0 into hyperledger-iroha:iroha2-dev Dec 13, 2023
11 checks passed
@0x009922 0x009922 deleted the remove-config-documentation branch December 13, 2023 05:03
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
config-changes Changes in configuration and start up of the Iroha Documentation Documentation changes iroha2-dev The re-implementation of a BFT hyperledger in RUST
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants