Prepare docs for docusaurus

Author: bfjelds

.github/workflows/docs-build.yml

@@ -1,10 +1,7 @@
 name: Build docs
-
 permissions: {}
-
 on:
   workflow_call: {}
-
 jobs:
   build-docs:
     name: jekyll github pages build
@@ -45,9 +42,8 @@ jobs:
       working-directory: ./docs
       env:
         PAGES_PATH: ${{ steps.pages.outputs.base_path }}
-
     - name: Upload site assets as artifact
       id: deployment
       uses: actions/upload-pages-artifact@v3
       with:
-        path: ./docs/_site
+        path: ./docs/_site

README.md

@@ -12,7 +12,7 @@ currently hosts **Image Customizer**, a robust image customization tool.
 
 It is a tool that supports multiple formats and customizations features. Full
 list can be found in [supported
-operations](docs/imagecustomizer/api/configuration.md)
+operations](docs/imagecustomizer/api/configuration/index.md)
 
 
 ## Getting Started

docs/imagecreator/README.md

@@ -1,6 +1,7 @@
 ---
 title: Image Creator
 nav_order: 3
+sidebar_position: 0
 has_toc: false
 ---
 
@@ -28,7 +29,7 @@ recommended to use Image Customizer on top of the seed image produced by Image C
 - API Documentation:
   - [CLI](./api/cli.md) - Learn about the available command-line interface
     commands for Image Creator
-  - [Configuration](./api/configuration.md) - Understand how to configure Image
+  - [Configuration](./api/configuration/configuration.md) - Understand how to configure Image
     Creator to suit your needs
 
 ## Help and Feedback

docs/imagecreator/api/index.md renamed to docs/imagecreator/api/api.md

@@ -2,6 +2,7 @@
 parent: Image Creator
 title: API
 nav_order: 1
+sidebar_position: 1
 ---
 
 # Image Creator API

docs/imagecreator/api/cli.md

@@ -3,6 +3,7 @@ title: Command line
 parent: API
 grand_parent: Image Creator
 nav_order: 3
+sidebar_position: 3
 ---
 
 # Image Creator command line
@@ -63,7 +64,7 @@ The file path of the YAML (or JSON) configuration file that specifies the config
 to be created.
 
 For documentation on the supported configuration options, see:
-[Image Creator configuration](./configuration.md)
+[Image Creator configuration](./configuration/configuration.md)
 
 ## --rpm-source=PATH
 

docs/imagecreator/api/configuration.md

@@ -0,0 +1,4 @@
+{
+    "label": "Configuration",
+    "position": 1
+}

docs/imagecreator/api/configuration/_category_.json

@@ -14,14 +14,14 @@ Contains the options for provisioning disks, partitions, and file systems.
 You should specify the disks, partitions and filesystems for creating a image these cannot be empty.
 
 For supported fields in the storage level of the configuration refer to
-[schema](../../api/configuration.md#schema-overview)
+[schema](../../api/configuration/configuration.md#schema-overview)
 
 ## os [[os](../../../imagecustomizer/api/configuration/os.md)]
 
 Contains the configuration options for the OS.
 
 For supported fields in the os level of the configuration refer to
-[schema](../../api/configuration.md#schema-overview)
+[schema](../../api/configuration/configuration.md#schema-overview)
 
 Example:
 
@@ -56,7 +56,7 @@ Supported options:
 
 - `package-snapshot-time`: Enables snapshot-based package filtering during image
   customization. This allows specifying a cutoff timestamp using the
-  [`--package-snapshot-time`](../../../imagecustomizer/api/cli.md#--package-snapshot-time) CLI option or
+  [`--package-snapshot-time`](../../../imagecustomizer/api/cli/cli.md#--package-snapshot-time) CLI option or
   [`os.packages.snapshotTime`](../../../imagecustomizer/api/configuration/packages.md#snapshottime-string) API field.
   If both are provided, the CLI value takes precedence.
 

docs/imagecreator/api/configuration/config.md

@@ -0,0 +1,85 @@
+---
+parent: API
+grand_parent: Image Creator
+title : Configuration
+nav_order: 2
+sidebar_position: 1
+has_toc: false
+---
+
+# Image Creator configuration
+
+The Image Creator is configured using a YAML (or JSON) file.
+
+## Top-level
+
+The top level type for the YAML file is the [config](./config.md) type.
+
+## Schema Overview
+
+- [config type](./config.md)
+  - [storage](../../../imagecustomizer/api/configuration/config.md#storage-storage)
+    - [bootType](../../../imagecustomizer/api/configuration/storage.md#boottype-string)
+    - [disks](../../../imagecustomizer/api/configuration/storage.md#disks-disk) ([disk type](../../../imagecustomizer/api/configuration/disk.md))
+      - [partitionTableType](../../../imagecustomizer/api/configuration/disk.md#partitiontabletype-string)
+      - [maxSize](../../../imagecustomizer/api/configuration/disk.md#maxsize-uint64)
+      - [partitions](../../../imagecustomizer/api/configuration/disk.md#partitions-partition) ([partition type](../../../imagecustomizer/api/configuration/partition.md))
+        - [id](../../../imagecustomizer/api/configuration/partition.md#id-string)
+        - [label](../../../imagecustomizer/api/configuration/partition.md#label-string)
+        - [start](../../../imagecustomizer/api/configuration/partition.md#start-uint64)
+        - [end](../../../imagecustomizer/api/configuration/partition.md#end-uint64)
+        - [size](../../../imagecustomizer/api/configuration/partition.md#size-uint64)
+        - [type](../../../imagecustomizer/api/configuration/partition.md#type-string)
+    - [filesystems](../../../imagecustomizer/api/configuration/storage.md#filesystems-filesystem) ([filesystem type](../../../imagecustomizer/api/configuration/filesystem.md))
+      - [deviceId](../../../imagecustomizer/api/configuration/filesystem.md#deviceid-string)
+      - [type](../../../imagecustomizer/api/configuration/filesystem.md#type-string)
+      - [mountPoint](../../../imagecustomizer/api/configuration/filesystem.md#mountpoint-mountpoint) ([mountPoint type](../../../imagecustomizer/api/configuration/mountpoint.md))
+        - [idType](../../../imagecustomizer/api/configuration/mountpoint.md#idtype-string)
+        - [options](../../../imagecustomizer/api/configuration/mountpoint.md#options-string)
+        - [path](../../../imagecustomizer/api/configuration/mountpoint.md#path-string)
+    - [resetPartitionsUuidsType](../../../imagecustomizer/api/configuration/storage.md#resetpartitionsuuidstype-string)
+    - [kernelCommandLine](../../../imagecustomizer/api/configuration/iso.md#kernelcommandline-kernelcommandline) ([kernelCommandLine type](../../../imagecustomizer/api/configuration/kernelcommandline.md))
+      - [extraCommandLine](../../../imagecustomizer/api/configuration/kernelcommandline.md#extracommandline-string)
+    - [initramfsType](../../../imagecustomizer/api/configuration/iso.md#initramfstype-string)
+  - [os](../../../imagecustomizer/api/configuration/config.md#os-os) ([os type](../../../imagecustomizer/api/configuration/os.md))
+    - [bootloader](../../../imagecustomizer/api/configuration/os.md#bootloader-bootloader) ([bootloader type](../../../imagecustomizer/api/configuration/bootloader.md))
+      - [resetType](../../../imagecustomizer/api/configuration/bootloader.md#resettype-string)
+    - [hostname](../../../imagecustomizer/api/configuration/os.md#hostname-string)
+    - [kernelCommandLine](../../../imagecustomizer/api/configuration/os.md#kernelcommandline-kernelcommandline) ([kernelCommandLine type](../../../imagecustomizer/api/configuration/kernelcommandline.md))
+      - [extraCommandLine](../../../imagecustomizer/api/configuration/kernelcommandline.md#extracommandline-string)
+    - [packages](../../../imagecustomizer/api/configuration/os.md#packages-packages) ([packages type](../../../imagecustomizer/api/configuration/packages.md))
+      - [installLists](../../../imagecustomizer/api/configuration/packages.md#installlists-string)
+      - [install](../../../imagecustomizer/api/configuration/packages.md#install-string)
+      - [snapshotTime](../../../imagecustomizer/api/configuration/packages.md#snapshottime-string)
+    - [additionalFiles](../../../imagecustomizer/api/configuration/os.md#additionalfiles-additionalfile) ([additionalFile type](../../../imagecustomizer/api/configuration/additionalfile.md))
+      - [source](../../../imagecustomizer/api/configuration/additionalfile.md#source-string)
+      - [content](../../../imagecustomizer/api/configuration/additionalfile.md#content-string)
+      - [destination](../../../imagecustomizer/api/configuration/additionalfile.md#destination-string)
+      - [permissions](../../../imagecustomizer/api/configuration/additionalfile.md#permissions-string)
+    - [additionalDirs](../../../imagecustomizer/api/configuration/os.md#additionaldirs-dirconfig) ([dirConfig type](../../../imagecustomizer/api/configuration/dirconfig.md))
+      - [source](../../../imagecustomizer/api/configuration/dirconfig.md#source-string)
+      - [destination](../../../imagecustomizer/api/configuration/dirconfig.md#destination-string)
+      - [newDirPermissions](../../../imagecustomizer/api/configuration/dirconfig.md#newdirpermissions-string)
+      - [mergedDirPermissions](../../../imagecustomizer/api/configuration/dirconfig.md#mergeddirpermissions-string)
+      - [childFilePermissions](../../../imagecustomizer/api/configuration/dirconfig.md#childfilepermissions-string)
+    - [imageHistory](../../../imagecustomizer/api/configuration/os.md#imagehistory-string)
+  - [scripts](../../../imagecustomizer/api/configuration/config.md#scripts-scripts) ([scripts type](../../../imagecustomizer/api/configuration/scripts.md))
+    - [postCustomization](../../../imagecustomizer/api/configuration/scripts.md#postcustomization-script) ([script type](../../../imagecustomizer/api/configuration/script.md))
+      - [path](../../../imagecustomizer/api/configuration/script.md#path-string)
+      - [content](../../../imagecustomizer/api/configuration/script.md#content-string)
+      - [interpreter](../../../imagecustomizer/api/configuration/script.md#interpreter-string)
+      - [arguments](../../../imagecustomizer/api/configuration/script.md#arguments-string)
+      - [environmentVariables](../../../imagecustomizer/api/configuration/script.md#environmentvariables-mapstring-string)
+      - [name](../../../imagecustomizer/api/configuration/script.md#name-string)
+    - [finalizeCustomization](../../../imagecustomizer/api/configuration/scripts.md#finalizecustomization-script) ([script type](../../../imagecustomizer/api/configuration/script.md))
+      - [path](../../../imagecustomizer/api/configuration/script.md#path-string)
+      - [content](../../../imagecustomizer/api/configuration/script.md#content-string)
+      - [interpreter](../../../imagecustomizer/api/configuration/script.md#interpreter-string)
+      - [arguments](../../../imagecustomizer/api/configuration/script.md#arguments-string)
+      - [environmentVariables](../../../imagecustomizer/api/configuration/script.md#environmentvariables-mapstring-string)
+      - [name](../../../imagecustomizer/api/configuration/script.md#name-string)
+  - [previewFeatures type](../../../imagecustomizer/api/configuration/config.md#previewfeatures-string)
+  - [output](../../../imagecustomizer/api/configuration/config.md#output-output) ([output type](../../../imagecustomizer/api/configuration/output.md))
+    - [image](../../../imagecustomizer/api/configuration/output.md#image-outputimage) ([outputImage type](../../../imagecustomizer/api/configuration/outputImage.md))
+      - [path](../../../imagecustomizer/api/configuration/outputImage.md#path-string)
+      - [format](../../../imagecustomizer/api/configuration/outputImage.md#format-string)

docs/imagecreator/api/configuration/configuration.md

@@ -1,6 +1,7 @@
 ---
 parent: Image Creator
 nav_order: 5
+sidebar_position: 5
 ---
 
 # Developers guide