Merge pull request #2 from norbertvandijk/main

#2 looks good
gofair-foundation · Nov 22, 2023 · 09694e9 · 09694e9
2 parents 98d92b2 + 756cc1e
commit 09694e9
Show file tree

Hide file tree

Showing 15 changed files with 71 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1 +1,7 @@
-# fip.github.io
+# fip.github.io
+
+This repository contains the source files and the `readthedocs` configuration files for maintaining and producing the following online resource:
+
+[fip.github.io](https://gofair-foundation.github.io/fip/ )
+
+This online resource offers .. 
diff --git a/_site/test b/_site/test
@@ -0,0 +1 @@
+
diff --git a/docs/Authors.md b/docs/Authors.md
@@ -0,0 +1,5 @@
+# Authors
+
+- Barbara Magagna, ORCID [0000-0003-2195-3997](https://orcid.org/0000-0003-2195-3997)
+
+- Erik Schultes, ORCID [0000-0001-8888-635X](https://orcid.org/0000-0001-8888-635X)
diff --git a/Background.md → docs/Background.md b/Background.md → docs/Background.md
diff --git a/docs/GettingStarted.md b/docs/GettingStarted.md
@@ -0,0 +1,2 @@
+# Getting started
+
diff --git a/docs/Index.md b/docs/Index.md
@@ -0,0 +1,10 @@
+# FAIR Implementation Profiles
+
+<p align="left"><img src="./assets/img/Offical FIP Icon.png" width="20%"></p>
+
+This wiki offers the following documentation related to FAIR implementation profiles or FIP's for short:
+
+- FIP Wizard 3.0 - User Guide
+-  
+
+This wiki and all of its content are maintained by the [GO FAIR Foundation](https://www.gofair.foundation/). The source files and the `readthedocs` configuration files of these pages can be found on [Github](https://github.com/gofair-foundation/fip).
diff --git a/docs/License.md b/docs/License.md
@@ -0,0 +1,2 @@
+# License
+
diff --git a/docs/Maintainers.md b/docs/Maintainers.md
@@ -0,0 +1,3 @@
+# Maintainers
+
+- Norbert van Dijk, ORCID [0009-0003-5409-652X](https://orcid.org/my-orcid?orcid=0009-0003-5409-652X)
diff --git a/docs/MintingNanopublications.md b/docs/MintingNanopublications.md
@@ -0,0 +1,2 @@
+# Minting nanopublications
+
diff --git a/docs/Overview.md b/docs/Overview.md
@@ -0,0 +1,2 @@
+# Overview
+
diff --git a/docs/Publishing.md b/docs/Publishing.md
@@ -0,0 +1,2 @@
+# Publishing
+
diff --git a/docs/Revising.md b/docs/Revising.md
@@ -0,0 +1,2 @@
+# Revising
+
diff --git a/docs/assets/img/Offical FIP Icon.png b/docs/assets/img/Offical FIP Icon.png
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,18 @@
+site_name: FIP wiki
+nav:
+    - Home: Index.md 
+    - FIP Wizard 3.0 User Guide:
+      - Background: Background.md
+      - Overview: Overview.md
+      - Getting started: GettingStarted.md
+      - Minting nanopublications: MintingNanopublications.md
+      - Publishing: Publishing.md
+      - Revising: Revising.md
+      - Authors: Authors.md
+    - License: License.md
+    - Maintainers: Maintainers.md
+
+theme: readthedocs
+
+markdown_extensions:
+    - footnotes
diff --git a/readthedocs.yml b/readthedocs.yml
@@ -0,0 +1,15 @@
+# .readthedocs.yml
+# ****************
+
+# readthedocs configuration file for mkdocs projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Build documentation with MkDocs
+mkdocs:
+ configuration: mkdocs.yml
+
+# Optionally build your docs in additional formats such as PDF and ePub
+formats: all