[GEN-2380] Update docs #623
Conversation
There was a problem hiding this comment.
I realize this CONTRIBUTING doc has a mix of development guidelines for external and specific to sage developers, e.g: only sage bionetworks developers can utilize the run_integration_tests functionality. I might just migrate all of the sage specific to README under Sage Bionetworks only and keep this section just for the forking and adding changes for external developers.
They can still pull the public images and build images via Dockerfile to do testing. But they won't be able to run any of our pipeline steps etc etc
There was a problem hiding this comment.
May be helpful to get xindis feedback on this
There was a problem hiding this comment.
Sounds good, I added that as AC for the relevant onboarding tickets - to review and approve the documentation
…n readme and contributing docs
…works/Genie into gen-2380-update-docs
|
Problem:
Some parts of our
READMEandCONTRIBUTINGdocs are outdated/ could be reshuffled.Solution:
Main feature to the docs is adding developing with docker sections as that is our most reproducible method for testing and developing with the genie pipeline.
I also removed
devcontainersbecause that's not currently very feasible with the R side of our environment and docker. See https://sagebionetworks.jira.com/browse/GEN-2380?focusedCommentId=272977 for more info on this.Testing:
Run through commands