docs: add documentation for multi-repository demo#60
Conversation
Fixes gittuf#58 Signed-off-by: Nishanth2969 <kananth2018@gmail.com>
yongjae354
left a comment
yongjae354
left a comment
There was a problem hiding this comment.
Hey @Nishanth2969 , thanks for the PR!
I think it might be worth separating this demo out to its own document?
patzielinski
left a comment
patzielinski
left a comment
There was a problem hiding this comment.
Following up on what @yongjae354 said, I think it's best if we have another .md file that contains the instructions for running the multi-repository demo, in a similar format to the regular README.md. So, this would mean taking the text you've added and just moving it to a new .md file, and also adding the commands into the .md file as is with the regular README.md file.
patzielinski
force-pushed
the
doc-multi-repo
branch
2 times, most recently
from
f01fd7c to
b65404c
Compare
patzielinski
requested review from
adityasaky and
yongjae354
and removed request for
yongjae354
|
I've pushed a restructure of the demo repository to this PR. Each demo is now contained in its own Python and Markdown files. Currently, we have two demos with this PR: the basic functionality demo and the multi-repository demo, but we have a delegation demo with #59, and we can also add a multi-party approval demo as well. |
Signed-off-by: Pat Zielinski <git@patzielinski.com>
patzielinski
force-pushed
the
doc-multi-repo
branch
from
b65404c to
93d2a65
Compare
patzielinski
left a comment
patzielinski
left a comment
There was a problem hiding this comment.
Approving this to move the PR backlog on the demo along...
4 participants
This PR adds documentation for the multi-repository demo script, explaining what it does and how to use it.
Fixes #58