aicoe-aiops / flake-qe

Other
0 stars 1 forks source link

Hand-off check/ Documentation Review #11

Open MichaelClifford opened 4 years ago

MichaelClifford commented 4 years ago

As a team of data scientists, we want to maker sure we know and and are executing on the best practices around documentation and reproducibility. To that end, @Shreyanand will look at the existing repo and identify any documentation gaps @MichaelClifford needs to fill to make the work reproducible based on documentation alone.

Acceptance Criteria:

Shreyanand commented 4 years ago

@MichaelClifford Should we add documentation regarding the diff/sim with the cockpit tool and the testgrid tool flake analysis so that anyone following this doesn't spend time comparing all these?

MichaelClifford commented 4 years ago

Sure, thats sounds like a good idea @Shreyanand, do you want to add it directly to the README or create a separate document?