Skip to content

Commit

Permalink
chore: update links to repo and docs (#5213)
Browse files Browse the repository at this point in the history
* chore: update links to repo and docs
* docs: remove broken badge
---------
Signed-off-by: Nurzhan Sakén <[email protected]>
  • Loading branch information
nxsaken authored Nov 4, 2024
1 parent 4e760b6 commit 70e5aac
Show file tree
Hide file tree
Showing 38 changed files with 102 additions and 105 deletions.
10 changes: 5 additions & 5 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this form! You may refer to the [contributing guide](https://github.com/hyperledger/iroha/blob/main/CONTRIBUTING.md#reporting-bugs) for further details on filling bug reports.
Thanks for taking the time to fill out this form! You may refer to the [contributing guide](https://github.com/hyperledger-iroha/iroha/blob/main/CONTRIBUTING.md#reporting-bugs) for further details on filling bug reports.
Please be aware that SDK issues belong to other repositories:
- JavaScript: [`iroha-javascript`](https://github.com/hyperledger/iroha-javascript)
- Java/Kotlin: [`iroha-java`](https://github.com/hyperledger/iroha-java)
- Python: [`iroha-python`](https://github.com/hyperledger/iroha-python)
- JavaScript: [`iroha-javascript`](https://github.com/hyperledger-iroha/iroha-javascript)
- Java/Kotlin: [`iroha-java`](https://github.com/hyperledger-iroha/iroha-java)
- Python: [`iroha-python`](https://github.com/hyperledger-iroha/iroha-python)
- type: input
id: env
attributes:
Expand Down Expand Up @@ -72,7 +72,7 @@ body:
label: Logs
description: |
Provide an output log in JSON format, so we could determine what caused the issue faster.
To configure a file path and level for logs, check the [reference documentation](https://github.com/hyperledger/iroha/blob/iroha2-dev/docs/source/references/config.md#logger) or [peer configuration](https://hyperledger.github.io/iroha-2-docs/guide/configure/peer-configuration.html#logger).
To configure a file path and level for logs, check the [reference documentation](https://docs.iroha.tech/reference/torii-endpoints.html#configuration-retrieve) or [peer configuration](https://docs.iroha.tech/guide/configure/peer-configuration.html#logger).
**Please** leave JSON [syntax highlighting](https://help.github.com/en/github/writing-on-github/creating-and-highlighting-code-blocks#syntax-highlighting) and [collapsed sections](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/organizing-information-with-collapsed-sections) (`<details>` tag) enabled.
If the log indentation is broken, use the [js-beautify](https://beautifier.io/) service to format it.
value: |
Expand Down
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -391,7 +391,7 @@
- hyperledger#3162 Forbid 0 height in block streaming requests
- Configuration macro initial test
- hyperledger#3592 Fix for config files being updated on `release`
- hyperledger#3246 Don't involve `observing peer <https://github.com/hyperledger/iroha/blob/iroha2-dev/docs/source/iroha_2_whitepaper.md#2-system-architecture>`_ without `fault <https://en.wikipedia.org/wiki/Byzantine_fault>`_
- hyperledger#3246 Don't involve `observing peer <https://github.com/hyperledger-iroha/iroha/blob/main/docs/source/iroha_2_whitepaper.md#2-system-architecture>`_ without `fault <https://en.wikipedia.org/wiki/Byzantine_fault>`_
- hyperledger#3570 Correctly display client-side string query errors
- hyperledger#3596 `iroha_client_cli` shows blocks/events
- hyperledger#3473 Make `kagami validator` work from outside the iroha repository root directory
Expand Down
32 changes: 15 additions & 17 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,18 +19,18 @@ New to our project? [Make your first contribution](#your-first-code-contribution
### TL;DR

- Find [ZenHub](https://app.zenhub.com/workspaces/iroha-v2-60ddb820813b9100181fc060/board?repos=181739240).
- Fork [Iroha](https://github.com/hyperledger/iroha/tree/main).
- Fork [Iroha](https://github.com/hyperledger-iroha/iroha/tree/main).
- Fix your issue of choice.
- Ensure you follow our [style guides](#style-guides) for code and documentation.
- Write [tests](https://doc.rust-lang.org/cargo/commands/cargo-test.html). Ensure they all pass (`cargo test --workspace`).
- Perform pre-commit routine like formatting & artifacts regeneration (see [`pre-commit.sample`](./hooks/pre-commit.sample))
- With the `upstream` set to track [Hyperledger Iroha repository](https://github.com/hyperledger/iroha), `git pull -r upstream main`, `git commit -s`, `git push <your-fork>`, and [create a pull request](https://github.com/hyperledger/iroha/compare) to the `main` branch. Ensure it follows the [pull request guidelines](#pull-request-etiquette).
- With the `upstream` set to track [Hyperledger Iroha repository](https://github.com/hyperledger-iroha/iroha), `git pull -r upstream main`, `git commit -s`, `git push <your-fork>`, and [create a pull request](https://github.com/hyperledger-iroha/iroha/compare) to the `main` branch. Ensure it follows the [pull request guidelines](#pull-request-etiquette).

### Reporting Bugs

A *bug* is an error, design flaw, failure or fault in Iroha that causes it to produce an incorrect, unexpected, or unintended result or behaviour.

We track Iroha bugs via [Github Issues](https://github.com/hyperledger/iroha/issues?q=is%3Aopen+is%3Aissue+label%3ABug) labeled with the `Bug` tag.
We track Iroha bugs via [GitHub Issues](https://github.com/hyperledger-iroha/iroha/issues?q=is%3Aopen+is%3Aissue+label%3ABug) labeled with the `Bug` tag.

When you create a new issue, there is a template for you to fill in. Here's the checklist of what you should do when you are reporting bugs:
- [ ] Add the `Bug` tag
Expand Down Expand Up @@ -83,7 +83,7 @@ If you have any questions regarding our handling of security vulnerabilities, pl

### Suggesting Improvements

Create [an issue](https://github.com/hyperledger/iroha/issues/new) on GitHub with the appropriate tags (`Optimization`, `Enhancement`) and describe the improvement you are suggesting. You may leave this idea for us or someone else to develop, or you may implement it yourself.
Create [an issue](https://github.com/hyperledger-iroha/iroha/issues/new) on GitHub with the appropriate tags (`Optimization`, `Enhancement`) and describe the improvement you are suggesting. You may leave this idea for us or someone else to develop, or you may implement it yourself.

If you intend to implement the suggestion yourself, do the following:

Expand Down Expand Up @@ -117,15 +117,15 @@ You, as part of the aforementioned community, should consider helping others too

## Your First Code Contribution

1. Find a beginner-friendly issue among issues with the [good-first-issue](https://github.com/hyperledger/iroha/labels/good%20first%20issue) label.
1. Find a beginner-friendly issue among issues with the [good-first-issue](https://github.com/hyperledger-iroha/iroha/labels/good%20first%20issue) label.
2. Make sure that no one else is working on the issues you have chosen by checking that it is not assigned to anybody.
3. Assign the issue to yourself so that others can see that someone is working on it.
4. Read our [Rust Style Guide](#rust-style-guide) before you start writing code.
5. When you are ready to commit your changes, read the [pull request guidelines](#pull-request-etiquette).

## Pull Request Etiquette

Please [fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) the [repository](https://github.com/hyperledger/iroha/tree/main) and [create a feature branch](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository) for your contributions. When working with **PRs from forks**, check [this manual](https://help.github.com/articles/checking-out-pull-requests-locally).
Please [fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) the [repository](https://github.com/hyperledger-iroha/iroha/tree/main) and [create a feature branch](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository) for your contributions. When working with **PRs from forks**, check [this manual](https://help.github.com/articles/checking-out-pull-requests-locally).

#### Working on code contribution:
- Follow the [Rust Style Guide](#rust-style-guide) and the [Documentation Style Guide](#documentation-style-guide).
Expand Down Expand Up @@ -170,8 +170,8 @@ To pass the *`check-PR-title`* check, the pull request title must adhere to the

### Git Workflow

- [Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) the [repository](https://github.com/hyperledger/iroha/tree/main) and [create a feature branch](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository) for your contributions.
- [Configure the remote](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/configuring-a-remote-for-a-fork) to sync your fork with the [Hyperledger Iroha repository](https://github.com/hyperledger/iroha/tree/main).
- [Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) the [repository](https://github.com/hyperledger-iroha/iroha/tree/main) and [create a feature branch](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository) for your contributions.
- [Configure the remote](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/configuring-a-remote-for-a-fork) to sync your fork with the [Hyperledger Iroha repository](https://github.com/hyperledger-iroha/iroha/tree/main).
- Use the [Git Rebase Workflow](https://git-rebase.io/). Avoid using `git pull`. Use `git pull --rebase` instead.
- Use the provided [git hooks](./hooks/) to ease the development process.

Expand Down Expand Up @@ -204,7 +204,7 @@ Follow these commit guidelines:
- To run the source-code based tests, execute [`cargo test`](https://doc.rust-lang.org/cargo/commands/cargo-test.html) in the Iroha root. Note that this is a long process.
- To run benchmarks, execute [`cargo bench`](https://doc.rust-lang.org/cargo/commands/cargo-bench.html) from the Iroha root. To help debug benchmark outputs, set the `debug_assertions` environment variable like so: `RUSTFLAGS="--cfg debug_assertions" cargo bench`.
- If you are working on a particular component, be mindful that when you run `cargo test` in a [workspace](https://doc.rust-lang.org/cargo/reference/workspaces.html), it will only run the tests for that workspace, which usually doesn't include any [integration tests](https://www.testingxperts.com/blog/what-is-integration-testing).
- If you want to test your changes on a minimal network, the provided [`docker-compose.yml`](defaults/docker-compose.yml) creates a network of 4 Iroha peers in docker containers that can be used to test consensus and asset propagation-related logic. We recommend interacting with that network using either [`iroha-python`](https://github.com/hyperledger/iroha-python), or the included Iroha client CLI.
- If you want to test your changes on a minimal network, the provided [`docker-compose.yml`](defaults/docker-compose.yml) creates a network of 4 Iroha peers in docker containers that can be used to test consensus and asset propagation-related logic. We recommend interacting with that network using either [`iroha-python`](https://github.com/hyperledger-iroha/iroha-python), or the included Iroha client CLI.
- Do not remove failing tests. Even tests that are ignored will be run in our pipeline eventually.
- If possible, please benchmark your code both before and after making your changes, as a significant performance regression can break existing users' installations.

Expand Down Expand Up @@ -379,13 +379,11 @@ We use pinned dependencies. Follow these guidelines for versioning:

Our community members are active at:

| Service | Link |
| ------------- | ------------------------------------------------------------ |
| RocketChat | https://chat.hyperledger.org/channel/iroha |
| StackOverflow | https://stackoverflow.com/questions/tagged/hyperledger-iroha |
| Mailing List | [email protected] |
| Gitter | https://gitter.im/hyperledger-iroha/Lobby |
| Telegram | https://t.me/hl_iroha |
| YouTube | https://www.youtube.com/channel/UCYlK9OrZo9hvNYFuf0vrwww |
| Service | Link |
|---------------|--------------------------------------------------------------------|
| StackOverflow | https://stackoverflow.com/questions/tagged/hyperledger-iroha |
| Mailing List | https://lists.lfdecentralizedtrust.org/g/iroha |
| Telegram | https://t.me/hyperledgeriroha |
| Discord | https://discord.com/channels/905194001349627914/905205848547155968 |

---
6 changes: 3 additions & 3 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ version = "2.0.0-rc.1.0"
authors = ["Iroha 2 team <https://github.com/orgs/soramitsu/teams/iroha2>"]

description = "Efficient, simple, Byzantine-fault-tolerant DLT inspired by the Kaizen principle"
repository = "https://github.com/hyperledger/iroha/tree/iroha2-lts"
documentation = "https://hyperledger.github.io/iroha-2-docs"
repository = "https://github.com/hyperledger-iroha/iroha"
documentation = "https://docs.iroha.tech"
homepage = "https://iroha.tech"

license = "Apache-2.0"
Expand Down Expand Up @@ -149,7 +149,7 @@ rust.unused_lifetimes = "warn"
# TODO: reenable
# rust.unsafe_op_in_unsafe_fn = "deny"
rust.unexpected_cfgs = { level = "warn", check-cfg = [
# FIXME: https://github.com/hyperledger/iroha/issues/3102
# FIXME: https://github.com/hyperledger-iroha/iroha/issues/3102
'cfg(feature, values("ffi_import"))',
# It is set by `cargo-llvm-cov`
'cfg(coverage)'
Expand Down
27 changes: 13 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# Hyperledger Iroha

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
![Rust](https://github.com/hyperledger/iroha/workflows/Rust/badge.svg?branch=main)

Iroha is a simple and efficient blockchain ledger based on the **distributed ledger technology (DLT)**. Its design principles are inspired by the Japanese Kaizen principle of eliminating excesses (*muri*).

Expand Down Expand Up @@ -137,11 +136,11 @@ There is a set of configuration parameters that could be passed either through a
irohad --config /path/to/config.toml
```

**Note:** detailed configuration reference is [work in progress](https://github.com/hyperledger/iroha-2-docs/issues/392).
**Note:** detailed configuration reference is [work in progress](https://github.com/hyperledger-iroha/iroha-2-docs/issues/392).

### Endpoints

For a list of all endpoints, available operations, and ways to customize them with parameters, see [API Reference > Torii Endpoints](https://hyperledger.github.io/iroha-2-docs/api/torii-endpoints)
For a list of all endpoints, available operations, and ways to customize them with parameters, see [Reference > Torii Endpoints](https://docs.iroha.tech/reference/torii-endpoints.html)

### Logging

Expand All @@ -166,7 +165,7 @@ Output goes to `/dev/stdout`. Piping to files or [log rotation](https://www.comm

### Monitoring

The details of the `Health` endpoint can be found in the [API Reference > Torii Endpoints](https://hyperledger.github.io/iroha-2-docs/api/torii-endpoints#health).
The details of the `Health` endpoint can be found in the [API Reference > Torii Endpoints](https://docs.iroha.tech/reference/torii-endpoints.html#health).

Iroha can produce both JSON-formatted as well as `prometheus`-readable metrics at the `status` and `metrics` endpoints respectively.

Expand All @@ -176,7 +175,7 @@ The [`prometheus`](https://prometheus.io/docs/introduction/overview/) monitoring

Iroha stores blocks and snapshots in the `storage` directory, which is created automatically by Iroha in the working directory of the peer. If `kura.block_store_path` is specified in the config file, it overrides the default one and is resolved relative to the config file location.

**Note:** detailed configuration reference is [work in progress](https://github.com/hyperledger/iroha-2-docs/issues/392).
**Note:** detailed configuration reference is [work in progress](https://github.com/hyperledger-iroha/iroha-2-docs/issues/392).

### Scalability

Expand All @@ -186,21 +185,21 @@ The provided `docker-compose` file showcases a minimum viable network and the ge

## Further Reading

We encourage you to check out our [Iroha 2 Tutorial](https://hyperledger.github.io/iroha-2-docs/) first. It is suitable for both experienced developers and prospective users of Iroha 2, and it provides language-specific guides for Bash, Python, Rust, Kotlin/Java, and Javascript/TypeScript.
We encourage you to check out our [Iroha 2 Tutorial](https://docs.iroha.tech) first. It is suitable for both experienced developers and prospective users of Iroha 2, and it provides language-specific guides for Bash, Python, Rust, Kotlin/Java, and Javascript/TypeScript.

* [Iroha 2 Documentation](https://hyperledger.github.io/iroha-2-docs/)
* [Glossary](https://hyperledger.github.io/iroha-2-docs/guide/glossary)
* [Iroha Special Instructions](https://hyperledger.github.io/iroha-2-docs/guide/blockchain/instructions)
* [API Reference](https://hyperledger.github.io/iroha-2-docs/api/torii-endpoints)
* [Iroha 2 Documentation](https://docs.iroha.tech)
* [Glossary](https://docs.iroha.tech/reference/glossary.html)
* [Iroha Special Instructions](https://docs.iroha.tech/blockchain/instructions.html)
* [API Reference](https://docs.iroha.tech/reference/torii-endpoints.html)
<!-- * [Configuration Reference](./docs/source/references/config.md) -->
* [Iroha 2 Whitepaper](./docs/source/iroha_2_whitepaper.md)

Iroha SDKs:

* [Iroha Python](https://github.com/hyperledger/iroha-python)
* [Iroha Java](https://github.com/hyperledger/iroha-java)
* [Iroha Javascript](https://github.com/hyperledger/iroha-javascript)
* [Iroha iOS Swift](https://github.com/hyperledger/iroha-ios)
* [Iroha Python](https://github.com/hyperledger-iroha/iroha-python)
* [Iroha Java](https://github.com/hyperledger-iroha/iroha-java)
* [Iroha Javascript](https://github.com/hyperledger-iroha/iroha-javascript)
* [Iroha iOS Swift](https://github.com/hyperledger-iroha/iroha-ios)

## How to Contribute

Expand Down
4 changes: 2 additions & 2 deletions crates/iroha/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ categories.workspace = true
workspace = true

[badges]
is-it-maintained-issue-resolution = { repository = "https://github.com/hyperledger/iroha" }
is-it-maintained-open-issues = { repository = "https://github.com/hyperledger/iroha" }
is-it-maintained-issue-resolution = { repository = "https://github.com/hyperledger-iroha/iroha" }
is-it-maintained-open-issues = { repository = "https://github.com/hyperledger-iroha/iroha" }
maintenance = { status = "actively-developed" }

[features]
Expand Down
6 changes: 3 additions & 3 deletions crates/iroha/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This is the Iroha 2 client library crate. With it you can build your own client applications to communicate with peers in an Iroha 2 network via HTTP/WebSocket.

Follow the [Iroha 2 tutorial](https://hyperledger.github.io/iroha-2-docs/guide/rust.html) for instructions on how to set up, configure, and use the Iroha 2 client and client library.
Follow the [Iroha 2 tutorial](https://docs.iroha.tech/guide/tutorials/rust.html) for instructions on how to set up, configure, and use the Iroha 2 client and client library.

## Features

Expand All @@ -16,9 +16,9 @@ Follow the [Iroha 2 tutorial](https://hyperledger.github.io/iroha-2-docs/guide/r
Add the following to the manifest file of your Rust project:

```toml
iroha = { git = "https://github.com/hyperledger/iroha", branch = "main" }
iroha = { git = "https://github.com/hyperledger-iroha/iroha" }
```

## Examples

We highly recommend looking at the sample [`iroha`](../iroha_cli) implementation binary as well as our [tutorial](https://hyperledger.github.io/iroha-2-docs/guide/rust.html) for more examples and explanations.
We highly recommend looking at the sample [`iroha`](../iroha_cli) implementation binary as well as our [tutorial](https://docs.iroha.tech/guide/tutorials/rust.html) for more examples and explanations.
Loading

0 comments on commit 70e5aac

Please sign in to comment.