Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rocker scripts documentation #405

Open
eitsupi opened this issue Apr 10, 2022 · 2 comments
Open

Rocker scripts documentation #405

eitsupi opened this issue Apr 10, 2022 · 2 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@eitsupi
Copy link
Member

eitsupi commented Apr 10, 2022

Currently, there is little documentation about the scripts and it is difficult to understand the purpose and use of each script.

Perhaps it would be appropriate to put README.md in the scripts directory and write the usage and purpose.
And, scripts that are not used in this repository and have not been maintained for a long time should be moved to the experimental subdirectory.

Also, to make it easier for the user to understand, the name of the scripts directory should be rocker_scripts (i.e., the same name as in the pre-built containers), I think.

@eitsupi eitsupi added documentation Improvements or additions to documentation enhancement New feature or request labels Apr 10, 2022
@eitsupi
Copy link
Member Author

eitsupi commented Aug 29, 2022

It is also worth mentioning supported platforms (e.g. install_tidyverse.sh is currently not executable on arm64)

@davidbudzynski
Copy link

I second this, it's quite difficult to get your head around when there are lots of dockerfiles and many scripts which can be added on top.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants