Skip to content

Commit

Permalink
chore: #98 Initialize the references section content
Browse files Browse the repository at this point in the history
Signed-off-by: Laurent Broudoux <[email protected]>
  • Loading branch information
lbroudoux committed May 16, 2024
1 parent f96e5bb commit fd03354
Show file tree
Hide file tree
Showing 8 changed files with 114 additions and 1 deletion.
19 changes: 19 additions & 0 deletions content/documentation/references/artifacts-conventions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
draft: false
title: "Artifacts & Conventions"
date: 2024-04-30
publishdate: 2024-04-30
lastmod: 2024-05-16
weight: 2
---

> ♻️ **To Be Migrated**
>
> This is a new documentation page that has to be migrated from the different [&lt;Format&gt; Mocking and Testing](/documentation/archive/using/openapi), as part of our [Refactoring Effort](https://github.com/microcks/microcks.io/issues/81).
>
> **Goal of this page**
> * Expose the different conventions of artifacts
> * Supported versions of formats
> * Expected headers or notation if any
> * Expected naming schemes
> * Add a pointer to the new linter that allows debugging this
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
draft: false
title: "Helm Chart Parameters"
date: 2024-04-29
publishdate: 2024-04-29
lastmod: 2024-05-16
weight: 3
---

> 🪄 **To Be Created**
>
> This is a new documentation page that has to be written as part of our [Refactoring Effort](https://github.com/microcks/microcks.io/issues/81).
>
> **Goal of this page**
> * Comprehensive reference of Helm Chart parameters
> * Provide typical examples
16 changes: 16 additions & 0 deletions content/documentation/references/configuration/operator-config.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
draft: false
title: "Operator Configuration"
date: 2024-04-29
publishdate: 2024-04-29
lastmod: 2024-05-16
weight: 4
---

> 🪄 **To Be Created**
>
> This is a new documentation page that has to be written as part of our [Refactoring Effort](https://github.com/microcks/microcks.io/issues/81).
>
> **Goal of this page**
> * Comprehensive reference of Kubernetes Operator custom resources
> * Provide typical examples
16 changes: 16 additions & 0 deletions content/documentation/references/configuration/security-config.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
draft: false
title: "Security Configuration"
date: 2024-04-29
publishdate: 2024-04-29
lastmod: 2024-05-16
weight: 2
---

> 🪄 **To Be Created**
>
> This is a new documentation page that has to be written as part of our [Refactoring Effort](https://github.com/microcks/microcks.io/issues/81).
>
> **Goal of this page**
> * Comprehensive reference of Security related configuration in Microcks
> * Should include: Keycloak realm settings, User management and RBAC, repository organisation
2 changes: 1 addition & 1 deletion content/documentation/references/container-images.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
draft: false
title: "Container images"
title: "Container Images"
date: 2024-05-13
publishdate: 2024-05-13
lastmod: 2024-05-13
Expand Down
15 changes: 15 additions & 0 deletions content/documentation/references/metadada.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
draft: false
title: "API Metadata Format"
date: 2024-05-16
publishdate: 2024-05-16
lastmod: 2024-05-16
weight: 5
---

> ♻️ **To Be Migrated**
>
> This is a new documentation page that has to be migrated from [Microcks APIMetadata](/documentation/archive/using/metadata), as part of our [Refactoring Effort](https://github.com/microcks/microcks.io/issues/81).
>
> **Goal of this page**
> * Comprehensive reference of Test parameters only
16 changes: 16 additions & 0 deletions content/documentation/references/templates.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
draft: false
title: "Mock Templates"
date: 2020-02-11
publishdate: 2020-02-11
lastmod: 2024-05-16
weight: 3
---

> ♻️ **To Be Migrated**
>
> This is a new documentation page that has to be migrated from [Templating mock responses](/documentation/archive/using/templates), as part of our [Refactoring Effort](https://github.com/microcks/microcks.io/issues/81).
>
> **Goal of this page**
> * Comprehensive reference of functions
> * Comprehensive reference of placeholder notations
15 changes: 15 additions & 0 deletions content/documentation/references/test-endpoints.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
draft: false
title: "Test Endpoints"
date: 2024-04-29
publishdate: 2024-04-29
lastmod: 2024-05-16
weight: 4
---

> ♻️ **To Be Migrated**
>
> This is a new documentation page that has to be migrated from [Testing with Microcks](/documentation/archive/using/tests), as part of our [Refactoring Effort](https://github.com/microcks/microcks.io/issues/81).
>
> **Goal of this page**
> * Comprehensive reference of Test parameters only

0 comments on commit fd03354

Please sign in to comment.