Skip to content

Commit ebef632

Browse files
committed
Add docs template
1 parent c992775 commit ebef632

14 files changed

Lines changed: 296 additions & 0 deletions

File tree

‎docs/assets/.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
nomad-oasis*.zip

‎docs/assets/favicon.png‎

17.9 KB
Loading

‎docs/assets/nomad-plugin-logo.png‎

67 KB
Loading

‎docs/explanation/explanation.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Explanation
2+
3+
!!! note "Attention"
4+
Please update the document with relevant information specific to your plugin.
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Contribute to the documentation
2+
3+
!!! note "Attention"
4+
Please update the document with relevant information specific to your plugin.
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Contribute to This Plugin
2+
3+
!!! note "Attention"
4+
Please update the document with relevant information specific to your plugin.
5+

‎docs/how_to/install_this_plugin.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Install This Plugin
2+
3+
!!! note "Attention"
4+
Please update the document with relevant information specific to your plugin.

‎docs/how_to/use_this_plugin.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# How to Use This Plugin
2+
3+
This plugin can be used in a NOMAD Oasis instalation..
4+
5+
## Add This Plugin to Your NOMAD instalation
6+
7+
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.
8+
9+
!!! note "Attention"
10+
Please update the document with relevant information specific to your plugin.

‎docs/index.md‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Welcome to the `nomad-schema-plugin-run` documentation
2+
3+
This is a collection of schema for the NOMAD root section `run`.
4+
5+
## Introduction
6+
7+
!!! note "Attention"
8+
Please update the document with relevant information specific to your plugin.
9+
10+
<div markdown="block" class="home-grid">
11+
<div markdown="block">
12+
13+
### Tutorial
14+
15+
A series of tutorials will guide you through the main functionality of `nomad-schema-plugin-run`.
16+
17+
- [Tutorial](tutorial/tutorial.md)
18+
19+
</div>
20+
<div markdown="block">
21+
22+
### How-to guides
23+
24+
How-to guides provide step-by-step instructions for a wide range of tasks, with the overarching topics:
25+
26+
- [Install this plugin](how_to/install_this_plugin.md)
27+
- [Use this plugin](how_to/use_this_plugin.md)
28+
- [Contribute to this plugin](how_to/contribute_to_this_plugin.md)
29+
- [Contribute to the documentation](how_to/contribute_to_the_documentation.md)
30+
31+
</div>
32+
33+
<div markdown="block">
34+
35+
### Explanation
36+
37+
The explanation [section](explanation/explanation.md) provides background knowledge on this plugin.
38+
39+
</div>
40+
<div markdown="block">
41+
42+
### Reference
43+
44+
The reference [section](reference/references.md) includes all CLI commands and arguments, all configuration options,
45+
the possible schema annotations and their arguments, and a glossary of used terms.
46+
47+
</div>
48+
</div>

‎docs/reference/references.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# References
2+
3+
!!! note "Attention"
4+
Please update the document with relevant information specific to your plugin.

0 commit comments

Comments
 (0)