Merge remote-tracking branch 'origin/master' into edge-tailscale

spectrocloud · Jan 12, 2024 · df2b934 · df2b934
2 parents d8bdc5a + 44beea9
commit df2b934
Show file tree

Hide file tree

Showing 113 changed files with 1,517 additions and 917 deletions.
diff --git a/.github/workflows/pull_request.yaml b/.github/workflows/pull_request.yaml
@@ -51,6 +51,7 @@ jobs:
           reporter: github-pr-review
           vale_flags: --glob=*.{md} --minAlertLevel=error
           fail_on_error: false
+          version: 2.28.2
         env:
           GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
 

diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
@@ -112,6 +112,16 @@ jobs:
           fetch-depth: 0
           token: ${{ secrets.GITHUB_TOKEN }}
 
+      - name: Retrieve Credentials
+        id: import-secrets
+        uses: hashicorp/vault-action@v2
+        with:
+          url: https://vault.prism.spectrocloud.com
+          method: approle
+          roleId: ${{ secrets.VAULT_ROLE_ID }}
+          secretId: ${{ secrets.VAULT_SECRET_ID }}
+          secrets: /providers/github/organizations/spectrocloud/token?org_name=spectrocloud token | VAULT_GITHUB_TOKEN
+
       - name: Setup Nodejs
         uses: actions/setup-node@v3
         with:
@@ -123,5 +133,5 @@ jobs:
 
       - name: "release"
         env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{ steps.import-secrets.outputs.VAULT_GITHUB_TOKEN }}
         run: npx semantic-release
