From 2847e925cb6d3a3d3a9d147f02f1075a3db27438 Mon Sep 17 00:00:00 2001 From: bwendlandt-intel Date: Wed, 27 Sep 2023 14:02:42 -0700 Subject: [PATCH] site: upgrade to material 9 --- .github/workflows/mkdocs_build.yml | 2 +- docs/GetStarted/buildRPC.md | 2 +- docs/GetStarted/createProfileACM.md | 4 +-- docs/GetStarted/createProfileCCM.md | 2 +- docs/GetStarted/setup.md | 2 +- docs/Glossary.md | 2 +- docs/Reference/RPC/buildRPC_Manual.md | 2 +- docs/Reference/faq.md | 4 +-- docs/Reference/productionVault.md | 2 +- docs/Reference/troubleshooting.md | 2 +- docs/Tutorials/uitoolkitReact.md | 4 +-- docs/overrides/partials/footer.html | 40 --------------------------- mkdocs.yml | 15 ++++++++-- readme.md | 4 +-- 14 files changed, 29 insertions(+), 58 deletions(-) delete mode 100644 docs/overrides/partials/footer.html diff --git a/.github/workflows/mkdocs_build.yml b/.github/workflows/mkdocs_build.yml index 7ba1f6f65..879537d83 100644 --- a/.github/workflows/mkdocs_build.yml +++ b/.github/workflows/mkdocs_build.yml @@ -33,7 +33,7 @@ jobs: # Runs a single command using the runners shell - name: Run a one-line script run: | - pip install mkdocs-material==8.5.6 + pip install mkdocs-material==9.2.7 pip install mkdocs-render-swagger-plugin pip install mkdocs-macros-plugin pip install mkdocs-mermaid2-plugin diff --git a/docs/GetStarted/buildRPC.md b/docs/GetStarted/buildRPC.md index 380f73208..c91c8df4d 100644 --- a/docs/GetStarted/buildRPC.md +++ b/docs/GetStarted/buildRPC.md @@ -21,7 +21,7 @@ Developed in Go* programming language, the Remote Provisioning Client (RPC) appl ## Build the RPC !!! tip "Flexible Deployment - RPC as a Library" - The RPC can be built as an executable file or as a library, which offers the flexibility of deploying in your management agent or client. [Read more about building RPC as a library here](../../Reference/RPC/libraryRPC/). + The RPC can be built as an executable file or as a library, which offers the flexibility of deploying in your management agent or client. [Read more about building RPC as a library here](../Reference/RPC/libraryRPC.md). **To build the executable:** diff --git a/docs/GetStarted/createProfileACM.md b/docs/GetStarted/createProfileACM.md index e9e648f30..73cf6dd4f 100644 --- a/docs/GetStarted/createProfileACM.md +++ b/docs/GetStarted/createProfileACM.md @@ -18,7 +18,7 @@ Admin Control Mode (ACM) provides full access to Intel® Active Management Techn #### Provisioning Certificate -By purchasing a certificate, you'll be able to remotely activate an Intel® AMT device in ACM. This feature enables you to disable User Consent. Provisioning Certificates are available from four different Certificate Authorities. [Find more information about Provisioning Certificates](../../Reference/Certificates/remoteProvisioning). +By purchasing a certificate, you'll be able to remotely activate an Intel® AMT device in ACM. This feature enables you to disable User Consent. Provisioning Certificates are available from four different Certificate Authorities. [Find more information about Provisioning Certificates](../Reference/Certificates/remoteProvisioning.md). - [Comodo](https://www.intel.com/content/www/us/en/support/articles/000054981/technologies.html) - [DigiCert](https://www.intel.com/content/www/us/en/support/articles/000055009/technologies.html) @@ -68,7 +68,7 @@ A Profile provides configuration information to the AMT Firmware during the acti ??? note "Note - More Information about Passwords" **Passwords** - Open AMT Cloud Toolkit increases security with multiple passwords. Find an explanation of toolkit passwords in [Reference -> Architecture Overview](../../Reference/architectureOverview#passwords). + Open AMT Cloud Toolkit increases security with multiple passwords. Find an explanation of toolkit passwords in [Reference -> Architecture Overview](../Reference/architectureOverview.md#passwords). **To create an ACM profile:** diff --git a/docs/GetStarted/createProfileCCM.md b/docs/GetStarted/createProfileCCM.md index 89f356f9f..18b094e3c 100644 --- a/docs/GetStarted/createProfileCCM.md +++ b/docs/GetStarted/createProfileCCM.md @@ -22,7 +22,7 @@ Profiles provide configuration information to the firmware on platforms featurin ??? note "Note - More Information about Passwords" - Open AMT Cloud Toolkit increases security with multiple passwords. Find an explanation of toolkit passwords in [Reference -> Architecture Overview](../../Reference/architectureOverview#passwords). + Open AMT Cloud Toolkit increases security with multiple passwords. Find an explanation of toolkit passwords in [Reference -> Architecture Overview](../Reference/architectureOverview.md#passwords). **To create a CCM profile:** diff --git a/docs/GetStarted/setup.md b/docs/GetStarted/setup.md index 4fe86afb0..da86267d5 100644 --- a/docs/GetStarted/setup.md +++ b/docs/GetStarted/setup.md @@ -44,7 +44,7 @@ The `.env.template` file is used by docker to set environment variables. | MPS_COMMON_NAME | Development System IP Address. | For connecting to MPS server via UI or APIs. **WARNING: Do not use localhost. Use the development system IP Address.**| | MPS_WEB_ADMIN_USER | Username of your choice | For logging into the Sample Web UI | | MPS_WEB_ADMIN_PASSWORD | **Strong** password of your choice | For logging into the Sample Web UI | - | MPS_JWT_SECRET | A strong secret of your choice (Example: A unique, random 256-bit string. See another example in [code snippet below](./#set-kong-json-web-token-jwt)). | Used when generating a JSON Web Token (JWT) for authentication. This example implementation uses a symmetrical key and HS256 to create the signature. [Learn more about JWT](https://jwt.io/introduction){target=_blank}.| + | MPS_JWT_SECRET | A strong secret of your choice (Example: A unique, random 256-bit string. See another example in [code snippet below](#set-kong-json-web-token-jwt)). | Used when generating a JSON Web Token (JWT) for authentication. This example implementation uses a symmetrical key and HS256 to create the signature. [Learn more about JWT](https://jwt.io/introduction){target=_blank}.| | POSTGRES_PASSWORD | **Strong** password of your choice | For logging into the Postgres | | VAULT_TOKEN | **Strong** token of your choice | For logging into the vault | diff --git a/docs/Glossary.md b/docs/Glossary.md index 3d0887cdd..50af14cde 100644 --- a/docs/Glossary.md +++ b/docs/Glossary.md @@ -115,7 +115,7 @@ Open Active Management Technology (Open AMT) Cloud Toolkit, also referred to as **[vcpkg](https://github.com/microsoft/vcpkg):** A command-line application that helps manage package creation and C and C++ libraries on Windows*, Linux*, and MacOS*. -**[Vault storage]((https://deepsource.io/blog/setup-vault-kubernetes/#:~:text=Vault%20provides%20a%20Kubernetes%20authentication,vault%20auth%20enable%20kubernetes%20Success!)):** A service that manages encryption and storage of infrastructure secrets. +**[Vault storage](https://www.vaultproject.io/):** A service that manages encryption and storage of infrastructure secrets. ## W diff --git a/docs/Reference/RPC/buildRPC_Manual.md b/docs/Reference/RPC/buildRPC_Manual.md index f6c44767e..f524efcbb 100644 --- a/docs/Reference/RPC/buildRPC_Manual.md +++ b/docs/Reference/RPC/buildRPC_Manual.md @@ -35,7 +35,7 @@ Developed in Go* programming language, the Remote Provisioning Client (RPC) appl ## Build RPC !!! tip "Flexible Deployment - RPC as a Library" - The RPC can be built as an executable file or as a library, which offers the flexibility of deploying in your management agent or client. [Read more about building RPC as a library here](./libraryRPC/). + The RPC can be built as an executable file or as a library, which offers the flexibility of deploying in your management agent or client. [Read more about building RPC as a library here](./libraryRPC.md). **To build the executable:** diff --git a/docs/Reference/faq.md b/docs/Reference/faq.md index 0dbfa2dd2..57fc70f93 100644 --- a/docs/Reference/faq.md +++ b/docs/Reference/faq.md @@ -44,8 +44,8 @@ Sometimes, newer features may be available as **pre-release**. These are feature ### How do I find more information about the MPS and RPS configuration files and security details? -Details and descriptions of configuration options can be found in [MPS Configuration](../MPS/configuration/) and [RPS Configuration](../RPS/configuration/). +Details and descriptions of configuration options can be found in [MPS Configuration](./MPS/configuration.md) and [RPS Configuration](./RPS/configuration.md). -Security information can be found in [MPS Security Information](../MPS/securityMPS/) and [RPS Security Information](../RPS/securityRPS/). +Security information can be found in [MPS Security Information](./MPS/securityMPS.md) and [RPS Security Information](./RPS/securityRPS.md).
\ No newline at end of file diff --git a/docs/Reference/productionVault.md b/docs/Reference/productionVault.md index 5b3136e92..b08afbd83 100644 --- a/docs/Reference/productionVault.md +++ b/docs/Reference/productionVault.md @@ -4,7 +4,7 @@ Learn how to run MPS and RPS using Vault in production server mode. The current ## Configure the Toolkit -1. Follow steps to Get the Toolkit, Set Environment Variables, and Set Kong JSON Web Token in the [Get Started guide](../../GetStarted/setup). +1. Follow steps to Get the Toolkit, Set Environment Variables, and Set Kong JSON Web Token in the [Get Started guide](../GetStarted/setup.md). 2. Update the vault section in the `docker-compose.yml` file with the section below. ``` yaml diff --git a/docs/Reference/troubleshooting.md b/docs/Reference/troubleshooting.md index 6c814ffc7..b29d7c4f3 100644 --- a/docs/Reference/troubleshooting.md +++ b/docs/Reference/troubleshooting.md @@ -89,7 +89,7 @@ This can occur due to the WSMan messages being received out of order during comm ### RPC -More information about specific RPC error codes can be found in the [RPC Library Documentation](../RPC/libraryRPC/#rpc-error-code-charts). +More information about specific RPC error codes can be found in the [RPC Library Documentation](./RPC/libraryRPC.md#rpc-error-code-charts). | Error Issue or Message | Possible Solutions | | ------------- | ------------------ | diff --git a/docs/Tutorials/uitoolkitReact.md b/docs/Tutorials/uitoolkitReact.md index b198c1ecb..b0c67b397 100644 --- a/docs/Tutorials/uitoolkitReact.md +++ b/docs/Tutorials/uitoolkitReact.md @@ -102,7 +102,7 @@ The code snippet below adds KVM control to the React application. | :----------- | :-------------- | | `deviceId` | **Replace the example deviceId** value with the GUID of the Intel® AMT device. See [How to Find GUIDs in Intel® AMT](../Reference/guids.md). | | `mpsServer` | **Replace the localhost** with the IP Address or FQDN of your MPS Server.

