eric/onix
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix user guide language

Browse Source
This commit is contained in:
Venkatesh Babu
2024-04-19 07:37:25 +05:30
parent 8cb8576078
commit e7a9ae19e5
5 changed files with 4 additions and 44 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@@ -7,7 +7,7 @@ Within the install folder you will find a `beckn-onix.sh` file which is an insta
Refer to the following documents for more information:
- [User Guide](./docs/user_guide.md)
- [Step by step walkthrough of a demo installation](./docs/demo_walkthrough.md)
- [Step by step walkthrough of a setup](./docs/setup_walkthrough.md)
- [Frequently asked questions (FAQ)](./docs/faq.md)
- [release notes](./install/RELEASE.md)

2
docs/demo_scenarios.md
View File

@@ -1,6 +1,6 @@
## Introduction
The [demo walkthrough](../docs/demo_walkthrough.md) and the accompanying video shows a story where we have the following steps
The [setup walkthrough](../docs/setup_walkthrough.md) and the accompanying video shows a story where we have the following steps
1. We install a core Beckn network using Beckn-ONIX
2. We try to conduct a retail transaction, but it fails due to layer 2 config not being present

36
docs/demo_walkthrough.md → docs/setup_walkthrough.md
View File

@@ -87,19 +87,9 @@ Which platform would you like to set up?
Enter your choice: 1
```
- Skip the option to apply network configuration
```
Proceeding with the setup for Registry...
Please provide the network-specific configuration URL.
Paste the URL of the network configuration here (or press Enter to skip):
```
- Input the host name where the registry will reside as https://onix-registry.becknprotocol.io
```
No network configuration URL provided, proceeding without it.
Enter publicly accessible registry URL: https://onix-registry.becknprotocol.io
```
@@ -167,19 +157,9 @@ Which platform would you like to set up?
Enter your choice: 1
```
- Skip the option to apply network configuration
```
Proceeding with the setup for Gateway...
Please provide the network-specific configuration URL.
Paste the URL of the network configuration here (or press Enter to skip):
```
- Input the URL of the registry we just now installed https://onix-registry.becknprotocol.io
```
No network configuration URL provided, proceeding without it.
Enter your registry URL: https://onix-registry.becknprotocol.io
```
@@ -252,14 +232,6 @@ Which platform would you like to set up?
Enter your choice: 2
```
- Skip the option to apply network configuration
```
Proceeding with the setup for BAP...
Please provide the network-specific configuration URL.
Paste the URL of the network configuration here (or press Enter to skip):
```
- Input the BAP subscriber id - onix-bap.becknprotocol.io
- Input the BAP URL - https://onix-bap.becknprotocol.io
- Input the subscription endpoint of the registry - https://onix-registry.becknprotocol.io/subscribers
@@ -347,14 +319,6 @@ Which platform would you like to set up?
Enter your choice: 3
```
- Skip the option to apply network configuration
```
Proceeding with the setup for BPP...
Please provide the network-specific configuration URL.
Paste the URL of the network configuration here (or press Enter to skip):
```
- Input BPP subscriber id as onix-bpp.becknprotocol.io
- Input the BPP URL as https://onix-bpp.becknprotocol.io
- Input the registry URL to subscribe as https://onix-registry.becknprotocol.io/subscribers

4
docs/user_guide.md
View File

@@ -63,7 +63,6 @@ In the Beckn ecosystem, a new network starts with the setting up of the Registry
- Change into the installation folder `cd beckn-onix/install`
- Run the installation script `./beckn-onix.sh`
- Specify you want to start a new network and install the registry
- Skip the apply network configuration option
- Enter the publicly accessible address of the registry (e.g. https://onix-registry.becknprotocol.io)
- The registry installation will continue to completion.
@@ -85,7 +84,6 @@ In the Beckn ecosystem, the role of the Gateway is limited to the discovery phas
- Change into the installation folder `cd beckn-onix/install`
- Run the installation script `./beckn-onix.sh`
- Specify you want to join an existing network and install the gateway
- Skip the apply network configuration option
- Enter the address of the registry of the network you want to join (e.g. https://onix-registry.becknprotocol.io)
- Enter the publicly accessible address of the gateway (e.g. https://onix-gateway.becknprotocol.io)
- The gateway installation will continue to completion and it will register itself with the registry as a participant with role BG(Beckn Gateway)
@@ -110,7 +108,6 @@ The BAP (Beckn Application Platform) is the bridge between buyer side applicatio
- Change into the installation folder `cd beckn-onix/install`
- Run the installation script `./beckn-onix.sh`
- Specify you want to join an existing network and install the BAP.
- Skip the apply network configuration option
- Enter the Subscriber id for the BAP. When setting up a new network, its value can be anything you want. However it is recommended to have it the same as the BAP URL without the https:// part (e.g. onix-bap.becknprotocol.io). In existing networks this might be further validated for uniqueness by the registry.
- Enter the Subscriber URI for the BAP. This is the network endpoint of the BAP Beckn Adapter. (e.g. https://onix-bap.becknprotocol.io)
- Enter the address of the subscription endpoint of the registry of the network you want to join (e.g. https://onix-registry.becknprotocol.io/subscribers). Note the suffix subscribers in the endpoint address.
@@ -136,7 +133,6 @@ The BPP (Beckn Provider Platform) is the bridge between the seller side applicat
- Change into the installation folder `cd beckn-onix/install`
- Run the installation script `./beckn-onix.sh`
- Specify you want to join an existing network and install the BPP.
- Skip the apply network configuration option
- Enter the Subscriber id for the BPP. When setting up a new network, its value can be anything you want. However it is recommended to have it the same as the BPP URL without the https:// part (e.g. onix-bpp.becknprotocol.io). In existing networks this might be further validated for uniqueness by the registry.
- Enter the Subscriber URL for the BPP (e.g. https://onix-bpp.becknprotocol.io). This is the network endpoint of the BPP Beckn Adapter.
- Enter the webhook URL. This is the endpoint on your custom market place or headless shop which will receive Beckn requests. The endpoint usually contains the address of the market place or shop as a substring. (e.g. https://unified-bpp.becknprotocol.io/beckn-bpp-adapter)

4
layer2/docs/demo_healthcare.md
View File

@@ -4,7 +4,7 @@
[Beckn](https://becknprotocol.io/) as a protocol allows creation of decentralised commerce network across many domains. Healthcare is one of them. Beckn-ONIX is a project aimed at easing setup and maintanence of Beckn network for different domains. It provides utilities to quickly setup the core Beckn network as well as provides tools to enable domain specific transactions. The latter is achieved through the use of layer 2 configuration files.
The [Beckn-ONIX User Guide](./user_guide.md) provides an overall understanding of setup of the core Beckn network as well as download and ingestion of Layer 2 configuration files. The [step by step demo](./demo_walkthrough.md) walks through one such installation in great detail. The layer 2 configurations illustrated in that demo belong to the retail and energy domain.
The [Beckn-ONIX User Guide](./user_guide.md) provides an overall understanding of setup of the core Beckn network as well as download and ingestion of Layer 2 configuration files. The [step by step setup](./setup_walkthrough.md) walks through one such installation in great detail. The layer 2 configurations illustrated in that demo belong to the retail and energy domain.
## Healthcare usecases on Beckn network
@@ -27,7 +27,7 @@ A sample of the usecases that can be imagined on Beckn networks include
## Setting up Beckn network for healthcare usecases
Setting up of a network for healthcare related use cases follows the same steps as illustrated in the [step by step demo](./demo_walkthrough.md) document. The primary differences is the layer 2 configuration file downloaded will be specific to healthcare and suited to conduct healthcare transactions. A sample layer 2 config for healthcare is available in the beckn_onix/layer2/samples folder and its path can be provided when running download_layer_2_config_bap.sh and download_layer_2_config_bpp.sh. If you are joining a network administered by a network facilitator, they might have a different layer 2 config and that should be used instead of the sample.
Setting up of a network for healthcare related use cases follows the same steps as illustrated in the [step by step setup](./setup_walkthrough.md) document. The primary differences is the layer 2 configuration file downloaded will be specific to healthcare and suited to conduct healthcare transactions. A sample layer 2 config for healthcare is available in the beckn_onix/layer2/samples folder and its path can be provided when running download_layer_2_config_bap.sh and download_layer_2_config_bpp.sh. If you are joining a network administered by a network facilitator, they might have a different layer 2 config and that should be used instead of the sample.
The following is a conceptual view of core and layer 2 config from a perspective of validation
![Validation in Beckn Adaptor](./images/message_validation_in_ba.png)