search

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

Software docs: Nav and links #513

Closed sjspielman closed 2 weeks ago

sjspielman commented 3 weeks ago

Closes #458 Related to #494 Should be merged after #511 & #512

This PR wraps up the process to break up and port the software requirements docs into a new reproducibility section. I'm filing this as a draft PR since it should only be merged after #511 & #512. I did some actual branch stacking to make links play nicely, so there are some changes here which are really part of those PRs. I will mark this ready for review once those go in and "duplicate" changes are no longer present here.

Here is what I did:

1) I updated mkdocs.yml to reflect the current docs organization 2) I moved the docker docs out of software-tools and into ensuring-repro (this is the part relevant to #494). I did this now because it facilitated some of the relative link updates. 3) Fix all the relative links 🤞

sjspielman commented 3 weeks ago

@dvenprasad I seem to be unable to remove you as a reviewer here 🤷‍♀️ , but you do not need to review this PR!

sjspielman commented 2 weeks ago

511 and #512 are in, but let's also wrap up #516 first before de-drafting this.

sjspielman commented 2 weeks ago

@allyhawkins, let me know what I can clarify about this PR review. As the changes in this PR are almost entirely updating relative links, and the links check passes, this should be pretty quick!