**When using Kong**, `/mps/ws/relay` must be appended to the IP or FQDN. | - | `authToken` | **Provide valid JWT.** Redirection requires a redirection-specific authentication token. [See the `/authorize/redirection/{guid}` GET API in the Auth section.](../APIs/indexMPS.md){target=_blank}

For a general example on how to make an API call and how to get a auth token from `/authorize` to pass to `/authorize/redirection/{guid}`, see [Generating a JWT by using an Authorize API call](../apiTutorial/#generate-a-jwt){target=_blank}. | + | `authToken` | **Provide valid JWT.** Redirection requires a redirection-specific authentication token. [See the `/authorize/redirection/{guid}` GET API in the Auth section.](../APIs/indexMPS.md){target=_blank}

For a general example on how to make an API call and how to get a auth token from `/authorize` to pass to `/authorize/redirection/{guid}`, see [Generating a JWT by using an Authorize API call](./apiTutorial.md#generate-a-jwt){target=_blank}. | ``` javascript hl_lines="8 9 11" @@ -146,7 +146,7 @@ You will see the errors in the following scenarios: - Compilation errors if the ui-toolkit was not downloaded and installed to your react app. - MPS/RPS server not running, appropriate controls will fail to work. - MPS server running and device not connected. -- Incorrect or invalid JWT for authToken, see instructions on [Generating a JWT by using an Authorize API call](../apiTutorial/#generate-a-jwt){target=_blank}. +- Incorrect or invalid JWT for authToken, see instructions on [Generating a JWT by using an Authorize API call](./apiTutorial.md#generate-a-jwt){target=_blank}. !!! example "Example authToken Format from API Call" diff --git a/docs/overrides/partials/footer.html b/docs/overrides/partials/footer.html deleted file mode 100644 index 2fb8466a7..000000000 --- a/docs/overrides/partials/footer.html +++ /dev/null @@ -1,40 +0,0 @@ - - -{% import "partials/language.html" as lang with context %} - - - \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index cbf0a0e26..cfbad39eb 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,6 +1,6 @@ # Project information site_name: "Open Active Management Technology Cloud Toolkit" -site_url: "https://open-amt-cloud-toolkit.github.io/docs" +site_url: "https://open-amt-cloud-toolkit.github.io/docs/" repo_url: "https://github.com/open-amt-cloud-toolkit/open-amt-cloud-toolkit" repo_name: "open-amt-cloud-toolkit/open-amt-cloud-toolkit" copyright: "Copyright © 2021 Intel Corporation" @@ -23,6 +23,7 @@ theme: - search.highlight - navigation.top - toc.integrate + - content.code.copy custom_dir: ./docs/overrides palette: # Palette toggle for automatic mode @@ -33,7 +34,7 @@ theme: # Palette toggle for light mode - media: "(prefers-color-scheme: light)" - scheme: custom + primary: custom toggle: icon: material/brightness-7 name: Switch to dark mode @@ -175,6 +176,16 @@ plugins: - macros - img2fig extra: + social: + - icon: fontawesome/brands/discord + link: https://discord.gg/yrcMp2kDWh + name: Join Us on Discord + - icon: fontawesome/brands/docker + link: https://hub.docker.com/search?q=intel%2Foact + name: Find our Dockerhub Images + - icon: fontawesome/brands/github + link: https://github.com/open-amt-cloud-toolkit + name: Open AMT Github Repository version: provider: mike default: diff --git a/readme.md b/readme.md index 5e401a151..cd2a006fb 100644 --- a/readme.md +++ b/readme.md @@ -13,12 +13,12 @@ In order to render and preview the site locally (without docker) you will need a 2) After python is installed, you'll need the following python dependencies: - `pip install mkdocs` -- `pip install mkdocs-material==8.5.6` +- `pip install mkdocs-material==9.2.7` - `pip install mkdocs-render-swagger-plugin` - `pip install mkdocs-mermaid2-plugin` - `pip install mkdocs-macros-plugin` - `pip install mkdocs-img2fig-plugin` - **Single line command:** `pip install mkdocs mkdocs-material==8.5.6 mkdocs-render-swagger-plugin mkdocs-mermaid2-plugin mkdocs-macros-plugin mkdocs-img2fig-plugin` + **Single line command:** `pip install mkdocs mkdocs-material==9.2.7 mkdocs-render-swagger-plugin mkdocs-mermaid2-plugin mkdocs-macros-plugin mkdocs-img2fig-plugin` 3) Once you have all the pre-reqs installed. You can simply run `mkdocs serve` and view the rendered content locally and makes changes to your documentation and preview them in realtime with a browser open.