Skip to content

Commit

Permalink
chore: upgrade to docusaurus 3.1.1 (#2135)
Browse files Browse the repository at this point in the history 
* upgrade to docusaurus 3.1.1

* fix most broken anchors

* fix more broken anchors

* fix new anchors

---------

Co-authored-by: Lenny Chen <[email protected]>
  • Loading branch information
@lennessyy
lennessyy and lennessyy authored Feb 2, 2024
1 parent ce62cac commit 2e10812
Show file tree
Hide file tree
Showing 18 changed files with 404 additions and 347 deletions.
6 changes: 3 additions & 3 deletions docs/api-content/api-docs/1-introduction.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ Every API's URI has the prefix of the version and the Palette resource, such as:

Palette supports two types of API authentication methods that can be used to authenticate API requests:

- [Authorization Token](#using-authorization-token)
- [Authorization Token](#authorization-token)

- [API Key](#using-the-api-key)
- [API Key](#api-key)

### Authorization Token

Expand Down Expand Up @@ -183,7 +183,7 @@ The API rate limits are as follows:
- There is a limit of ten API requests per second for each source IP address. The API supports additional bursts through
the usage of a burst queue. The default burst queue size is set to five. You could make 50 (10 \* 5) requests in
seconds before the API returns a `429 - TooManyRequests` error. Refer to the
[Endpoint Prefix Rate](#endpointprefixrate) for additional information.
[Endpoint Prefix Rate](#endpoint-prefix-rate) for additional information.

- API request limits are categorized by the parent resources, such as `/v1/cloudconfig/:uid` and `/v1/roles`. You can
find a list of all resource types in the [API documentation](/api/category/palette-api-v1). The requests are counted
Expand Down
2 changes: 1 addition & 1 deletion docs/docs-content/clusters/cluster-groups/create-cluster-group.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ Use the instructions below to create a cluster group.
:::
To enable virtual clusters for OpenShift, review the OpenShit
[instructions below](#enable-virtual-cluster-for-openshift).
[instructions below](#enable-virtual-clusters-for-openshift).
8. Click **Next** to complete the cluster group creation process.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs-content/clusters/data-center/maas/architecture.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ installation. A System Private Gateway is a PCG service that is enabled inside t
:::warning

Only self-hosted Palette instances support the option of using the System Private Gateway. Use the default
[PCG deployment](#private-cloud-gatewayy) option if you have NAT gateways or network firewalls between Palette and MAAS.
[PCG deployment](#private-cloud-gateway) option if you have NAT gateways or network firewalls between Palette and MAAS.

:::

Expand Down
2 changes: 1 addition & 1 deletion docs/docs-content/clusters/data-center/openstack.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -643,7 +643,7 @@ The following steps need to be performed to provision a new OpenStack cluster:
| **Enable Autoscaler** | You can enable the autoscaler, by toggling the **Enable Autoscaler** button. Autoscaler scales up and down resources between the defined minimum and the maximum number of nodes to optimize resource utilization. |
| | Set the scaling limit by setting the **Minimum Size** and **Maximum Size**, as per the workload the number of nods will scale up from minimum set value to maximum set value and the scale down from maximum set value to minimum set value |
| **Size** | Number of VMs to be provisioned for the node pool. |
| **Rolling Update** | Rolling update has two available options. Review the [Update Parameter](#update-parameter-table) table below for more details. |
| **Rolling Update** | Rolling update has two available options. The expand option launches a new node first, then shuts down old one. The contract option shuts down a old one first, then launches new one. |
| **[Labels](../cluster-management/taints.md#labels)** | Add a label to apply placement constraints on a pod, such as a node eligible for receiving the workload. |
| **[Taints](../cluster-management/taints.md#taints)** | To set toleration to pods and allow (but do not require) the pods to schedule onto nodes with matching taints. |
| **Instance type** | Select the compute instance type to be used for all nodes in the node pool. |
Expand Down
2 changes: 1 addition & 1 deletion docs/docs-content/clusters/data-center/vmware.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -748,7 +748,7 @@ Use the following steps to provision a new VMware cluster.
| **Enable Autoscaler** | You can enable the autoscaler by toggling the **Enable Autoscaler** button. Autoscaler scales resources up and down between the defined minimum and maximum number of nodes to optimize resource utilization. |
| | Set the scaling limit by setting the **Minimum Size** and **Maximum Size**, as per the workload the number of nods will scale up from minimum set value to maximum set value and the scale down from maximum set value to minimum set value |
| **Size** | Number of VMs to be provisioned for the node pool. |
| **Rolling Update** | Rolling update has two available options. Review the [Update Parameter](#update-parameter-table) table below for more details. |
| **Rolling Update** | Rolling update has two available options. The expand option launches a new node first, then shuts down old one. The contract option shuts down a old one first, then launches new one.details. |
| **[Labels](../cluster-management/taints.md#labels)** | Add a label to apply placement constraints on a pod, such as a node eligible for receiving the workload. |
| **[Taints](../cluster-management/taints.md#taints)** | To set toleration to pods and allow (but do not require) the pods to schedule onto nodes with matching taints. |
| **Instance type** | Select the compute instance type to be used for all nodes in the node pool. |
Expand Down
2 changes: 1 addition & 1 deletion docs/docs-content/clusters/public-cloud/aws/eks.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -273,7 +273,7 @@ For guidance in setting up kubectl, review the [Kubectl](../../cluster-managemen

- [Create an Infrastructure Profile](../../../profiles/cluster-profiles/create-cluster-profiles/create-infrastructure-profile.md)

- [EKS Cluster Encryption](#eks-cluster-secrets-encryption)
- [Enable Secrets Encryption for EKS Cluster](enable-secrets-encryption-kms-key.md)

- [Configure Custom OIDC](../../../integrations/kubernetes.md#configure-custom-oidc)

Expand Down
14 changes: 7 additions & 7 deletions docs/docs-content/clusters/public-cloud/azure/aks.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -127,13 +127,13 @@ The following steps need to be performed to provision a new cluster:

6. Complete the **Cluster config** section with the information for each parameter listed below.

| **Parameter** | **Description** |
| -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Subscription** | Select the subscription which is to be used to access Azure Services. |
| **Region** | Select a region in Azure in where the cluster should be deployed. |
| **Resource Group** | Select the resource group in which the cluster should be deployed. |
| **SSH Key** | The public SSH key for connecting to the nodes. Review Microsoft's [supported SSH](https://learn.microsoft.com/en-us/azure/virtual-machines/linux/mac-create-ssh-keys#supported-ssh-key-formats) formats. |
| **Static Placement** | By default, Palette uses dynamic placement. This creates a new VNet for the cluster that contains two subnets in different Availability Zones (AZs). Palette places resources in these clusters, manages the resources, and deletes them when the corresponding cluster is deleted.<br /><br />If you want to place resources into a pre-existing VNet, enable the **Static Placement** option, and fill out the input values listed in the [Static Placement](#static-placement-table) table below. |
| **Parameter** | **Description** |
| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Subscription** | Select the subscription which is to be used to access Azure Services. |
| **Region** | Select a region in Azure in where the cluster should be deployed. |
| **Resource Group** | Select the resource group in which the cluster should be deployed. |
| **SSH Key** | The public SSH key for connecting to the nodes. Review Microsoft's [supported SSH](https://learn.microsoft.com/en-us/azure/virtual-machines/linux/mac-create-ssh-keys#supported-ssh-key-formats) formats. |
| **Static Placement** | By default, Palette uses dynamic placement. This creates a new VNet for the cluster that contains two subnets in different Availability Zones (AZs). Palette places resources in these clusters, manages the resources, and deletes them when the corresponding cluster is deleted.<br /><br />If you want to place resources into a pre-existing VNet, enable the **Static Placement** option, and fill out the input values listed in the [Static Placement](#static-placement-settings) table below. |

#### Static Placement Settings

Expand Down
Loading

0 comments on commit 2e10812

Please sign in to comment.