Moved all roles in a new dir called Roles

trustoverip · Aug 18, 2024 · dc0d5b1 · dc0d5b1
1 parent 9ba2d1c
commit dc0d5b1
Show file tree

Hide file tree

Showing 19 changed files with 24 additions and 10 deletions.
diff --git a/docs/Roles/_category_.json b/docs/Roles/_category_.json
@@ -0,0 +1,8 @@
+{
+  "label": "Roles",
+  "position": 3,
+  "link": {
+    "type": "generated-index",
+    "description": "Roles."
+  }
+}
diff --git a/docs/admins-guide.md → docs/Roles/admins-guide.md b/docs/admins-guide.md → docs/Roles/admins-guide.md
diff --git a/docs/content-authors-guide/_category_.json → ...les/content-authors-guide/_category_.json b/docs/content-authors-guide/_category_.json → ...les/content-authors-guide/_category_.json
diff --git a/docs/content-authors-guide/introduction.md → ...les/content-authors-guide/introduction.md b/docs/content-authors-guide/introduction.md → ...les/content-authors-guide/introduction.md
diff --git a/docs/curators-guide/_category_.json → docs/Roles/curators-guide/_category_.json b/docs/curators-guide/_category_.json → docs/Roles/curators-guide/_category_.json
diff --git a/docs/curators-guide/introduction.md → docs/Roles/curators-guide/introduction.md b/docs/curators-guide/introduction.md → docs/Roles/curators-guide/introduction.md
diff --git a/docs/developers-guide.md → docs/Roles/developers-guide.md b/docs/developers-guide.md → docs/Roles/developers-guide.md
diff --git a/docs/general-guide.md → docs/Roles/general-guide.md b/docs/general-guide.md → docs/Roles/general-guide.md
@@ -68,4 +68,4 @@ HTTP stands for HyperText Transfer Protocol. It is the foundation of any data ex
 
 #### Automation
 
