Skip to content

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

NielsGeudens
Copy link
Contributor

@NielsGeudens NielsGeudens commented Jul 23, 2025

SEEK documentation: Wrote permissions documentation across Sample Types, ISA-JSON compliant Samples, Assays, and Studies

  • (Re)wrote Sample Type permissions page
  • Wrote ISA-compliant Sample permissions page
  • Added documentation pages for 'Editing Assay and Study' pages to clarify attribute modification rules and permission constraints

Standard terminology and permission level descriptions across all pages, and included validation rules, best practices, and troubleshooting tips

…ples.

User documentation to include editing of Assays, Studies and Sample types, including what can and cannot be edited.
@NielsGeudens NielsGeudens self-assigned this Jul 23, 2025
@NielsGeudens NielsGeudens added the documentation Improvements or additions to documentation label Jul 23, 2025
@PhilReedData
Copy link
Collaborator

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!

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
Projects
Status: In Progress
Development

Successfully merging this pull request may close these issues.

2 participants