top-level RG - Githubissues

colonial-heritage / research-guides-dev

Development repo for integrating the research guides from NIOD into the Datahub

Creative Commons Attribution Share Alike 4.0 International

0 stars 0 forks source link

top-level RG #16

Closed valevo closed 2 months ago

valevo commented 2 months ago

background

in the front-end application, there is a landing page for the RGs, providing introductory texts & examples of guides on level 1 & level 2 --> in the proof-of-concept version of the RGs on the Datahub, this is the only entry point to the RGs
from a conceptual POV, there is nothing that ties the RGs together as a whole (i.e. thinking of the RGs as a hierarchy, there is no root node)

advantages

RG maintainers have full control over texts on front-end (updating can be fully automated with GitHub hooks)
structure across and among RGs is made explicit in the document (rather than implicit in folder structures or in information distributed across RGs)
providing example lists of RGs becomes very convenient (arbitrary amounts of lists with arbitrary meanings could be supplied)
can be a good entry point for anyone re-using the RGs on the Datahub

questions

are there disadvantages?
how is this top-level files structured? as an RG? if so, can its elements be re-used at lower levels?

TO BE CONSIDERED

valevo commented 2 months ago

@wreints, please discuss this among yourselves, think about justifications, drawbacks, requirements, etc on your side and announce them here

wreints commented 2 months ago

@valevo I made something that could work as a top level research aid (they're in the TopLevel folder). Let me know what you think of it