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.

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

docs: change github org from hyperledger to hyperledger-cacti #3579

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,16 +29,16 @@ First things first, please review the [Hyperledger Code of Conduct](https://wiki
There are many ways to contribute to Hyperledger Cacti, both as a user and as a developer.

As a user, this can include:
* [Making Feature/Enhancement Proposals](https://github.com/hyperledger/cacti/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=)
* [Reporting bugs](https://github.com/hyperledger/cacti/issues/new?assignees=&labels=bug&template=bug_report.md&title=)
* [Making Feature/Enhancement Proposals](https://github.com/hyperledger-cacti/cacti/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=)
* [Reporting bugs](https://github.com/hyperledger-cacti/cacti/issues/new?assignees=&labels=bug&template=bug_report.md&title=)

As a developer:
* if you only have a little time, consider picking up a [“help-wanted”](https://github.com/hyperledger/cacti/labels/help%20wanted) or ["good-first-issue"](https://github.com/hyperledger/cacti/labels/good%20first%20issue) task
* if you only have a little time, consider picking up a [“help-wanted”](https://github.com/hyperledger-cacti/cacti/labels/help%20wanted) or ["good-first-issue"](https://github.com/hyperledger-cacti/cacti/labels/good%20first%20issue) task
* If you can commit to full-time development, then please contact us on our [Discord channel](https://discord.com/channels/905194001349627914/908379338716631050) to work through logistics!

We welcome contributions to this project in many forms, whether it is to fix a bug, improve the documentation, add a new feature, or add support for any new DLT platform.

Please familiarize yourself with the [documentation](https://hyperledger.github.io/cacti/). In particular, review the [vision and design methodology](https://hyperledger.github.io/cacti/vision/) and [system architecture](https://hyperledger.github.io/cacti/architecture/). Follow the tutorial instructions to test the [Cactus](https://hyperledger.github.io/cacti/cactus/introduction/) and [Weaver](https://hyperledger.github.io/cacti/weaver/introduction/) features respectively. (For a deeper understanding of the Weaver design and specifications, also check out the [Weaver RFCs](https://github.com/hyperledger/cacti/tree/main/weaver/rfcs).)
Please familiarize yourself with the [documentation](https://hyperledger-cacti.github.io/cacti/). In particular, review the [vision and design methodology](https://hyperledger-cacti.github.io/cacti/vision/) and [system architecture](https://hyperledger-cacti.github.io/cacti/architecture/). Follow the tutorial instructions to test the [Cactus](https://hyperledger-cacti.github.io/cacti/cactus/introduction/) and [Weaver](https://hyperledger-cacti.github.io/cacti/weaver/introduction/) features respectively. (For a deeper understanding of the Weaver design and specifications, also check out the [Weaver RFCs](https://github.com/hyperledger-cacti/cacti/tree/main/weaver/rfcs).)

## Git Know How / Reading List

Expand Down
2 changes: 1 addition & 1 deletion README-cactus.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Once the last command has finished executing, open link printed on the console w
## Documentation

* [Project Wiki](https://wiki.hyperledger.org/display/cactus): Schedule and logs of the maintainer meetings
* [Understanding and Using](https://hyperledger.github.io/cacti/cactus/introduction/): Description of components and instructions for usage and testing
* [Understanding and Using](https://hyperledger-cacti.github.io/cacti/cactus/introduction/): Description of components and instructions for usage and testing
* [Whitepaper](./whitepaper/whitepaper.md): The official document on Cactus design specifications (_Note_: this is deprecated. We are working on a new version.)
* [Contributing](./CONTRIBUTING.md): How to get from an idea to an approved pull request
* [Build](./BUILD.md): Instructions on how to set up the project for development
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ The current Cacti code base contains the legacy Cactus and Weaver source code in

## Documentation

See the official [Hyperledger Cacti documentation](https://hyperledger.github.io/cacti/) to get all your questions answered about the project, to get started with setup, testing, and evaluation, and to get hands-on with code and configurations. Here, you can find separate (and specific) instructions for getting started with running and experimenting with [Cactus modules](https://hyperledger.github.io/cacti/cactus/introduction/) and [Weaver modules](https://hyperledger.github.io/cacti/weaver/introduction/) respectively.
See the official [Hyperledger Cacti documentation](https://hyperledger-cacti.github.io/cacti/) to get all your questions answered about the project, to get started with setup, testing, and evaluation, and to get hands-on with code and configurations. Here, you can find separate (and specific) instructions for getting started with running and experimenting with [Cactus modules](https://hyperledger-cacti.github.io/cacti/cactus/introduction/) and [Weaver modules](https://hyperledger-cacti.github.io/cacti/weaver/introduction/) respectively.

## Roadmap

Expand Down
2 changes: 1 addition & 1 deletion RELEASE_MANAGEMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ yarn build:dev

- Do note the `.` as the last parameter in last two commands.

- The `./tools/weaver-update-version.sh` automation script seems slightly buggy at the moment so you'll have to manually update `./weaver/core/relay/Cargo.toml` yourself. See this comment for an example: https://github.com/hyperledger/cacti/pull/3427#discussion_r1686850372
- The `./tools/weaver-update-version.sh` automation script seems slightly buggy at the moment so you'll have to manually update `./weaver/core/relay/Cargo.toml` yourself. See this comment for an example: https://github.com/hyperledger-cacti/cacti/pull/3427#discussion_r1686850372

- Double check that all of the package dependencies were updated from the previous
version to the new one because lerna usually fails to do that for `devDependency` parts
Expand Down
10 changes: 5 additions & 5 deletions docs/docs/cactus/ledger-browser/developer-guide/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ Currently, applications must be included in the ledger-browser source code and b
## Guidelines

- Use React functional components.
- Use TypeScript and adhere to the [global Cacti linter requirements](https://github.com/hyperledger/cacti/blob/main/.eslintrc.js).
- Whenever possible, utilize [MaterialUI](https://mui.com/) and [common UI components](https://github.com/hyperledger/cacti/tree/main/packages/cacti-ledger-browser/src/main/typescript/components/ui).
- Use [PageTitle](https://github.com/hyperledger/cacti/tree/main/packages/cacti-ledger-browser/src/main/typescript/components/ui/PageTitle.tsx) as main page title.
- Use [PageTitleWithGoBack](https://github.com/hyperledger/cacti/tree/main/packages/cacti-ledger-browser/src/main/typescript/components/ui/PageTitleWithGoBack.tsx) as subpage title (it has arrow attached for going back).
- Use [NotificationContext](https://github.com/hyperledger/cacti/blob/main/packages/cacti-ledger-browser/src/main/typescript/common/context/NotificationContext.tsx) for displaying Pop-Up windows with notifications (info, success, error, etc..).
- Use TypeScript and adhere to the [global Cacti linter requirements](https://github.com/hyperledger-cacti/cacti/blob/main/.eslintrc.js).
- Whenever possible, utilize [MaterialUI](https://mui.com/) and [common UI components](https://github.com/hyperledger-cacti/cacti/tree/main/packages/cacti-ledger-browser/src/main/typescript/components/ui).
- Use [PageTitle](https://github.com/hyperledger-cacti/cacti/tree/main/packages/cacti-ledger-browser/src/main/typescript/components/ui/PageTitle.tsx) as main page title.
- Use [PageTitleWithGoBack](https://github.com/hyperledger-cacti/cacti/tree/main/packages/cacti-ledger-browser/src/main/typescript/components/ui/PageTitleWithGoBack.tsx) as subpage title (it has arrow attached for going back).
- Use [NotificationContext](https://github.com/hyperledger-cacti/cacti/blob/main/packages/cacti-ledger-browser/src/main/typescript/common/context/NotificationContext.tsx) for displaying Pop-Up windows with notifications (info, success, error, etc..).
- App routes are defined using [react-router-dom](https://reactrouter.com/en/main).
- Use [react-query](https://tanstack.com/query/v3) for fetching data, `QueryClientProvider` is already available in the application.
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This page presents different patterns that some plugin applications follow. Whil

## Browser App / Persistence Plugin Apps

These applications rely heavily on the existence of Cacti persistence plugins, such as [cactus-plugin-persistence-ethereum](https://github.com/hyperledger/cacti/tree/main/packages/cactus-plugin-persistence-ethereum) or [cactus-plugin-persistence-fabric](https://github.com/hyperledger/cacti/tree/main/packages/cactus-plugin-persistence-fabric).
These applications rely heavily on the existence of Cacti persistence plugins, such as [cactus-plugin-persistence-ethereum](https://github.com/hyperledger-cacti/cacti/tree/main/packages/cactus-plugin-persistence-ethereum) or [cactus-plugin-persistence-fabric](https://github.com/hyperledger-cacti/cacti/tree/main/packages/cactus-plugin-persistence-fabric).

As the name suggests, persistence plugins store the ledger state in an SQL database (e.g., PostgreSQL managed by Supabase). They synchronize all blocks, transactions, token operations, etc., into the database for later use and push new data as it arrives.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,13 @@ Additionally, you'll need a `PostgreSQL connection string` to start the persiste

##### Expose custom schema

Fabric data is stored in a custom schema named `ethereum`. To access this data from our GUI application, you need to ensure the schema is exposed. If you're using our [supabase-all-in-one](https://github.com/hyperledger/cacti/tree/main/tools/docker/supabase-all-in-one) image, all application schemas, including `ethereum`, are already exposed, so you can skip this step. However, if you're using Supabase Cloud, you'll need to go to the [API settings](https://supabase.com/dashboard/project/_/settings/api) and add `ethereum` to the `Exposed schemas` list.
Fabric data is stored in a custom schema named `ethereum`. To access this data from our GUI application, you need to ensure the schema is exposed. If you're using our [supabase-all-in-one](https://github.com/hyperledger-cacti/cacti/tree/main/tools/docker/supabase-all-in-one) image, all application schemas, including `ethereum`, are already exposed, so you can skip this step. However, if you're using Supabase Cloud, you'll need to go to the [API settings](https://supabase.com/dashboard/project/_/settings/api) and add `ethereum` to the `Exposed schemas` list.

For more details, refer to [the full guide on custom schemas](https://supabase.com/docs/guides/api/using-custom-schemas) (note that the necessary SQL code has already been executed during the persistence plugin schema setup).

#### Ethereum Ledger (Optional)

This step is optional as you can use any running Ethereum ledger. However, for testing purposes, you may use our [geth-all-in-one](https://github.com/hyperledger/cacti/tree/main/tools/docker/geth-all-in-one). To start it, execute the following commands from the root of your project:
This step is optional as you can use any running Ethereum ledger. However, for testing purposes, you may use our [geth-all-in-one](https://github.com/hyperledger-cacti/cacti/tree/main/tools/docker/geth-all-in-one). To start it, execute the following commands from the root of your project:

```shell
# Build
Expand All @@ -40,7 +40,7 @@ docker run --rm --name geth_aio_testnet --detach -p 8545:8545 -p 8546:8546 cactu

### Persistence Plugin

Follow the instructions in the [plugin README file](https://github.com/hyperledger/cacti/tree/main/packages/cactus-plugin-persistence-ethereum).
Follow the instructions in the [plugin README file](https://github.com/hyperledger-cacti/cacti/tree/main/packages/cactus-plugin-persistence-ethereum).

To quickly set up the plugin for your Ethereum ledger, run the sample setup script:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,13 @@ Additionally, you'll need a `PostgreSQL connection string` to start the persiste

##### Expose custom schema

Fabric data is stored in a custom schema named `fabric`. To access this data from our GUI application, you need to ensure the schema is exposed. If you're using our [supabase-all-in-one](https://github.com/hyperledger/cacti/tree/main/tools/docker/supabase-all-in-one) image, all application schemas, including `fabric`, are already exposed, so you can skip this step. However, if you're using Supabase Cloud, you'll need to go to the [API settings](https://supabase.com/dashboard/project/_/settings/api) and add `fabric` to the `Exposed schemas` list.
Fabric data is stored in a custom schema named `fabric`. To access this data from our GUI application, you need to ensure the schema is exposed. If you're using our [supabase-all-in-one](https://github.com/hyperledger-cacti/cacti/tree/main/tools/docker/supabase-all-in-one) image, all application schemas, including `fabric`, are already exposed, so you can skip this step. However, if you're using Supabase Cloud, you'll need to go to the [API settings](https://supabase.com/dashboard/project/_/settings/api) and add `fabric` to the `Exposed schemas` list.

For more details, refer to [the full guide on custom schemas](https://supabase.com/docs/guides/api/using-custom-schemas) (note that the necessary SQL code has already been executed during the persistence plugin schema setup).

#### Fabric Ledger (Optional)

This step is optional as you can use any running Fabric ledger. However, for testing purposes, you may use our [fabric-all-in-one](https://github.com/hyperledger/cacti/tree/main/tools/docker/fabric-all-in-one). To start it, execute the following commands from the root of your project:
This step is optional as you can use any running Fabric ledger. However, for testing purposes, you may use our [fabric-all-in-one](https://github.com/hyperledger-cacti/cacti/tree/main/tools/docker/fabric-all-in-one). To start it, execute the following commands from the root of your project:

```shell
# Build
Expand All @@ -39,7 +39,7 @@ docker run --detach --privileged --publish-all --name faio2x-testnet faio2x

### Persistence Plugin

Follow the instructions in the [plugin README file](https://github.com/hyperledger/cacti/tree/main/packages/cactus-plugin-persistence-fabric).
Follow the instructions in the [plugin README file](https://github.com/hyperledger-cacti/cacti/tree/main/packages/cactus-plugin-persistence-fabric).

To quickly set up the plugin for your Fabric ledger, run the complete setup script:

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/cactus/whitepaper.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Hyperledger Cactus White Paper
======================================================================================

The white paper is presently undergoing a revision. Please visit the [repository](https://github.com/hyperledger/cacti/blob/main/whitepaper/whitepaper.md) for updates.
The white paper is presently undergoing a revision. Please visit the [repository](https://github.com/hyperledger-cacti/cacti/blob/main/whitepaper/whitepaper.md) for updates.

[Previous](contributing.md "Contributing") [Next](regulatory-and-industry-initiatives-reading-list.md "Regulatory and Industry Initiatives Reading List")

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/contact-us.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ You can contact us or seek help through the following channels:
* Cacti contributors: [https://discord.com/channels/905194001349627914/908379338716631050](https://discord.com/channels/905194001349627914/908379338716631050)
* Hyperledger: [https://discord.com/invite/hyperledger](https://discord.com/invite/hyperledger)

The maintainers are [listed](https://github.com/hyperledger/cacti/blob/main/MAINTAINERS.md) in the GitHub repository.
The maintainers are [listed](https://github.com/hyperledger-cacti/cacti/blob/main/MAINTAINERS.md) in the GitHub repository.
2 changes: 1 addition & 1 deletion docs/docs/contributing/how-to-contribute.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# How to Contribute

The Hyperledger Cacti repository contains [specific instructions](https://github.com/hyperledger/cacti/blob/main/CONTRIBUTING.md) for contributing to that project.
The Hyperledger Cacti repository contains [specific instructions](https://github.com/hyperledger-cacti/cacti/blob/main/CONTRIBUTING.md) for contributing to that project.

In this section, you will find generic instructions and guidelines for contributing to any Hyperledger project.

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/contributing/reporting-a-bug.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ When reporting an issue, please provide as much detail as possible about how to
* Actual results
* Expected results

[issue tracker]: https://github.com/hyperledger/cacti/issues
[issue tracker]: https://github.com/hyperledger-cacti/cacti/issues
2 changes: 1 addition & 1 deletion docs/docs/contributing/requesting-a-change.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This guide is our best effort to explain the criteria and reasoning behind our
decisions when evaluating change requests and considering them for
implementation.

[issue tracker]: https://github.com/hyperledger/cacti/issues
[issue tracker]: https://github.com/hyperledger-cacti/cacti/issues

## Before creating an issue

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ Client libraries and examples are provided in the following languages: JavaScrip

* [Vision](./vision.md)
* [Architecture](./architecture.md)
* [Cactus whitepaper](https://github.com/hyperledger/cacti/blob/main/whitepaper/whitepaper.md)
* [Weaver RFCs](https://github.com/hyperledger/cacti/tree/main/weaver/rfcs)
* [Cactus whitepaper](https://github.com/hyperledger-cacti/cacti/blob/main/whitepaper/whitepaper.md)
* [Weaver RFCs](https://github.com/hyperledger-cacti/cacti/tree/main/weaver/rfcs)
* [Running pipelines with Cactus packages](./cactus/)
* [Running pipelines with Weaver packages](./weaver/)
* [Open API Specifications](./references/openapi/index.md)
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/references/specs.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

The two legacy projects that Cacti is comprised of have independent sets of design and interface specifications, including examples of usage, as follows:

- **Cactus**: See the official [Cactus whitepaper](https://github.com/hyperledger/cacti/tree/main/whitepaper/whitepaper.md) for technical designs and usage.
- **Weaver**: See the official [Weaver RFCs](https://github.com/hyperledger/cacti/tree/main/weaver/rfcs/) for technical designs and interface specifications.
- **Cactus**: See the official [Cactus whitepaper](https://github.com/hyperledger-cacti/cacti/tree/main/whitepaper/whitepaper.md) for technical designs and usage.
- **Weaver**: See the official [Weaver RFCs](https://github.com/hyperledger-cacti/cacti/tree/main/weaver/rfcs/) for technical designs and interface specifications.

!!! note

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/use-cases.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Use Cases and Applications for Cacti

This page is under construction. While we are working on it, you can find compelling examples and sample code [here](https://github.com/hyperledger/cacti/blob/main/whitepaper/whitepaper.md), [here](./weaver/user-stories/), [here](https://github.com/hyperledger/cacti/tree/main/examples), and [here](https://github.com/hyperledger/cacti/tree/main/weaver/samples).
This page is under construction. While we are working on it, you can find compelling examples and sample code [here](https://github.com/hyperledger-cacti/cacti/blob/main/whitepaper/whitepaper.md), [here](./weaver/user-stories/), [here](https://github.com/hyperledger-cacti/cacti/tree/main/examples), and [here](https://github.com/hyperledger-cacti/cacti/tree/main/weaver/samples).
2 changes: 1 addition & 1 deletion docs/docs/vision.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ The present (initial) version of the Cacti code base is simply an aggregation of

## Project Roadmap

You can find the project roadmap in the [GitHub repository](https://github.com/hyperledger/cacti/blob/main/ROADMAP.md).
You can find the project roadmap in the [GitHub repository](https://github.com/hyperledger-cacti/cacti/blob/main/ROADMAP.md).
Loading
Loading