Created Index Page for Docs (#556)

* Created Index Page for Docs Signed-off-by: Matthew <[email protected]> * Lint Fix Signed-off-by: Matthew <[email protected]> * Removed Items and Switched to Relative Linking Signed-off-by: Matthew <[email protected]> * Moved Plugins to a Folder And Fixed All Linking to Them Signed-off-by: Matthew <[email protected]> * <Rename Index to README> Signed-off-by: Matthew <[email protected]> --------- Signed-off-by: Matthew <[email protected]>
spiffe · Dec 2, 2024 · e2278dd · e2278dd
1 parent caf39bd
commit e2278dd
Show file tree

Hide file tree

Showing 7 changed files with 56 additions and 5 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,51 @@
+# Index
+
+-   [Blogs](/docs/blogs.md)
+
+-   [Debugging, Hints and Tips for Solving Common Problems with Tornjak](/docs/tornjak-hints.md)
+    - [Tornjak Deployment](/docs/tornjak-hints.md#tornjak-deployment)
+    - [Tornjak Configuration](/docs/tornjak-hints.md#tornjak-configuration)
+    - [User Management](/docs/tornjak-hints.md#user-management)
+
+-   [JSON Format for New Entry](/docs/newEntry-json-format.md)
+
+-   [Server plugin: Authentication "Keycloak"](/docs/plugins/plugin_server_authentication_keycloak.md)
+
+-   [Server plugin: Authorization "RBAC"](/docs/plugins/plugin_server_authorization_rbac.md)
+
+-   [Server plugin: Datastore "SQL"](/docs/plugins/plugin_server_datastore_sql.md)
+
+-   [Server plugin: SPIRECRDManager](/docs/plugins/plugin_server_spirecrd.md)
+
+-   [Tornjak Agent](/docs/tornjak-agent.md)
+    - [Tornjak SPIRE Server Agent](/docs/tornjak-agent.md#tornjak-spire-server-agent)
+    - [APIs](/docs/tornjak-agent.md#apis)
+    - [Authentication](/docs/tornjak-agent.md#authentication)
+    - [Authorization](/docs/tornjak-agent.md#authorization)
+
+-   [Tornjak Manager](/docs/tornjak-manager.md)
+
+-   [Tornjak Plan](/docs/newEntry-json-format.md)
+
+-   [Tornjak Server Configuration Reference](/docs/config-tornjak-server.md)
+    - [Command line options](/docs/config-tornjak-server.md#command-line-options)
+    - [The Tornjak Config](/docs/config-tornjak-server.md#the-tornjak-config)
+    - [General Tornjak Server Configs](/docs/config-tornjak-server.md#general-tornjak-server-configs)
+    - [About Tornjak Plugins](/docs/config-tornjak-server.md#about-tornjak-plugins)
+    - [Sample Configuration Files](/docs/config-tornjak-server.md#sample-configuration-files)
+    - [Further Reading](/docs/config-tornjak-server.md#further-reading)
+
+-   [Tornjak UI-API Documentation](/docs/tornjak-ui-api-documentation.md)
+    -   [Overview](/docs/tornjak-ui-api-documentation.md#11-overview)
+    -   [Tornjak User Interface (UI) Architecture](/docs/tornjak-ui-api-documentation.md#2-tornjak-user-interface-ui-architecture)
+        - [UI Pages (With their paths)](/docs/tornjak-ui-api-documentation.md#21-ui-pages-with-their-paths)
+    -   [Tornjak User Interface (UI) Interaction with API Endpoints](/docs/tornjak-ui-api-documentation.md#3-tornjak-user-interface-ui-interaction-with-api-endpoints)
+        - [Agent API’s](/docs/tornjak-ui-api-documentation.md#31-tornjak-apis)
+        - [Manager API’s](/docs/tornjak-ui-api-documentation.md#32-manager-apis)
+    -   [Tornjak Redux Reducers and Actions With Their Respective Descriptions](/docs/tornjak-ui-api-documentation.md#4-tornjak-redux-reducers-and-actions-with-their-respective-descriptions)
+
+-   [User Management](/docs/user-management.md)
+    - [Overview](/docs/user-management.md#overview)
+    - [Architecture](/docs/user-management.md#architecture)
+    - [General Deployment](/docs/user-management.md#general-deployment)
+    - [Examples and Tutorials](/docs/user-management.md#examples-and-tutorials)
diff --git a/docs/config-tornjak-server.md b/docs/config-tornjak-server.md
@@ -83,10 +83,10 @@ Tornjak supports several different plugin types, each representing a different f
 
 | Type | Name | Description |
 | ---- | ---- | ----------- |
-| DataStore       | SQL | Default SQL storage for Tornjak metadata |
-| SPIRECRDManager | [""](/docs/plugin_server_spirecrd.md) | CRD Manager |
-| Authenticator   | [keycloak](/docs/plugin_server_authentication_keycloak.md) | Perform OIDC Discovery and extract roles from `realmAccess.roles` field |
-| Authorizer      | [RBAC](/docs/plugin_server_authorization_rbac.md) | Check api permission based on user role and defined authorization logic |
+| DataStore       | ["SQL"](/docs/plugins/plugin_server_datastore_sql.md) | Default SQL storage for Tornjak metadata |
+| SPIRECRDManager | ["SpireCRD"](/docs/plugins/plugin_server_spirecrd.md) | CRD Manager |
+| Authenticator   | [keycloak](/docs/plugins/plugin_server_authentication_keycloak.md) | Perform OIDC Discovery and extract roles from `realmAccess.roles` field |
+| Authorizer      | [RBAC](/docs/plugins/plugin_server_authorization_rbac.md) | Check api permission based on user role and defined authorization logic |
 
 ### Plugin configuration
 

diff --git a/.../plugin_server_authentication_keycloak.md → .../plugin_server_authentication_keycloak.md b/.../plugin_server_authentication_keycloak.md → .../plugin_server_authentication_keycloak.md
diff --git a/docs/plugin_server_authorization_rbac.md → ...ugins/plugin_server_authorization_rbac.md b/docs/plugin_server_authorization_rbac.md → ...ugins/plugin_server_authorization_rbac.md
diff --git a/docs/plugin_server_datastore_sql.md → docs/plugins/plugin_server_datastore_sql.md b/docs/plugin_server_datastore_sql.md → docs/plugins/plugin_server_datastore_sql.md
diff --git a/docs/plugin_server_spirecrd.md → docs/plugins/plugin_server_spirecrd.md b/docs/plugin_server_spirecrd.md → docs/plugins/plugin_server_spirecrd.md
diff --git a/docs/user-management.md b/docs/user-management.md
@@ -43,7 +43,7 @@ Once the Auth Server is set up, we can deploy the Tornjak Backend to require acc
 as detailed in
 [this followup Medium blog](https://medium.com/universal-workload-identity/guide-to-integrating-tornjak-with-keycloak-for-access-control-to-spire-40a3d5ee5f5a),
 with more details on the general configuration
-[here](/docs/config-tornjak-server.md). Most notably, populate a new plugin section for keycloak as defined [here](/docs/plugin_server_auth_keycloak.md) like so:
+[here](/docs/config-tornjak-server.md). Most notably, populate a new plugin section for keycloak as defined [here](/docs/plugins/plugin_server_auth_keycloak.md) like so:
 
 ```
 ...