Sample documents outdated

[lukpueh]

Most of the sample documents in this repo are outdated. See, eg.

• Fix publishing of coverage results to coveralls.io (+ misc test config updates) theupdateframework/python-tuf#890, Fix failing Python 3.4 Travis builds + general ci/cd enhancements uptane/obsolete-reference-implementation#195, Slighlty optimize tox builds and coverage measurement in-toto/in-toto#295 and Fix publishing of coverage results to coveralls.io (+ misc test config updates) securesystemslib#171 for important fixes related to automated testing with travis and tox and code coverage measurement
• Revise pylint configuration and fix code in-toto/in-toto#296 for a massive overhaul of the pylint config file
• Revise dependency handling in-toto/in-toto#294 for a new way of doing dependency monitoring
• Add fossa cli config for license scanning theupdateframework/python-tuf#892 for automated license scanning
• GitHub's issue and PR template guide for a new way of providing these templates (not yet adopted by any of our projects).

We should either keep the documents here up-to-date, or replace them with pointers to our most mature projects (i.e. TUF/in-toto). A mix of both is conceivable as well, i.e. add a disclaimer (or strengthen the existing one) that up-to-date sample documents can be found in above mentioned repos, while also syncing the docs here every now and then.

Any thoughts, @JustinCappos, @SantiagoTorres, @mnm678?

[JustinCappos]

We should really be porting these over and asking folks who improve a project docs to also put them in SSL. Maybe this is something we can get one our interns to do a PR on?

…

On Wed, Jul 17, 2019 at 4:00 AM lukpueh ***@***.***> wrote: Most of the sample documents in this repo are outdated. See, eg. - theupdateframework/python-tuf#890 <theupdateframework/python-tuf#890>, uptane/obsolete-reference-implementation#195 <uptane/obsolete-reference-implementation#195>, in-toto/in-toto#295 <in-toto/in-toto#295> and secure-systems-lab/securesystemslib#171 <secure-systems-lab/securesystemslib#171> for important fixes related to automated testing with *travis* and *tox* and code *coverage* measurement - in-toto/in-toto#296 <in-toto/in-toto#296> for a massive overhaul of the *pylint* config file - in-toto/in-toto#294 <in-toto/in-toto#294> for a new way of doing *dependency monitoring* - theupdateframework/python-tuf#892 <theupdateframework/python-tuf#892> for automated *license scanning* - GitHub's issue and PR template guide <https://help.github.com/en/articles/about-issue-and-pull-request-templates> for a new way of providing these *templates* (not yet adopted by any of our projects). We should either keep the documents here up-to-date, or replace them with pointers to our most mature projects (i.e. TUF/in-toto). A mix of both is conceivable as well, i.e. add a disclaimer (or strengthen the existing one) that up-to-date sample documents can be found in above mentioned repos, while also syncing the docs here every now and then. Any thoughts, @JustinCappos <https://github.com/JustinCappos>, @SantiagoTorres <https://github.com/SantiagoTorres>, @mnm678 <https://github.com/mnm678>? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#6?email_source=notifications&email_token=AAGROD2C7DMGTGUIKFM45WLP73GSBA5CNFSM4IENSXN2YY3PNVWWK3TUL52HS4DFUVEXG43VMWVGG33NNVSW45C7NFSM4G7VBYPA>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAGROD4YX5DSAKSDFABMC7DP73GSBANCNFSM4IENSXNQ> .