This PR started out as user docs being added to the user-docs directory, but has evolved into a more bulky PR because of related changes to site serving and SEO.
Since the catalog app is nog using vue-router history mode, the site serving has to change. It will use the same setup as data.SFB1451.de, where the docs subdirectory is served from a custom domain (not using github pages). For this repo the catalog will be served from the catalog subdirectory, hence the renaming of so many files
For RDM documentation, theuser-docs directory has been renamed to docs
RDM documentation has been added to instruct users how to prepare and share their metadata for contributing to the catalog
RDM documentation uses sphinx and the sphinx-book theme and can be built by running make html from the docs subdirectory (after installing requirements found in the same subdir)
TODO:
add github action to build rdm docs and e.g. push to gh-pages branch
disable github pages for the catalog and remove associated custom domain settings
enable github pages for gh-pages branch and add custom domain rdm.abcd-j.de
This PR started out as user docs being added to the
user-docsdirectory, but has evolved into a more bulky PR because of related changes to site serving and SEO.docssubdirectory is served from a custom domain (not using github pages). For this repo the catalog will be served from thecatalogsubdirectory, hence the renaming of so many filesuser-docsdirectory has been renamed todocsmake htmlfrom the docs subdirectory (after installing requirements found in the same subdir)TODO:
gh-pagesbranchgh-pagesbranch and add custom domain rdm.abcd-j.de