Skip to content

Commit

Permalink
Cleanup documentation (#22)
Browse files Browse the repository at this point in the history
* cleanup how to's and doc folders

* add North tools use in how to
  • Loading branch information
schumannj authored Jun 13, 2024
1 parent 8215589 commit c2a8ee3
Show file tree
Hide file tree
Showing 8 changed files with 18 additions and 42 deletions.
4 changes: 0 additions & 4 deletions docs/explanation/explanation.md

This file was deleted.

4 changes: 0 additions & 4 deletions docs/how_to/contribute_to_the_documentation.md

This file was deleted.

5 changes: 0 additions & 5 deletions docs/how_to/contribute_to_this_plugin.md

This file was deleted.

8 changes: 6 additions & 2 deletions docs/how_to/install_this_plugin.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
# Install This Plugin

!!! note "Attention"
TODO
To install this plugin follow (part 4 of the FAIRmat tutorial 13)[https://github.com/FAIRmat-NFDI/AreaA-Examples/tree/main/tutorial13/part4] or read the [NOMAD plugin documentation](https://nomad-lab.eu/prod/v1/staging/docs/plugins/plugins.html#add-a-plugin-to-your-nomad) for all details on how to deploy the plugin on your NOMAD instance.


If you already have an Oasis, you just need to add the line
`git+https://github.com/FAIRmat-NFDI/nomad-unisyscat-plugin.git@main` to the plugin.txt in your Oasis repositorium.

12 changes: 6 additions & 6 deletions docs/how_to/use_this_plugin.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,13 @@
# How to Use This Plugin

This plugin can be used in a NOMAD Oasis installation.
This plugin can be used in a NOMAD Oasis installation. Check the tips in [Install this plugin](install_this_plugin.md) for details.

## Add This Plugin to Your NOMAD installation

Read the [NOMAD plugin documentation](https://nomad-lab.eu/prod/v1/staging/docs/plugins/plugins.html#add-a-plugin-to-your-nomad) for all details on how to deploy the plugin on your NOMAD instance.
Once the Oasis is deployed, you can generate different entries as shown below.

## Add new sample entries
<iframe src="https://scribehow.com/embed/Upload_custom_data_entry_with_specific_schema_in_NOMAD_Oasis__mRg47mlZSpOSQ5G_HFlq7A" width="100%" height="640" allowfullscreen frameborder="0"></iframe>

## Add instrument data entry
## Add instrument entry
<iframe src="https://scribehow.com/embed/Create_a_Custom_Instrument_Schema_in_Nomad_Oasis__-RkLffMjT22hj9BAipE1KQ" width="100%" height="640" allowfullscreen frameborder="0"></iframe>

## Add measurement entry
Expand All @@ -22,11 +20,13 @@ Read the [NOMAD plugin documentation](https://nomad-lab.eu/prod/v1/staging/docs/

## run a jupyter notebook to visualize the pdb file

TODO: how to connect the NORTH Tools to a local Oasis instance.
<iframe src="https://scribehow.com/embed/Visualizing_pdb_files_through_NOMAD_Remote_Tools_Hub__IdryIk1lRpaDI8TQm6ajbg" width="100%" height="640" allowfullscreen frameborder="0"></iframe>

## User management

<iframe src="https://scribehow.com/embed/Add_Users_to_a_Nomad_Oasis_Upload__hGhkAMCATXWdHGjeleDB0A" width="100%" height="640" allowfullscreen frameborder="0"></iframe>

## Use the dedicated UniSysCat Explore App to get an overview and find entries

!!! Attention:
TODO add introduction of App
17 changes: 0 additions & 17 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,34 +51,17 @@ By exploring this demonstration, users will gain a clearer understanding of how
<div markdown="block" class="home-grid">
<div markdown="block">

### Tutorial

TODO

- [Tutorial](tutorial/tutorial.md)

</div>
<div markdown="block">

### How-to guides

How-to guides provide step-by-step instructions for a wide range of tasks, with the overarching topics:

- [Install this plugin](how_to/install_this_plugin.md)
- [Use this plugin](how_to/use_this_plugin.md)
- [Contribute to this plugin](how_to/contribute_to_this_plugin.md)
- [Contribute to the documentation](how_to/contribute_to_the_documentation.md)

</div>

<div markdown="block">

### Explanation

The explanation [section](explanation/explanation.md) provides background knowledge on this plugin.

</div>
<div markdown="block">

### Reference

Expand Down
6 changes: 6 additions & 0 deletions docs/reference/references.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,9 @@

!!! note "Attention"
TODO

!!! note "List of (Entry Data type) Schemas from the Plugin"
EPR
IRSpectroscopy
NRVSpectroscopy

4 changes: 0 additions & 4 deletions docs/tutorial/tutorial.md

This file was deleted.

0 comments on commit c2a8ee3

Please sign in to comment.