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.

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

Add living user documentation generated from tests #107

Closed
o-orand opened this issue Mar 19, 2018 · 3 comments
Closed

Add living user documentation generated from tests #107

o-orand opened this issue Mar 19, 2018 · 3 comments

Comments

@o-orand
Copy link
Member

o-orand commented Mar 19, 2018

As a paas-template author, in order to use COA features, I need an accurate, up-to-date documentation with examples of syntax I can copy/paste.

The living documentation BDD practice may be helpful here. See https://prezi.com/hzxuat_opltx/turning-tests-into-documentation/ and related video for background (similar in Specs by Example methodology).

The current Rspec tests are primarily targetted towards COA contributors.

  • Rspec test results may be published as documentation to better assess how useful they can be to paas-template authors.
  • Maybe we can use RSpec HTML Reporter to have nicer reports

Specific tests/documentation targetted towards COA users may leverage specific bdd tooling/framework such as cucumbern which may ease consumption by COA users.

Note: It could be nice to finalize, code climate setup, to have code coverage. This may deserve its own issue.

@gberche-orange
Copy link
Member

gberche-orange commented May 9, 2018

@poblin-orange 's suggestion to inspire on format from https://github.com/deepmind/kapitan

@o-orand
Copy link
Member Author

o-orand commented May 15, 2018

We could also list all secrets required by generated pipelines to help users to setup concourse vars_files or credhub

@o-orand
Copy link
Member Author

o-orand commented Jul 11, 2018

closed by PR #149

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

No branches or pull requests

3 participants