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

docs(connector-besu): add sequence diagram of run tx endpoint #755

Closed
petermetz opened this issue Mar 31, 2021 · 0 comments · Fixed by #774
Closed

docs(connector-besu): add sequence diagram of run tx endpoint #755

petermetz opened this issue Mar 31, 2021 · 0 comments · Fixed by #774
Assignees
@jagpreetsinghsasan
Labels
Besu documentation Improvements or additions to documentation

Comments

@petermetz
Copy link
Contributor

Description

As a contributor I want to have a sequence diagram about how the transaction endpoint works internally so that I have a shot at understanding it without having to deep dive into the actual code itself.

(add more description and relevant links)

Acceptance Criteria

  1. Use PlantUML
  2. Be not too detailed, but still include everything (there is no correct answer to this, just trying to hit the right balance and accepting that it will never be perfect)
  3. Include the sequence diagram in one of the sub-sections of the connector's README
  4. Make sure not to use external links but instead rely on locally stored png exports

cc: @takeutak @sfuji822 @hartm @jonathan-m-hamilton @AzaharaC @jordigiam @kikoncuo @jagpreetsinghsasan
@petermetz petermetz added Besu documentation Improvements or additions to documentation labels Mar 31, 2021
jagpreetsinghsasan added a commit to jagpreetsinghsasan/cactus that referenced this issue Apr 8, 2021
@jagpreetsinghsasan
feat(besu): add sequence diagram of run transaction endpoint
47a6696 
	Primary Change
	--------------

	1. Added plantuml diagrams and corresponding pngs to describe the run transaction endpoint and are located under cactus-plugin-ledger-connector-besu/docs/architecture
	2. Modified the Readme to incorporate the pngs created above.

Fixes hyperledger-cacti#755

Signed-off-by: Jagpreet Singh Sasan <[email protected]>
jagpreetsinghsasan added a commit to jagpreetsinghsasan/cactus that referenced this issue Apr 8, 2021
@jagpreetsinghsasan
feat(besu): add sequence diagram of run transaction endpoint
94ec843 
	Primary Change
	--------------

	1. Added plantuml diagrams and corresponding pngs to describe the run transaction endpoint and are located under cactus-plugin-ledger-connector-besu/docs/architecture
	2. Modified the Readme to incorporate the pngs created above.

Fixes hyperledger-cacti#755

Signed-off-by: Jagpreet Singh Sasan <[email protected]>
@jagpreetsinghsasan jagpreetsinghsasan mentioned this issue Apr 8, 2021
Merged
petermetz pushed a commit that referenced this issue Apr 12, 2021
@jagpreetsinghsasan @petermetz
feat(besu): add sequence diagram of run transaction endpoint
754a11a 
	Primary Change
	--------------

	1. Added plantuml diagrams and corresponding pngs to describe the run transaction endpoint and are located under cactus-plugin-ledger-connector-besu/docs/architecture
	2. Modified the Readme to incorporate the pngs created above.

Fixes #755

Signed-off-by: Jagpreet Singh Sasan <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jagpreetsinghsasan jagpreetsinghsasan

Labels
Besu documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat(besu): add sequence diagram of run transaction endpoint jagpreetsinghsasan/cactus
2 participants
@petermetz @jagpreetsinghsasan