Skip to content

Commit

Permalink
Created Index Page for Docs
Browse files Browse the repository at this point in the history
Signed-off-by: Matthew <[email protected]>
  • Loading branch information
mattLif committed Nov 19, 2024
1 parent 1bbbc34 commit ed94078
Showing 1 changed file with 64 additions and 0 deletions.
64 changes: 64 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# Index

- [Blogs](https://github.com/spiffe/tornjak/blob/main/docs/blogs.md)

Check failure on line 3 in docs/index.md

View workflow job for this annotation

GitHub Actions / lint

Spaces after list markers

docs/index.md:3:1 MD030/list-marker-space Spaces after list markers [Expected: 3; Actual: 2] https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md030.md

- [Debugging, Hints and Tips for Solving Common Problems with Tornjak](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-hints.md)

Check failure on line 5 in docs/index.md

View workflow job for this annotation

GitHub Actions / lint

Spaces after list markers

docs/index.md:5:1 MD030/list-marker-space Spaces after list markers [Expected: 3; Actual: 2] https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md030.md
- [Tornjak Deployment](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-hints.md#tornjak-deployment)

Check failure on line 6 in docs/index.md

View workflow job for this annotation

GitHub Actions / lint

Spaces after list markers

docs/index.md:6:5 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 2] https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md030.md
- [Tornjak Configuration](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-hints.md#tornjak-configuration)

Check failure on line 7 in docs/index.md

View workflow job for this annotation

GitHub Actions / lint

Spaces after list markers

docs/index.md:7:5 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 2] https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md030.md
- [User Management](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-hints.md#user-management)

Check failure on line 8 in docs/index.md

View workflow job for this annotation

GitHub Actions / lint

Spaces after list markers

docs/index.md:8:5 MD030/list-marker-space Spaces after list markers [Expected: 1; Actual: 2] https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md030.md

- [JSON Format for New Entry](https://github.com/spiffe/tornjak/blob/main/docs/newEntry-json-format.md)

Check failure on line 10 in docs/index.md

View workflow job for this annotation

GitHub Actions / lint

Spaces after list markers

docs/index.md:10:1 MD030/list-marker-space Spaces after list markers [Expected: 3; Actual: 2] https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md030.md

- [Server plugin: Authentication "Keycloak"](https://github.com/spiffe/tornjak/blob/main/docs/plugin_server_authentication_keycloak.md)

Check failure on line 12 in docs/index.md

View workflow job for this annotation

GitHub Actions / lint

Spaces after list markers

docs/index.md:12:1 MD030/list-marker-space Spaces after list markers [Expected: 3; Actual: 2] https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md030.md

- [Server plugin: Authorization "RBAC"](https://github.com/spiffe/tornjak/blob/main/docs/plugin_server_authorization_rbac.md)

Check failure on line 14 in docs/index.md

View workflow job for this annotation

GitHub Actions / lint

Spaces after list markers

docs/index.md:14:1 MD030/list-marker-space Spaces after list markers [Expected: 3; Actual: 2] https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md030.md

- [Server plugin: Datastore "SQL"](https://github.com/spiffe/tornjak/blob/main/docs/plugin_server_datastore_sql.md)

Check failure on line 16 in docs/index.md

View workflow job for this annotation

GitHub Actions / lint

Spaces after list markers

docs/index.md:16:1 MD030/list-marker-space Spaces after list markers [Expected: 3; Actual: 2] https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md030.md

- [Server plugin: SPIRECRDManager](https://github.com/spiffe/tornjak/blob/main/docs/plugin_server_spirecrd.md)

Check failure on line 18 in docs/index.md

View workflow job for this annotation

GitHub Actions / lint

Spaces after list markers

docs/index.md:18:1 MD030/list-marker-space Spaces after list markers [Expected: 3; Actual: 2] https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md030.md

- [Tornjak Agent](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-agent.md)
- [Tornjak SPIRE Server Agent](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-agent.md#tornjak-spire-server-agent)
- [APIs](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-agent.md#apis)
- [Authentication](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-agent.md#authentication)
- [Authorization](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-agent.md#authorization)

- [Tornjak Manager](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-manager.md)
- [Global Visibility](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-manager.md#global-visibility)
- [Identity Policy Management](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-manager.md#identity-policy-management)
- [Auditability of Identities And Use For Operations/Forensics](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-manager.md#auditability-of-identities-and-use-for-operationsforensics)
- [Management of SPIRE Identity Configurations](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-manager.md#management-of-spire-identity-configurations)

- [Tornjak Plan](https://github.com/spiffe/tornjak/blob/main/docs/newEntry-json-format.md)
- [Milestone A: Global Visibility](https://github.com/spiffe/tornjak/blob/main/docs/newEntry-json-format.md#milestone-a-global-visibility)
- [Milestone B: Global Visibility + Authentication](https://github.com/spiffe/tornjak/blob/main/docs/newEntry-json-format.md#milestone-b-global-visibility--authentication)
- [Milestone C: Policy management](https://github.com/spiffe/tornjak/blob/main/docs/newEntry-json-format.md#milestone-c-policy-management)
- [Milestone D: Improve Policy definitions and UX](https://github.com/spiffe/tornjak/blob/main/docs/newEntry-json-format.md#milestone-d-improve-policy-definitions-and-ux)
- [Milestone E: Auditability](https://github.com/spiffe/tornjak/blob/main/docs/newEntry-json-format.md#milestone-e-auditability)
- [Milestone F: Advanced Authentication](https://github.com/spiffe/tornjak/blob/main/docs/newEntry-json-format.md#milestone-f-advanced-authentication)
- [Milestone G: Enhancing SPIRE API](https://github.com/spiffe/tornjak/blob/main/docs/newEntry-json-format.md#milestone-g-enhancing-spire-api)

- [Tornjak Server Configuration Reference](https://github.com/spiffe/tornjak/blob/main/docs/config-tornjak-server.md)
- [Command line options](https://github.com/spiffe/tornjak/blob/main/docs/config-tornjak-server.md#command-line-options)
- [The Tornjak Config](https://github.com/spiffe/tornjak/blob/main/docs/config-tornjak-server.md#the-tornjak-config)
- [General Tornjak Server Configs](https://github.com/spiffe/tornjak/blob/main/docs/config-tornjak-server.md#general-tornjak-server-configs)
- [About Tornjak Plugins](https://github.com/spiffe/tornjak/blob/main/docs/config-tornjak-server.md#about-tornjak-plugins)
- [Sample Configuration Files](https://github.com/spiffe/tornjak/blob/main/docs/config-tornjak-server.md#sample-configuration-files)
- [Further Reading](https://github.com/spiffe/tornjak/blob/main/docs/config-tornjak-server.md#further-reading)

- [Tornjak UI-API Documentation](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-ui-api-documentation.md)
- [Overview](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-ui-api-documentation.md#11-overview)
- [Tornjak User Interface (UI) Architecture](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-ui-api-documentation.md#2-tornjak-user-interface-ui-architecture)
- [UI Pages (With their paths)](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-ui-api-documentation.md#21-ui-pages-with-their-paths)
- [Tornjak User Interface (UI) Interaction with API Endpoints](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-ui-api-documentation.md#3-tornjak-user-interface-ui-interaction-with-api-endpoints)
- [Agent API’s](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-ui-api-documentation.md#31-tornjak-apis)
- [Manager API’s](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-ui-api-documentation.md#32-manager-apis)
- [Tornjak Redux Reducers and Actions With Their Respective Descriptions](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-ui-api-documentation.md#4-tornjak-redux-reducers-and-actions-with-their-respective-descriptions)
- [Reducers](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-ui-api-documentation.md#41-reducers)
- [Actions](https://github.com/spiffe/tornjak/blob/main/docs/tornjak-ui-api-documentation.md#42-actions)

- [User Management](https://github.com/spiffe/tornjak/blob/main/docs/user-management.md)
- [Overview](https://github.com/spiffe/tornjak/blob/main/docs/user-management.md#overview)
- [Architecture](https://github.com/spiffe/tornjak/blob/main/docs/user-management.md#architecture)
- [General Deployment](https://github.com/spiffe/tornjak/blob/main/docs/user-management.md#general-deployment)
- [Examples and Tutorials](https://github.com/spiffe/tornjak/blob/main/docs/user-management.md#examples-and-tutorials)

0 comments on commit ed94078

Please sign in to comment.