Docusaurus based documentation
We now use Docusaurus for our documentation website. This website contains basic documentation about UnHIDE interfaces, based off of what was in the previous version of the documentation.
Closes #6
Merge request reports
Activity
added Under Review + 1 deleted label
requested review from @gabriel.preuss
assigned to @f.dmello
added 8 commits
- 459954e2 - added notes on categories and search for web UI docs
- 2d92c0cf - added documentation of filtering in web ui
- 24947c6e - added content on secondary features for web UI docs
- f022a249 - added user docs for web api introduction and categories, source apis
- e9af3683 - added content for the last two APIs
- 5f40b8e5 - fix jupyter pipeline
- 39b1fee3 - Merge branch 'feature/web-api-guide' into 'feature/web-ui-guide'
- 9d01a15b - Merge branch 'feature/web-ui-guide' into 'feature-6/docusaurus-setup'
Toggle commit listadded 14 commits
- 9d01a15b...17ffd022 - 4 earlier commits
- 3204f9f2 - added new images for value prop landing page
- 3e79a9e2 - update images for landing pagee
- 37564164 - update images according to color scheme
- aacaf8a4 - updated navbar logo and hero-section with a blurred background on the landing page
- 3eaf6231 - removed the React reference
- bdbe8b27 - Merge branch 'feature/new_pipeline' into 'feature/move-sparql'
- 858140fd - Merge branch 'feature/move-sparql' into 'feature/update-landing-page'
- 75568fd3 - updated label for guides
- a63cc3d6 - Merge branch 'feature/update-landing-page' of...
- d236004c - Merge branch 'feature/update-landing-page' into 'feature-6/docusaurus-setup'
Toggle commit listadded 1 commit
- c795a58d - updated packages and set new configurations to stop warnings in blog sections
requested review from @m.soylu and removed review request for @gabriel.preuss
- docusaurus.config.ts 0 → 100644
66 position: "left", 67 }, 68 { 69 href: "https://codebase.helmholtz.cloud/hmc/hmc-public/unhide/documentation/-/tree/main?ref_type=heads", 70 label: "GitLab", 71 position: "right", 72 }, 73 ], 74 }, 75 footer: { 76 style: "dark", 77 links: [ 78 { 79 title: "Docs", 80 items: [ 81 { changed this line in version 5 of the diff
@f.dmello Also, blog folder seems not necessary. If it is not used, could you remove the folder?
added 1 commit
- c4504f33 - removed all extra docusaurus tutorial and blogs related content
@f.dmello Are you sure to keep docs/docusaurus-tutorials folder as it is? Looks like it is from the original template.
- docusaurus.config.ts 0 → 100644
1 import { themes as prismThemes } from "prism-react-renderer"; 2 import type { Config } from "@docusaurus/types"; 3 import type * as Preset from "@docusaurus/preset-classic"; 4 5 const config: Config = { 6 title: "Helmholtz Knowledge Graph (HKG)", 7 tagline: 8 "the knowledge graph driving the Unified Helmholtz Information and Data Exchange (UnHide)", 41 42 % [<img src="./images/hzb-logo-a4-rgb.png" alt="HZB" width=40% height=40%>](https://www.helmholtz-berlin.de/) 43 44 [<img style="vertical-align: left;" alt="FZJ" src='https://github.com/Materials-Data-Science-and-Informatics/Logos/raw/main/FZJ/FZJ.png' width=60% height=60%>](https://fz-juelich.de) 45  46 47 48 49 ## Acknowledgements 50 51 52 This project was developed and funded by the Helmholtz Metadata Collaboration 53 (HMC), an incubator-platform of the Helmholtz Association within the framework of the 54 Information and Data Science strategic initiative. 55 56 [<img style="vertical-align: middle;" alt="HMC Logo" src='https://github.com/Materials-Data-Science-and-Informatics/Logos/raw/main/HMC/HMC_Logo_M.png' width=50% height=50%>](https://helmholtz-metadaten.de) 15 - build 18 16 19 17 pages: 20 18 stage: deploy 21 19 image: busybox:latest 22 20 needs: [docs-build] 23 21 script: 24 - ls 25 - mv docs/_build/html public 22 - mv build public 26 23 artifacts: 27 24 paths: 28 25 - public 29 26 rules: 30 - if: $CI_COMMIT_BRANCH == "main" 27 - if: '$CI_COMMIT_TAG =~ /^\d+\.\d+(\.\d+)?(-pl\d+){0,1}$/' - package.json 0 → 100644
- docusaurus.config.ts 0 → 100644
1 import { themes as prismThemes } from "prism-react-renderer"; 2 import type { Config } from "@docusaurus/types"; 3 import type * as Preset from "@docusaurus/preset-classic"; 4 5 const config: Config = { 6 title: "Helmholtz Knowledge Graph (HKG)", 7 tagline: 8 "the knowledge graph driving the Unified Helmholtz Information and Data Exchange (UnHide)", 9 favicon: "img/Logo_HGF-KG_notext_brightback.png", 10 11 // Set the production url of your site here 12 url: "https://docs.unhide.helmholtz-metadaten.de", 1 <img src="https://s3.desy.de/hackmd/uploads/upload_c3ba77674d5c58417c6df0f195b0c4ac.png" alt="unHIDE logo" height = "75"> 1 # Welcome to UnHIDE Docs 54 38 55 This modularity (especially the ability to securely and independently manage parts of the overall graph) will also allow to realize different modes of access to digital assets (e.g. respecting sensitivity and confidentiality but also permitting full openness). The initial implementation of the Helmholtz-KG will not contain sensitive or confidential data, but such capacities (e.g. user management, license recognition across (meta)data holdings, and authentication) can be explored and implemented when the core technology and operational procedures are stabilised. 39 Do not use the following command when you are developing (adding new content) on your local machine. This is only relevant for deployment. 56 40 57 The backbone architecture of the Helmholtz Knowledge Graph will be licensed under [CC0/CCBY](https://creativecommons.org/about/cclicenses/) to enable crosswalks to the outside world and gain visibility as e.g. a sub-cloud of the [Linked Open Data Cloud](https://lod-cloud.net/). 41 ``` 42 $ npm run build 43 ``` 58 44 59 ### Inspiration 45 This command generates static content into the `build` directory and can be served using any static contents hosting service. 60 46 61 The implementation of the Helmholtz-KG architecture is inspired by the federation of stakeholders in IOC-UNESCO's Ocean Data and Information System (ODIS), interconnected by the [ODIS Architecture](https://book.oceaninfohub.org/) [2], and rendered into a knowledge graph federating over 50 partners across the globe by the Ocean InfoHub Project (OIH). Personnel from the HMC's Earth and Environment Hub chair the ODIS federation and lead the technical implementation of OIH, offering direct alignment with unHIDE. 47 ## Adding Documentation 62 48 49 The project has already been set up for direct use. For now, please just add content to the respective markdown files that are found in `/docs`. The relevant markdown file can be found easily as the folder has been structured as per the websites layout (actually, the websites layout is dependent on folder structure). The folder structure along with descriptive naming convention for the document should make it clear which markdown file might be appropriate. If you need to add new pages, or need content to be structured a certain way - please get in touch with [Ms.Fiona D'Mello](mailto:f.dmello@fz-juelich.de).