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

[documentation] Changing the dev activity note in Iroha 1 documentation to a warning #3070

Closed
6r1d opened this issue Jan 23, 2023 · 1 comment
Closed

[documentation] Changing the dev activity note in Iroha 1 documentation to a warning #3070

6r1d opened this issue Jan 23, 2023 · 1 comment
Assignees
@6r1d
Labels
1.5 Documentation Documentation changes iroha1 The legacy version of Iroha.

Comments

@6r1d
Copy link
Contributor

6r1d commented Jan 23, 2023 •
edited
Loading

Documentation URL(s)

https://github.com/hyperledger/iroha/blob/main/docs/source/index.rst

Description

Currently, the documentation claims that I1 and I2 development happens in parallel, while the core team is focused on Iroha 2. This needs an update, so the users are not misdirected towards using I1 in new projects.

Your suggestions

I have an updated text in mind. First of all, it should be a warning, not an info block, secondly, it has to be on the top.
Finally, I believe it should look like this to reflect the current state of development:

Please note that support for Hyperledger Iroha v1 is limited because it's no longer actively developed.

The core team focuses on Hyperledger Iroha v2, a complete rewrite of Iroha in Rust.

These versions are incompatible, so you will have to use Iroha 2 instead of Iroha 1 for the new projects.
You can read about the differences in the Iroha 2 documentation.

Who can help?

@outoftardis
@6r1d 6r1d added Documentation Documentation changes 1.5 labels Jan 23, 2023
6r1d added a commit to 6r1d/iroha that referenced this issue Jan 23, 2023
@6r1d
[documentation] hyperledger-iroha#3070: mention reduced dev activity
2aab906
@6r1d 6r1d mentioned this issue Jan 23, 2023
Merged
6r1d added a commit to 6r1d/iroha that referenced this issue Jan 23, 2023
@6r1d
[documentation] hyperledger-iroha#3070: mention reduced dev activity
834d35f 
Signed-off-by: 6r1d <[email protected]>
@6r1d 6r1d self-assigned this Jan 23, 2023
6r1d added a commit that referenced this issue Jan 24, 2023
@6r1d @outoftardis @WRRicht3r
[documentation] #3070: mention reduced dev activity (#3071)
642e04c 
Co-authored-by: Ekaterina Mekhnetsova <[email protected]>
Co-authored-by: William Richter <[email protected]>
@outoftardis
Copy link
Contributor

Addressed in #3071

@nxsaken nxsaken added the iroha1 The legacy version of Iroha. label Apr 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@6r1d 6r1d

Labels
1.5 Documentation Documentation changes iroha1 The legacy version of Iroha.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@6r1d @outoftardis @nxsaken