HumanCellAtlas / secondary-analysis

Secondary Analysis Service of the Human Cell Atlas Data Coordination Platform
https://pipelines.data.humancellatlas.org/ui/
BSD 3-Clause "New" or "Revised" License
3 stars 2 forks source link

Move SS2 Pipeline Documentation to live near Pipeline #787

Closed kbergin closed 5 years ago

kbergin commented 5 years ago

Why:﹍ We decided as a team we would keep our pipeline documentation near the pipeline in a readme. We then moved the Optimus documentation as we wanted (see here)

Where to start:﹍ The SS2 documentation still lives in this wiki page. Let’s move it into a readme.

AC:

NOTE:﹍ If this becomes more than a “snack”, we’re almost certainly beyond scope.

┆Issue is synchronized with this Jira Dev Task

kbergin commented 5 years ago

➤ Trevyn Langsford commented:

QA: The SS2 pipeline in skylab should have a README.md ( http://README.md ) next to it.

kbergin commented 5 years ago

➤ Nick Barkas commented:

Looks good! Can you please delete the original Wiki?

kbergin commented 5 years ago

Should we keep it but mark it deprecated and say at the top to go to the readme instead? In the future the readmes will be versioned with the pipeline so we’ll have that history. Thoughts?

kbergin commented 5 years ago

➤ Nick Barkas commented:

I think we should delete. It would make sense to deprecate if it was a high profile page. I don’t think anyone knows about it as it is. Perhaps we could delete and add a note with a link to the new location.

kbergin commented 5 years ago

Alright, well Liz will be doing some documentation work/cleanup in the near future so I’ll ask her to clean up what doesn't make sense to keep.