add GRSciColl documentation

gbif / tech-docs

This is an integrated technical documentation site for GBIF.org

https://techdocs.gbif.org

0 stars 2 forks source link

add GRSciColl documentation #45

Closed ahahn-gbif closed 7 months ago

ahahn-gbif commented 11 months ago

GRSciColl is currently not included, and should be added.

(GBIFS session 2/8/23, MG)

open question: where will this fit in the current structure - or do we need to extend? Possible option:

introduce a new tile "System components" that could house other parts like registry, checklistbank, literature index etc. In this case, suggest to move the IPT into the Tools section as the first item on the list

@ManonGros, @MattBlissett, @timrobertson100 : would you have comments on that?

If we change the entry page layout, this will need to be part of the launch

ManonGros commented 11 months ago

I like the idea of an "other" category, whether it is called "system component" or something else I am not sure.

I think it would be useful to have tho systems/entities (registry, GRSciColl, literature, etc.) with their own page. Right now they are mostly described in the API documentation so we could redirect users to the relevant parts of the API documentation.

For example, there could be a GRSciColl doc, with

all the UI instructions (how to merge entries, how are occurrences linked to GRSciColl, etc..)
link to the relevant part of the API doc (Collection API and lookup)
and the link to external resources like the GRSciColl website and generic videos

@MortenHofft already prepared a page for the GRSciColl "doc" on the new website. I think for the more technical bits, we will just redirect to this technical doc website.

Does it make sense?

ahahn-gbif commented 11 months ago

I am replacing the IPT documentation (now "tools" item number 1) with a tile for "System components". Current items on the draft list for the landing page (without much further content):

GBIF registry
GRSciColl (or whatever name it will get with the new website)
Literature tracking
Checklistbank

What else should be included in this section? Maps?

ahahn-gbif commented 8 months ago

@ManonGros which parts of the GRSciColl documentation should be referenced at https://tech-docs.gbif-uat.org/en/system-components/#grscicoll - https://scientific-collections.gbif.org/connected-systems?

ahahn-gbif commented 7 months ago

Considering this part sufficient for launch with a paragraph on the section landing page (https://techdocs.gbif-uat.org/en/system-components/), planning for addition of GRSciColl page(s) from here.

ManonGros commented 7 months ago

Thanks Andrea, it looks good to me.