Welcome to UnHIDE Docs

This project contains the user documentation for all of unHIDEs user interfaces. This website is built using Docusaurus, a modern static website generator. The documentation is written in Markdown which is then compiled into a static website by Docusaurus.

Getting Started

Dependencies

Node.js v18.0 or above

Check if Node.js is installed on your computer by running the following command in a terminal

node --version

Unless the prompt answers with a v18.0.0 or higher, you do not have the required dependency. Please follow the steps below where we first install Node Version Manager (NVM). This helps install the latest version of Node on your machine and you can further use it to install and switch between different versions of Node.js if you need to use it for other projects.

Follow the installation steps and confirm that you fulfill the dependency requirements.

Now clone the repository and move to its root level (where you find package.json) and open a terminal on this level

Install project dependencies

$ npm install

Run locally

$ npm run start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build for production

Do not use the following command when you are developing (adding new content) on your local machine. This is only relevant for deployment.

$ npm run build

This command generates static content into the build directory and can be served using any static contents hosting service.

Adding Documentation

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.

Acknowledgement

  

The project is implemented by the Helmholtz Metadata Collaboration (HMC) an incubator platform of the Helmholtz Association. It is funded by the Helmholtz Association. The project is deployed by Jülich Super Computing Cloud (JSC Cloud) at Forschungszentrum Jülich GmbH (FZJ), an organization that is part of the Helmholtz Association. We thank all these stakeholders for their support and contribution to this projects development.