Skip to content
Snippets Groups Projects

Docusaurus based documentation

Open Fiona D'Mello requested to merge feature-6/docusaurus-setup into dev

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

Edited by Fiona D'Mello

Merge request reports

Loading
Loading

Activity

Filter activity
  • Approvals
  • Assignees & reviewers
  • Comments (from bots)
  • Comments (from users)
  • Commits & branches
  • Edits
  • Labels
  • Lock status
  • Mentions
  • Merge request status
  • Tracking
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 {
  • @f.dmello Also, blog folder seems not necessary. If it is not used, could you remove the folder?

  • Fiona D'Mello added 1 commit

    added 1 commit

    • c4504f33 - removed all extra docusaurus tutorial and blogs related content

    Compare with previous version

  • 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 ![HZB](./images/hzb-logo-a4-rgb.png)
    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)
    • Comment on lines -40 to -56

      why is these chapters removed? I would confirm with Volker before removing them. We should have these either in home page or keep them here

    • Please register or sign in to reply
  • 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
    1 {
    2 "name": "unhide-docs",
    3 "version": "0.0.0",
  • 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
    • There is no info left about the project itself. Maybe there is no need to explain everything in detail but at least we should put general idea of what this repo, where it comes from and how to access to the main resources (which can be the deployed website)

    • Please register or sign in to reply
  • 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).
    • If there is a general email for Knowledge Graph that should be used here. However, we should give an email at all, just forward people to issues so people can create issues. Only additional thing is adding GitLab issue templates for bugs or feature requests

    • Please register or sign in to reply
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Loading
  • Please register or sign in to reply
    Loading