-
Notifications
You must be signed in to change notification settings - Fork 2
Documentation: Permissions on Sample Type and ISA #53
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
Documentation: Permissions on Sample Type and ISA #53
Conversation
…ples. User documentation to include editing of Assays, Studies and Sample types, including what can and cannot be edited.
|
Hi @NielsGeudens, thanks for this work. I am trying to run this PR branch locally but I'm having a few GitHub (or maybe Jekyll) problems today. So I am only looking at the raw markdown. Overall comments so far is very good. Happy with the overall shape. Where there are bullet point lists, I would prefer to only see semicolons on the line ends if there is one sentence that reads across the whole list. I think where the bullet point is a whole sentence (an instruction), it should end in a full stop (period). I need to check what we say in our style guide (which I lifted from RDMkit). I would also like to test the instructions with a couple of different SEEK instances too. I will try to look at this again middle of next week, after I have delivered my tutorial in Vancouver. I will be 9 hours behind you all next week! |
|
I edited the PR as follow:
|
…rmissions; modified semicolons in bullet point lists
|
closes seek4science/seek#1903 |
PhilReedData
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Apologies for the super slow response. I have reviewed all pages, I'm happy with almost all of it, thank you. The menu changes are fine (after renaming 'Sample Types'). There are two new pages to rename to all lower case for consistency. There are some minor changes suggested throughout.
|
Hi @NielsGeudens, I have committed most of the suggestions I made, 8 items remain with questions for you. I was planning to do the renaming of those two new files (to all lower case) but my access to GitHub via the terminal is blocked today, something odd going on in Manchester. I can probably do it from home tomorrow. |
…`edit-isa=studies.md` and links to them.
|
Final comment before I merge: there were a couple of minor comments remaining which we can pick up afterwards if you wish.
|
SEEK documentation: Wrote permissions documentation across Sample Types, ISA-JSON compliant Samples, Assays, and Studies
Standard terminology and permission level descriptions across all pages, and included validation rules, best practices, and troubleshooting tips