-The above scripts can easily be triggered by [github actions](glossary#github-actions).  See [this repo's example](https://github.com/decentralized-identity/spec-up/blob/master/.github/workflows/render-specs.yml)
+The above scripts can easily be triggered by [github actions](../glossary#github-actions).  See [this repo's example](https://github.com/decentralized-identity/spec-up/blob/master/.github/workflows/render-specs.yml)
diff --git a/...lossary-maintainers-guide/_category_.json → ...lossary-maintainers-guide/_category_.json b/...lossary-maintainers-guide/_category_.json → ...lossary-maintainers-guide/_category_.json
diff --git a/...lossary-maintainers-guide/introduction.md → ...lossary-maintainers-guide/introduction.md b/...lossary-maintainers-guide/introduction.md → ...lossary-maintainers-guide/introduction.md
diff --git a/docs/readers-guide/_category_.json → docs/Roles/readers-guide/_category_.json b/docs/readers-guide/_category_.json → docs/Roles/readers-guide/_category_.json
diff --git a/docs/readers-guide/introduction.md → docs/Roles/readers-guide/introduction.md b/docs/readers-guide/introduction.md → docs/Roles/readers-guide/introduction.md
diff --git a/...terminology-authors-guide/_category_.json → ...terminology-authors-guide/_category_.json b/...terminology-authors-guide/_category_.json → ...terminology-authors-guide/_category_.json
diff --git a/...authors-guide/external-term-references.md → ...authors-guide/external-term-references.md b/...authors-guide/external-term-references.md → ...authors-guide/external-term-references.md
diff --git a/...terminology-authors-guide/introduction.md → ...terminology-authors-guide/introduction.md b/...terminology-authors-guide/introduction.md → ...terminology-authors-guide/introduction.md
diff --git a/...minology-authors-guide/term-references.md → ...minology-authors-guide/term-references.md b/...minology-authors-guide/term-references.md → ...minology-authors-guide/term-references.md
diff --git a/docs/intro.md b/docs/intro.md
@@ -15,6 +15,12 @@ The code is available [on Github](https://github.com/blockchainbird/spec-up-t).
 
 **Spec-Up-T** is based on **Spec-Up** and some of the content on this website is taken from the [Spec-Up website](https://identity.foundation/spec-up/).
 
+:::tip
+
+In order to start using Spec-Up-T you will have to install it. Go straight to the [admin section](roles/admins-guide.md) for instructions.
+
+:::
+
 ## History
 
 Spec-Up-T is based on Spec-Up ([Spec-Up on Github](https://github.com/decentralized-identity/spec-up)).
@@ -54,12 +60,12 @@ The following roles can be distinguished:
 
 | Role               | Description                                                                                       | Guide Link                                               |
 |--------------------|---------------------------------------------------------------------------------------------------|----------------------------------------------------------|
-| Content Author     | Focusses on content and concepts of the group he/she belongs to.                                  | [Content Author Guide](content-authors-guide/introduction) |
-| Terminology Author | Focusses on term definitions covering concepts of the group he/she belongs to.                    | [Terminology Author Guide](terminology-authors-guide/introduction) |
-| Curator            | Checks logical consistency & meaning of term definition in a certain context.                      | [Curator Guide](curators-guide/introduction)             |
-| Reader             | Reads concepts in text and terminology in glossaries.                                             | [Reader Guide](readers-guide/introduction.md)            |
-| Admin              | Installs, updates and maintains Spec-Up-T.                                                        | [Admin Guide](admins-guide.md)                           |
-| Developer          | Adds new functionality to Spec-Up-T.                                                              | [Developer Guide](developers-guide.md)                   |
+| Content Author     | Focusses on content and concepts of the group he/she belongs to.                                  | [Content Author Guide](roles/content-authors-guide/introduction) |
+| Terminology Author | Focusses on term definitions covering concepts of the group he/she belongs to.                    | [Terminology Author Guide](roles/terminology-authors-guide/introduction) |
+| Curator            | Checks logical consistency & meaning of term definition in a certain context.                      | [Curator Guide](roles/curators-guide/introduction)             |
+| Reader             | Reads concepts in text and terminology in glossaries.                                             | [Reader Guide](roles/readers-guide/introduction.md)            |
+| Admin              | Installs, updates and maintains Spec-Up-T.                                                        | [Admin Guide](roles/admins-guide.md)                           |
+| Developer          | Adds new functionality to Spec-Up-T.                                                              | [Developer Guide](roles/developers-guide.md)                   |
 
 ## Markdown
 

diff --git a/docs/q-and-a.md b/docs/q-and-a.md
@@ -30,7 +30,7 @@ Unlike the DIF Spec-Up repository, the Spec-Up-T repository **does not generate
 
 This functionality has been moved to the Spec-Up-T *installer*.
 
-For more details, refer to [the installation section in the admin guide](admins-guide.md#installation).
+For more details, refer to [the installation section in the admin guide](roles/admins-guide.md#installation).
 
 :::
 
@@ -66,7 +66,7 @@ The **resulting github.io site is intended for any user** interested in the cont
 
 ## Do you have a how-to video to get started with Spec-Up-T?
 
-Yes. Find it here: [Instruction starter package](admins-guide.md#short-video)
+Yes. Find it here: [Instruction starter package](roles/admins-guide.md#short-video)
 
 ## Where can I find the motivation of this move to create the Spec-Up bolt on "Spec-Up-T"?
 

diff --git a/docs/this-site-maintainers.md b/docs/this-site-maintainers.md
@@ -10,6 +10,6 @@ Here you will find information about things specific to this site.
 
 The [demo page](spec-up-t-demo-site.mdx) contains an example of a Spec-Up-T installation in an iFrame. This `index.html` file is in `/static/spec-up-t-demo/docs/`.
 
-This `index.html` file is a standard Spec-Up-T installation, as described in the [admin section](admins-guide.md#installation).
+This `index.html` file is a standard Spec-Up-T installation, as described in the [admin section](roles/admins-guide.md#installation).
 
 This `index.html` file is located in the GitHub repository of this site (the site you are now reading). The Spec-Up-T installation that generated the index file is not stored in any repository since it is a standard installation. You can install and generate it anywhere on your computer, then copy the index file to `/static/spec-up-t-demo/docs/`.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -68,4 +68,4 @@ HTTP stands for HyperText Transfer Protocol. It is the foundation of any data ex

		#### Automation

		The above scripts can easily be triggered by [github actions](glossary#github-actions). See [this repo's example](https://github.com/decentralized-identity/spec-up/blob/master/.github/workflows/render-specs.yml)
		The above scripts can easily be triggered by [github actions](../glossary#github-actions). See [this repo's example](https://github.com/decentralized-identity/spec-up/blob/master/.github/workflows/render-specs.yml)