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-fabric): add sequence diagram of run tx endpoint #756

Closed
jagpreetsinghsasan opened this issue Mar 31, 2021 · 1 comment · Fixed by #829
Closed

docs(connector-fabric): add sequence diagram of run tx endpoint #756

jagpreetsinghsasan opened this issue Mar 31, 2021 · 1 comment · Fixed by #829
Assignees
@jagpreetsinghsasan
Labels
Developer_Experience documentation Improvements or additions to documentation Fabric

Comments

@jagpreetsinghsasan
Copy link
Contributor

jagpreetsinghsasan commented Mar 31, 2021 •
edited
Loading

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 @petermetz
@petermetz petermetz added Developer_Experience documentation Improvements or additions to documentation Fabric labels Apr 7, 2021
@jagpreetsinghsasan
Copy link
Contributor Author

I am working on this

jagpreetsinghsasan added a commit to jagpreetsinghsasan/cactus that referenced this issue Apr 21, 2021
@jagpreetsinghsasan
feat(fabric): add sequence diagram of run transaction endpoint
4ca2eac 
	Primary Change
	--------------

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

Resolve hyperledger-cacti#756

Signed-off-by: Jagpreet Singh Sasan <jagpreet.singh.sasan@accenture.com>
@jagpreetsinghsasan jagpreetsinghsasan mentioned this issue Apr 21, 2021
Merged
petermetz pushed a commit that referenced this issue Apr 26, 2021
@jagpreetsinghsasan @petermetz
feat(fabric): add sequence diagram of run transaction endpoint
155cbab 
	Primary Change
	--------------

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

Resolve #756

Signed-off-by: Jagpreet Singh Sasan <jagpreet.singh.sasan@accenture.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jagpreetsinghsasan jagpreetsinghsasan

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

Successfully merging a pull request may close this issue.

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