Skip to content

Conversation

@kellpossible
Copy link

@kellpossible kellpossible commented May 15, 2021

A detailed requirements specification for phase1-coordinator module.

@kellpossible kellpossible changed the title started a more detailed specification of the product requirements a more detailed specification of the aleo-setup phase1-coordinator requirements May 15, 2021
@apruden2008
Copy link

Can you elaborate on this, and specifically describe what we need to add to this document: https://docs.google.com/document/d/1Vyg2J60zRU6023KXBjZx8CP3V-Nz6hPOUCMplbCxVB4/edit?usp=sharing

@apruden2008 apruden2008 added the documentation Improvements or additions to documentation label May 16, 2021
@apruden2008 apruden2008 self-assigned this May 16, 2021
@kellpossible
Copy link
Author

kellpossible commented May 16, 2021

Can you elaborate on this, and specifically describe what we need to add to this document: https://docs.google.com/document/d/1Vyg2J60zRU6023KXBjZx8CP3V-Nz6hPOUCMplbCxVB4/edit?usp=sharing

@apruden2008 I've referenced that document in this document. I see that document as a high level overview of the requirements for the ceremony as a whole, including contributors and verifier software. Even so, it is lacking in specific and traceable requirements. This document attempts to document only the specific requirements for phase1-coordinator module (not including the aleo-setup-coordinator web server), in a manner that we can reference and trace to tests. By having these requirements in source control we can also easily track their changes associated with changes to our codebase. I've written them in markdown because it is accessible to everyone, but the format is consistent such that we could easily analyze it in the future to extract information.

We could probably move some of the definitions out to a higher level document such as the one you mention, especially those which are not specific to this module.

@kellpossible kellpossible marked this pull request as ready for review June 27, 2021 14:43
@kellpossible
Copy link
Author

It would be nice to get this merged at some point or relocated to somewhere more visible

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants