AlexsLemonade / OpenScPCA-analysis

An open, collaborative project to analyze data from the Single-cell Pediatric Cancer Atlas (ScPCA) Portal
Other
1 stars 8 forks source link

Docs for updating docker images #547

Closed sjspielman closed 3 days ago

sjspielman commented 4 days ago

Closes #497

This PR adds docs that describe why you need to file 2 PRs to update a docker image, once all the GHAs have been turned on. Note that it contains one #STUB_LINK which can be completed once #533 goes in.

Instructions for reviewers:

  1. I am not at all sure if I have presented this information clearly, so please let me know whether there is a different logical flow of information which would make this easier to understand! Any comments about clarity and presentation are appreciated!
  2. Are there any additional details to communicate besides that they need 2 PRs?
  3. Are there any more spots in the docs that would benefit from linking to this page?
sjspielman commented 4 days ago

I've rearranged the page in a way I think makes things clearer, and bonus removes the need to distinguish implement vs activate.

sjspielman commented 4 days ago

Noting this link check fail was expected https://github.com/AlexsLemonade/OpenScPCA-analysis/pull/547/commits/6dce7a46d738c47cc8457dcf6a7c14395dec9651. It has STUB_LINKs for docs incoming in #533.

sjspielman commented 3 days ago

(this was me checking my creds rotation worked :) https://github.com/AlexsLemonade/OpenScPCA-analysis/pull/547/commits/6d28768ac380584b0c0161096b01b7db4128fd94)

sjspielman commented 3 days ago

@allyhawkins is this where you had in mind for the note? https://github.com/AlexsLemonade/OpenScPCA-analysis/pull/547/commits/f22c07174fdcc53a93577f1966152ebe3648264a

sjspielman commented 3 days ago

Again noting that link failures are expected, so we don't need that to pass before merging.