diff --git a/.gitignore b/.gitignore
@@ -36,7 +36,7 @@ link_report.*
 palette-docs.pdf
 
 docs/api-content/api-docs/v1/*.mdx
-docs/api-content/api-docs/v1/sidebar.js
+docs/api-content/api-docs/v1/sidebar.*
 
 # Versions Content
 versions.json

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,19 @@
+# [4.2.0](https://github.com/spectrocloud/librarium/compare/v4.1.0...v4.2.0) (2024-01-07)
+
+
+### Features
+
+* 4.2 release ([6731901](https://github.com/spectrocloud/librarium/commit/67319019639ea03258aba4103e559a7f8f8742ab))
+* release 4.2 ([#1976](https://github.com/spectrocloud/librarium/issues/1976)) ([f126287](https://github.com/spectrocloud/librarium/commit/f12628767b7dfcdf9eb6718e6d0fecd1f450ffab))
+
+# [4.2.0](https://github.com/spectrocloud/librarium/compare/v4.1.0...v4.2.0) (2024-01-07)
+
+
+### Features
+
+* 4.2 release ([6731901](https://github.com/spectrocloud/librarium/commit/67319019639ea03258aba4103e559a7f8f8742ab))
+* release 4.2 ([#1976](https://github.com/spectrocloud/librarium/issues/1976)) ([f126287](https://github.com/spectrocloud/librarium/commit/f12628767b7dfcdf9eb6718e6d0fecd1f450ffab))
+
 # 1.0.0 (2023-09-01)
 
 

diff --git a/README.md b/README.md
@@ -19,7 +19,7 @@ To contribute, we recommend having the following software installed locally on y
 
 - git configured and access to github repository
 
-- Node.js and npm (optional)
+- Node.js v18 and npm.
 
 - [Vale](https://vale.sh/docs/vale-cli/installation/)
 
@@ -153,8 +153,8 @@ sidebar_custom_props:
 | `sidebar_custom_props:`<br>` icon: "graph"`  | string  | one of icons from https://fontawesome.com/icons?d=gallery                                       |      
 | `hide_table_of_contents`         | boolean | setting this to `false` will hide the page from the navigation                                              |
 | `sidebar_position`               | number  | the position of the page in the navigation sidebar. The pages are sorted ascending by this value            |
-| `toc_min_heading_level`          | number | the minimum heading level to show in the table of contents.                                                  |
-| `toc_max_heading_level`          | number | the maximum heading level to show in the table of contents.                                                  | 
+| `toc_min_heading_level`          | number | the minimum heading level to show in the table of contents. The default value for all documents is `2`.      |
+| `toc_max_heading_level`          | number | the maximum heading level to show in the table of contents. The default value for all documents is `3`.      | 
 | `tags`                           | array  |  A list of string that can be used for additonal categorization of content.                                  | 
 | `keywords`                      | array  |  A list of strings that areused for SEO purposes.                                                             |
 ### Sub pages
@@ -441,7 +441,6 @@ Result
 ### Admonitions - Warning / Info / Tip / Danger
 
 
-
 :::caution
 
 Some **content** with _Markdown_ `syntax`.
@@ -469,15 +468,15 @@ The content must have a new line at the beginning and at the end of the tag.
 
 ### Video
 
-To add a video, use the following syntax:
+To add a video, use the following syntax. Ensure you capitalize the letter "V":
 
 ```
-<video src="/aws-full-profile.mp4"></video>
+<Video src="/aws-full-profile.mp4"></Video>
 ```
 
 
 ```
-<video title="vsphere-pcg-creation" src="/cluster-creation-videos/vmware.mp4"></video>
+<Video title="vsphere-pcg-creation" src="/cluster-creation-videos/vmware.mp4"></Video>
 ```
 
 ## Netlify Previews

diff --git a/apisidebar.js b/apisidebar.js
@@ -11,6 +11,14 @@
 //   versionCrumb,
 // } = require("docusaurus-plugin-openapi-docs/lib/sidebars/utils");
 
+const fs = require('fs');
+const sidebarFilePath = './docs/api-content/api-docs/v1/sidebar.ts';
+
+let sidebarItems = [];
+if (fs.existsSync(sidebarFilePath)) {
+  sidebarItems = require(sidebarFilePath);
+}
+
 module.exports = {
   apiSidebar: [
     {
@@ -35,13 +43,7 @@ module.exports = {
         type: "generated-index",
         title: "Palette API V1",
       },
-      items: (() => {
-        try {
-          return require("./docs/api-content/api-docs/v1/sidebar.js");
-        } catch (error) {
-          return [];
-        }
-      })(),
+      items: sidebarItems,
     },
   ],
 };
diff --git a/archiveVersions.json b/archiveVersions.json
@@ -1,4 +1,4 @@
 {   
-    "4.0.0": "https://version-4-0.legacy.docs.spectrocloud.com",
+    "v4.0.x": "https://version-4-0.legacy.docs.spectrocloud.com",
     "v3.4.x and prior": "https://version-3-4.legacy.docs.spectrocloud.com"
 }
diff --git a/docs/api-content/api-docs/1-introduction.md b/docs/api-content/api-docs/1-introduction.md
@@ -194,7 +194,7 @@ The API rate limits are as follows:
 | /v1/overlords | 10 | 5 | 50 |
 | /v1/cluster | 10 | 5 | 50 |
 | /v1/cloudconfigs | 10 | 5 | 50 |
-| /v1/cloudconfigs/{cloudType}/{uid}/machinePools | 10 | 5 | 50 |
+| /v1/cloudconfigs/\{cloudType}/\{uid}/machinePools | 10 | 5 | 50 |
 | /v1/edgehosts | 10 | 5 | 50 |
 | /v1/metrics | 10 | 5 | 50 |
 | /v1/system | 10 | 5 | 50 |
@@ -203,8 +203,8 @@ The API rate limits are as follows:
 | /v1/clouds | 10 | 5 | 50 |
 | /v1/events/components | 10 | 5 | 50 |
 | /v1/dashboard | 10 | 5 | 50 |
-| /v1/cloudconfigs/{cloudType}/:uid/machinePools/{machinePoolName}/machines | 10 | 5 | 50 |
-| /v1/cloudconfigs/{cloudType}/:uid/machinePools/{machinePoolName}/machines/:machineUid | 10 | 5 | 50 |
+| /v1/cloudconfigs/\{cloudType}/:uid/machinePools/\{machinePoolName}/machines | 10 | 5 | 50 |
+| /v1/cloudconfigs/\{cloudType}/:uid/machinePools/\{machinePoolName}/machines/:machineUid | 10 | 5 | 50 |
 | /v1/auth/authenticate | 10 | 5 | 50 |
 | /v1/auth/services/login | 10 | 5 | 50 |
 | /v1/auth/services/edge/login | 10 | 5 | 50 |
@@ -223,7 +223,7 @@ The API rate limits are as follows:
 | /v1/clusterprofiles | 50 | 5 | 250 |
 | /v1/clusterprofiles/:uid/packs | 50 | 5 | 250 |
 | /v1/clusterprofiles/:uid/packs/manifests | 50 | 5 | 250 |
-| /v1/clusterprofiles/:uid/packs/{packName}/manifests | 50 | 5 | 250 |
+| /v1/clusterprofiles/:uid/packs/\{packName}/manifests | 50 | 5 | 250 |
 | /v1/clusterprofiles/validate/packs | 50 | 5 | 250 |
 | /v1/clusterprofiles/:uid/validate/packs | 50 | 5 | 250 |
 | /v1/spectroclusters/:uid/profiles | 50 | 5 | 250 |