Skip to content

Commit

Permalink
docs: update documentation portal (#8)
Browse files Browse the repository at this point in the history
  • Loading branch information
azrod authored Jan 2, 2025
1 parent 73bee4d commit 802fecc
Show file tree
Hide file tree
Showing 7 changed files with 79 additions and 5 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ This is a try to solve these issues :

## Documentation

For more information about the SuperSchema, please refer to the [documentation](https://github.frangipane.io/terraform/superschema/why).
For more information about the SuperSchema, please refer to the [documentation](https://orange-cloudavenue.github.io/terraform-plugin-framework-superschema/).
6 changes: 6 additions & 0 deletions docs/datasource_example.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
icon: material/home
hide:
- navigation
---

# cloudavenue_iam_user (Data Source)

The user data source allows you to read users in Cloud Avenue.
Expand Down
5 changes: 5 additions & 0 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
hide:
- navigation
---

# Getting Started

The following is a technical documentation on how to use superschema in your Terraform project.
Expand Down
9 changes: 9 additions & 0 deletions docs/why.md → docs/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
---
icon: material/home
hide:
- navigation
- toc
---

# Overview

SuperSchema allows you to write the Terraform schema for resources and datasources in a single definition, along with a common field that enables you to define default values. SuperSchema is compatible with [tfplugindocs](github.com/hashicorp/terraform-plugin-docs/cmd/tfplugindocs).

This is a try to solve these issues :
Expand Down
5 changes: 5 additions & 0 deletions docs/logic.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
hide:
- navigation
---

# SuperSchema logic

## superschema.Schema
Expand Down
5 changes: 5 additions & 0 deletions docs/resource_example.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
hide:
- navigation
---

# cloudavenue_iam_user (Resource)

The user resource allows you to manage local users in Cloud Avenue.
Expand Down
52 changes: 48 additions & 4 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,53 @@
site_name: Terraform SuperSchema
site_name: Terraform Framework SuperSchema


theme:
name: material
palette:
- scheme: orangeCorp
features:
# - navigation.sections
- navigation.tabs
- navigation.top
- content.code.annotate
- header.autohide
- navigation.instant
icon:
repo: fontawesome/brands/github-alt
favicon: https://opensource.orange.com/wp-content/themes/boosted/favicon.ico
logo: https://boosted.orange.com/docs/5.3/assets/brand/orange-logo.svg

extra_css:
- stylesheets/orange.css

nav:
- Why ?: "why.md"
- How to use it: "getting-started.md"
- SuperSchema logic : "logic.md"
- Overview: "index.md"
- How to use: "getting-started.md"
- Logic : "logic.md"
- ⇗ Other projects: "https://orange-cloudavenue.github.io/projects"


plugins:
- search

markdown_extensions:
- attr_list
- md_in_html
- pymdownx.highlight:
anchor_linenums: true
- admonition
- pymdownx.details
- pymdownx.superfences
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg

repo_url: https://github.com/orange-cloudavenue/terraform-plugin-framework-planmodifiers
repo_name: orange-cloudavenue/terraform-plugin-framework-planmodifiers

extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/orange-cloudavenue

copyright: Copyright © Orange 2025

0 comments on commit 802fecc

Please sign in to comment.