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

Add description of the register list as a help box #120

Open
uqmchuvo opened this issue Jun 2, 2023 · 8 comments
Open

Add description of the register list as a help box #120

uqmchuvo opened this issue Jun 2, 2023 · 8 comments
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Milestone

Comments

@uqmchuvo
Copy link

uqmchuvo commented Jun 2, 2023

"what's a register list" help box. Explaining the purpose of the list, where to find accession and how to merge lists of different names coming from the same publication.

@lmrodriguezr lmrodriguezr added the documentation Improvements or additions to documentation label Jun 6, 2023
@lmrodriguezr lmrodriguezr added the help wanted Extra attention is needed label Aug 13, 2023
@lmrodriguezr
Copy link
Member

@uqmchuvo @MarikePalmer Do you think either of you could produce a draft of the message?

@lmrodriguezr lmrodriguezr added this to the v1.2 milestone Aug 13, 2023
@uqmchuvo
Copy link
Author

hey, I wonder if there could be some other ways to link the lists?..at the moment I can only do it if the list is send back and then proposed as part of another existing list. Maybe there is another way that I missed :P please let me know! I can draft it when I hear from you about the list but will be happy to have comments from Marike on the draft!

@lmrodriguezr
Copy link
Member

lmrodriguezr commented Aug 14, 2023

hey, I wonder if there could be some other ways to link the lists?..

I don't understand the question. A way to link together multiple lists? What would be the use case?

@MarikePalmer
Copy link

I'm also not sure what you mean here Masha? I'm also not completely sure where this message would go? Would this be at the button "Propose name" - "Link this name to a Register List for validation"?

Because then perhaps a help message for the register list could be:

"Names submitted for evaluation for endorsement or validation need to be submitted as part of a register list. This list may contain a single name or numerous names, but it is recommended that all names appearing in the same effective publication are added to a single list. Each register list has a unique accession in the form of "seqco.de/r:xxxxxxxx" which can be reported in manuscripts in preparation or submitted for peer-review. This list facilitates effective curator review in the Registry for all names appearing in the same effective publication."

@uqmchuvo
Copy link
Author

uqmchuvo commented Aug 15, 2023

Haha sorry if I confused you...it was not my intension and maybe it shows that I am confused here!
My question was specifically about merging lists together when one (by accident) created two independent lists that are linked to the same publication. This happens occasionally but with the addition of new message, hopefully, it won't happen or will happen less.

Marike, thanks for drafting the message! This is excellent!
I made few minor edits/suggestions in bold, please feel free to accept/reject. I also removed some parts but, unfortunately, I don't see here how to 'strike through' so please compare side by side...

"Names submitted for evaluation before or after publication need to be submitted as part of a register list. This list may include more than one name, and it is recommended that all names appearing in the same effective publication are added to a single list. Each register list has a unique accession in the form of "seqco.de/r:xxxxxxxx" which can be reported in manuscripts in preparation or submitted for peer-review. This list facilitates curator's review in the Registry and ensures that names appearing in the same effective publication are all validated at the same time.

@uqmchuvo
Copy link
Author

I removed the endorsement and validation because the process of proposing names as a list and evaluation/review happens for both path 1 and 2. Any other ideas how to make this clear?..

@lmrodriguezr
Copy link
Member

I added the text here:
https://disc-genomics.uibk.ac.at/seqcode/help/register

Which is linked from this new FAQ page:
https://disc-genomics.uibk.ac.at/seqcode/help

Also accessible from the About page:
https://disc-genomics.uibk.ac.at/seqcode/page/about

Please let me know where do you think we could add a (?) button to embed a help box.

Also, feel free to edit the documents themselves in this new repository:
https://github.com/seq-code/documentation

The Register List document can be accessed here:
https://github.com/seq-code/documentation/blob/main/explanation/register.md

@uqmchuvo
Copy link
Author

Thanks Miguel! Looks great!

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 help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants