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

Autogenerated web documentation should include a minimal table of all terms on it's own page #4

Closed
turbomam opened this issue Aug 29, 2023 · 11 comments · Fixed by #38
Closed
Assignees

Comments

@turbomam
Copy link
Member

No description provided.

@jjkoehorst
Copy link

This would be highly appreciated and it does not have to be overly complex or extensive.
A simple table with ID, label and description might be sufficient.

Most people use for example only the generic package but they might have additional metadata that has been used in other well defined packages. To have such a general overview in which they can apply basic CTRL+F methods could be very useful.

@turbomam
Copy link
Member Author

@jjkoehorst can you elaborate on the "generic package"? That isn't anything that is defined in this schema.

@turbomam
Copy link
Member Author

I agree that this will be useful and can easily be implemented, but only as a new, extremely large section on the schema's landing page

The challenge will be building it on another page and providing a link on either the right (section-oriented) menu or the left (open-ended) menu

@jjkoehorst
Copy link

I am mostly familiar with the ENA submission procedures https://www.ebi.ac.uk/ena/browser/view/ERC000011 for which only date and location is obligatory and used in a lot of cases

@turbomam
Copy link
Member Author

Move types section to separate page

also rename some of the sections

@turbomam
Copy link
Member Author

sort elements in tables alphabetically

packages -> externsions

@turbomam
Copy link
Member Author

turbomam commented Aug 29, 2023

@sujaypatil96

@turbomam
Copy link
Member Author

emphasize usability to a wide audience over comprehensiveness

@turbomam
Copy link
Member Author

Where/how will all of the documentation from this repo be integrated with the GSC website?

@ramonawalls
Copy link
Collaborator

The terms page should be separate from the page that lists all the classes, since it is such a long list. It should include at least the term label, ID, and definition (linkml description).

@only1chunts
Copy link
Member

The terms are listed on the gensc.org website at present:
https://www.gensc.org/pages/standards/all-terms.html
I would appreciate a way to have that table auto-generated from any new MiXS releases.
Currently it relies on a json format file of the terms being included in the website repo when the website is built, but I'm good with any alternatives that results in a similar functionality.

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