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

Update developer instructions in README #18

Closed
tmheunis opened this issue Feb 21, 2024 · 2 comments · Fixed by #21
Closed

Update developer instructions in README #18

tmheunis opened this issue Feb 21, 2024 · 2 comments · Fixed by #21

Comments

@tmheunis
Copy link
Contributor

The developer instructions in this repo's readme for updating the catalog is incomplete, and maybe also outdated. I was able to update the catalog recently with the help of @jsheunis, but this information would be more useful if it is somewhere persistent. Perhaps we should also consider adding such instructions to the RDM docs at rdm.abcd-j.de, or do we only want to keep that user-focused? @mih @jsheunis what do you think?

@jsheunis
Copy link
Collaborator

Indeed, I need to add this content soon. I have some work in progress locally that I'll push when finished. I'll add all to the readme for now, but I think having a section for developers in the RDM docs is a good idea (I also mentioned it here: #12). Perhaps it should just have the lowest visibility/priority on the docs site so as not to distract standard users.

@mih
Copy link
Contributor

mih commented Feb 21, 2024

I think it is fine to add that, and it will be interesting to some. It would be useful to make clear what the target audience for each doc item is.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants