search

verifiablesoftware / vsw

Core project of VerifiableSoftware
Apache License 2.0
1 stars 0 forks source link

Basic documentation #108

Closed wenjing closed 3 years ago

wenjing commented 3 years ago

For clarity, I'm using this one issue to track the minimum documentation requirements. We have 3 parts:

The minimum documentation should have complete information on the following: (1) info for a developer For both vsw and vsw-repo, provide a step-by-step guide in the style of common "Getting Started" format, from setting up development environment, to source "git clone...", to actual testing. Please also include release procedures out to Pypi. (2) info for a user/tester For all vsw CLI, repo's scripts, etc. provide a concise description of commands, parameters etc. It's ok to use examples. (3) info for system operator/maintainer through CI/CD Describe how the CI/CD pipeline works and where the control knobs or configurations are.

Please do not post credential information or other sensitive information on github. Any format is ok. Use a diagram if that helps.

wenjing commented 3 years ago

Added release procedure to Pypi.

wenjing commented 3 years ago

The client vsw developer document is lacking developer environment setup. We need a procedure to start from basic OS (assuming nothing) and enable virtual environment for Python and install all necessary tools. MacOS is OK Alternatively, Ubuntu is also OK. But at lease one should be complete. The current document is only https://github.com/verifiablesoftware/vsw/blob/master/README.md which is insufficient.

wenjing commented 3 years ago

Basic level info is collected. Actual documentation should be produced later.