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

Missing documentation how to connect to an existing blockchain network SP 1 #1046

Closed
1 task done
Stezido opened this issue Feb 14, 2022 · 3 comments · Fixed by #1550
Closed
1 task done

Missing documentation how to connect to an existing blockchain network SP 1 #1046

Stezido opened this issue Feb 14, 2022 · 3 comments · Fixed by #1550
Assignees
Labels
blockchain Indicates blockchain related issue or feature documentation Indicates a documentation issue

Comments

@Stezido
Copy link
Contributor

Stezido commented Feb 14, 2022

  • I have searched the issues of this repository and believe that this is not a duplicate.

Description 😯

In the official documenation of Trubudget there is an old version describing how to connect to a blockchain spinning up a slave node https://trubudget.net/docs/operation-administration/installation/connect-to-existing-node/connect-docker-compose

In the github documentation there is no documentation how to connect to a blockchain spinning up a slave node but there is a hidden section in the "create a new network" section: https://github.com/openkfw/TruBudget/blob/master/docs/operation-administration/installation/create-new-network/create-new-docker-compose.md#connect-to-an-existing-blockchain-network
This docu is NOT describing how to connect to an existing blockchain network but it's describing how to spin up a new network with 2 organizations connected.

The goal is to have 2 documentation sections synced with the Trubudget website and the github docu:

  1. Create a new network
  2. Connect to an existing network

Also the misleading doc section in "Create a new network" should be renamed to something like "Create a new network with 2 organizations".

@Stezido Stezido added the documentation Indicates a documentation issue label Feb 14, 2022
@issuelabeler issuelabeler bot added the blockchain Indicates blockchain related issue or feature label Feb 14, 2022
@stale
Copy link

stale bot commented Mar 16, 2022

This issue has been automatically marked as stale because it has not had activity for 30 days. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the wontfix This will not be worked on label Mar 16, 2022
@stale stale bot closed this as completed Mar 23, 2022
@Stezido Stezido reopened this Apr 6, 2022
@stale stale bot removed the wontfix This will not be worked on label Apr 6, 2022
@Stezido
Copy link
Contributor Author

Stezido commented Apr 6, 2022

we should also rethink our operation/dev environment and its documentation.
For devs it's docker-compose scripts are more useful and for external admins/operations the scripts would make more sense.

@Stezido
Copy link
Contributor Author

Stezido commented Apr 6, 2022

The .env_example file should not be used in any automated startup script.

@Stezido Stezido added this to the TruBudget 2.0.0 milestone May 3, 2022
@Stezido Stezido self-assigned this May 3, 2022
@Stezido Stezido changed the title Missing documentation how to connect to an existing blockchain network Missing documentation how to connect to an existing blockchain network SP 1 May 9, 2022
@Stezido Stezido mentioned this issue Jul 15, 2022
6 tasks
@egdmrsy egdmrsy self-assigned this Nov 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blockchain Indicates blockchain related issue or feature documentation Indicates a documentation issue
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants