Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create, style, and populate the Tutorials section #2689

Merged
merged 38 commits into from
Jul 8, 2024
Merged
Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
38 commits
Select commit Hold shift + click to select a range
977d93d
chore: Attempting to create the Tutorials navbar item
yuliiiah Apr 22, 2024
ccaeac9
Merge branch 'master' into doc-951-new
yuliiiah Jun 25, 2024
969ac60
docs: Move tutorial over to the new directort and finish basic setup
yuliiiah Jun 27, 2024
ee7f7bd
docs: Styling for the tutorials sidebar
yuliiiah Jun 27, 2024
63d8a02
chore: Fix gitleaks
yuliiiah Jun 27, 2024
75dc07f
chore: Finish styling the tutorials sidebar
yuliiiah Jun 28, 2024
a3837f6
chore: Remove non-getting-started tutorials from the docs and fix bro…
yuliiiah Jun 28, 2024
0d36121
chore: Fix the sidebar styles based on team feedback
yuliiiah Jun 28, 2024
9dacf7e
docs: add tutorials landing page
addetz Jun 28, 2024
33cf136
docs: conditionally hide index on simple card
addetz Jun 28, 2024
bfa1a54
Update docs/docs-content/tutorials/tutorials.md
addetz Jun 28, 2024
14f740a
docs: fix formatting
addetz Jun 28, 2024
1223d88
Update docs/docs-content/tutorials/tutorials.md
addetz Jun 28, 2024
0e67f3b
docs: fix formatting
addetz Jun 28, 2024
b98b466
docs: reword landing page
addetz Jun 28, 2024
7ad480c
docs: fix gap on hideNumber cards
addetz Jun 28, 2024
3fe38f1
Doc 951 tutorial side bar (#3180)
nageshsairam1610 Jul 1, 2024
72152e1
fix side bar
nageshsairam1610 Jul 3, 2024
e87fe3a
remove svg reference
nageshsairam1610 Jul 3, 2024
36946c3
add border to privacy settings
nageshsairam1610 Jul 3, 2024
bfafbbc
Update sidebars.js
nageshsairam1610 Jul 3, 2024
e759409
chore: Resolve rebase
yuliiiah Jul 3, 2024
ef47135
chore: Add more margin to the Privacy Settings in Docs
yuliiiah Jul 3, 2024
d5d5da4
chore: Add redirects for the deleted tutorials
yuliiiah Jun 28, 2024
64bf3a3
Merge branch 'doc-951-new-side-bar' into doc-951-new
yuliiiah Jul 3, 2024
d6cc985
chore: Clean up old privacy settings from docusaurus.config
yuliiiah Jul 3, 2024
4754ded
fa import issue
yuliiiah Jul 3, 2024
da4deab
fix import issue
nageshsairam1610 Jul 4, 2024
97d987d
Update light-mode.scss
nageshsairam1610 Jul 4, 2024
27005c7
Merge branch 'doc-951-new-side-bar' into doc-951-new
yuliiiah Jul 4, 2024
803e82f
docs: Update README
yuliiiah Jul 8, 2024
5a7a9d2
chore: Update the package-lock.json file
yuliiiah Jul 8, 2024
6d5a223
docs: Rename Profiles > Profiles and Packs, move Deploy a Custom Pack…
yuliiiah Jul 8, 2024
f55c115
Merge branch 'master' into doc-951-new
yuliiiah Jul 8, 2024
77356a0
chore: Resolve the strange merge situation
yuliiiah Jul 8, 2024
d75236a
chore: Comment out empty categories
yuliiiah Jul 8, 2024
0046977
chore: Fix broken links
yuliiiah Jul 8, 2024
f18c5d5
Merge branch 'master' into doc-951-new
yuliiiah Jul 8, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitleaksignore
Original file line number Diff line number Diff line change
Expand Up @@ -110,3 +110,6 @@ e4040084011d4d7935a589959b96ebc5cfba7a94:docs/docs-content/integrations/kubernet
e4040084011d4d7935a589959b96ebc5cfba7a94:docs/docs-content/integrations/kubernetes.md:generic-api-key:1125
e4040084011d4d7935a589959b96ebc5cfba7a94:docs/docs-content/integrations/kubernetes.md:generic-api-key:391
87bf9f7353f94ac2ecf85da3be3412202de7b72f:docusaurus.config.js:generic-api-key:363
969ac609f82bacb36093c429adfc096c5a97e10f:docs/docs-content/tutorials/cluster-deployment/pde/deploy-app.md:generic-api-key:1195
969ac609f82bacb36093c429adfc096c5a97e10f:docs/docs-content/tutorials/cluster-deployment/pde/deploy-app.md:generic-api-key:1232
969ac609f82bacb36093c429adfc096c5a97e10f:docs/docs-content/tutorials/edge/deploy-cluster.md:generic-api-key:240
Original file line number Diff line number Diff line change
Expand Up @@ -894,6 +894,6 @@ After building the Edge artifacts and creating an Edge cluster profile, the next
image to prepare your Edge host. To learn more about utilizing Edge artifacts to prepare Edge hosts and deploy
Palette-managed Edge clusters, we encourage you to check out the reference resources below. <br />

- [Deploy an Edge Cluster on VMware](../../site-deployment/deploy-cluster.md)
- [Deploy an Edge Cluster on VMware](../../../../tutorials/edge/deploy-cluster.md)

- [Prepare Edge Host for Installation](../../site-deployment/stage.md)
2 changes: 1 addition & 1 deletion docs/docs-content/clusters/pcg/pcg.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,4 +41,4 @@ existing Kubernetes cluster. Refer to the table below to learn more about the su

- [Manage a PCG](./manage-pcg/manage-pcg.md)

- [Deploy App Workloads with a PCG](./deploy-app-pcg.md)
- [Deploy App Workloads with a PCG](../../tutorials/cluster-deployment/pcg/deploy-app-pcg.md)
Original file line number Diff line number Diff line change
Expand Up @@ -1380,8 +1380,9 @@ Palette assures consistency across cluster deployments through cluster profiles.
deploy applications to a Kubernetes environment with little or no prior Kubernetes knowledge. In a matter of minutes,
you were able to provision a new Kubernetes cluster and deploy an application.

We encourage you to check out the [Deploy an Application using Palette Dev Engine](/devx/apps/deploy-app) tutorial to
learn more about Palette. Palette Dev Engine can help you deploy applications more quickly through the usage of
We encourage you to check out the
yuliiiah marked this conversation as resolved.
Show resolved Hide resolved
[Deploy an Application using Palette Dev Engine](/tutorials/cluster-deployment/pde/deploy-app) tutorial to learn more
about Palette. Palette Dev Engine can help you deploy applications more quickly through the usage of
[virtual clusters](../../glossary-all.md#palette-virtual-cluster). Feel free to check out the reference links below to
learn more about Palette.

Expand Down
2 changes: 1 addition & 1 deletion docs/docs-content/devx/apps/apps.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ Check out the resource links below to learn more about Apps.

- [App Logs](logs.md)

- [Deploy an Application using the Palette Dev Engine](deploy-app.md)
- [Deploy an Application using the Palette Dev Engine](../../tutorials/cluster-deployment/pde/deploy-app.md)
3 changes: 2 additions & 1 deletion docs/docs-content/devx/apps/create-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ Use the following steps to create and deploy an app to a virtual cluster.
:::info

A tutorial is available to help you learn how to use Palette Dev Engine by deploying an application. Check out
[Deploy an Application using Palette Dev Engine](deploy-app.md) to get started with Palette Dev Engine.
[Deploy an Application using Palette Dev Engine](../../tutorials/cluster-deployment/pde/deploy-app.md) to get started
with Palette Dev Engine.

:::

Expand Down
5 changes: 3 additions & 2 deletions docs/docs-content/devx/devx.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,9 @@ each mode.

## Get Started

To get started with App Mode, give the tutorial [Deploy an Application using Palette Dev Engine](apps/deploy-app.md) a
try so that you can learn how to use App Mode with Palette Dev Engine.
To get started with App Mode, give the tutorial
[Deploy an Application using Palette Dev Engine](../tutorials/cluster-deployment/pde/deploy-app.md) a try so that you
can learn how to use App Mode with Palette Dev Engine.

## Supported Platforms

Expand Down
2 changes: 1 addition & 1 deletion docs/docs-content/devx/enterprise-user.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ started. Create your application profiles and deploy your applications to Palett

Use the following resource to get started with PDE today.

- [Tutorial](./apps/deploy-app.md).
- [Tutorial](../tutorials/cluster-deployment/pde/deploy-app.md).

- Learn about [App Mode versus Cluster Mode](../introduction/palette-modes.md).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ Palette users can deploy CockroachDB to a virtual cluster by using the following
7. Deploy the app profile to a Palette Virtual Cluster. Use the
[Deploy a Virtual Cluster](../../../clusters/palette-virtual-clusters/deploy-virtual-cluster.md#deploy-a-virtual-cluster)
guide for additional guidance or check out the
[Deploy an Application using Palette Dev Engine](../../apps/deploy-app.md) tutorial.
[Deploy an Application using Palette Dev Engine](../../../tutorials/cluster-deployment/pde/deploy-app.md) tutorial.

### Validate

Expand Down
3 changes: 2 additions & 1 deletion docs/docs-content/devx/services/service-listings/vault.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,8 @@ Use the following steps to learn how to deploy Vault to your virtual cluster.

7. Deploy the app profile to a Palette Virtual Cluster. Use the
[Deploy a Virtual Cluster](../../../clusters/palette-virtual-clusters/deploy-virtual-cluster.md) guide for additional
guidance or check out the [Deploy an Application using Palette Dev Engine](../../apps/deploy-app.md) tutorial.
guidance or check out the
[Deploy an Application using Palette Dev Engine](../../../tutorials/cluster-deployment/pde/deploy-app.md) tutorial.

### Validate

Expand Down
5 changes: 3 additions & 2 deletions docs/docs-content/getting-started/deploy-k8s-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -350,5 +350,6 @@ In this tutorial, you used the cluster profile you created in the previous
[Create a Cluster Profile](./create-cluster-profile.md) tutorial to deploy a host cluster onto your preferred cloud
service provider. After the cluster deployed, you verified the Hello Universe application was successfully deployed.

We recommend that you continue to the [Deploy Cluster Profile Updates](./update-k8s-cluster.md) tutorial to learn how to
update your host cluster.
We recommend that you continue to the
yuliiiah marked this conversation as resolved.
Show resolved Hide resolved
[Deploy Cluster Profile Updates](../tutorials/cluster-management/update-maintain/update-k8s-cluster.md) tutorial to
learn how to update your host cluster.
5 changes: 3 additions & 2 deletions docs/docs-content/getting-started/terraform.md
Original file line number Diff line number Diff line change
Expand Up @@ -554,8 +554,9 @@ podman rmi --force ghcr.io/spectrocloud/tutorials:1.1.3
In this tutorial, you created a cluster profile, which is a template that contains the core layers required to deploy a
host cluster. You then deployed a host cluster onto your preferred cloud service provider using Terraform.

We encourage you to check out the [Deploy an Application using Palette Dev Engine](../devx/apps/deploy-app.md) tutorial
to learn more about Palette. Palette Dev Engine can help you deploy applications more quickly through the usage of
We encourage you to check out the
yuliiiah marked this conversation as resolved.
Show resolved Hide resolved
[Deploy an Application using Palette Dev Engine](../tutorials/cluster-deployment/pde/deploy-app.md) tutorial to learn
more about Palette. Palette Dev Engine can help you deploy applications more quickly through the usage of
[virtual clusters](../glossary-all.md#palette-virtual-cluster). Feel free to check out the reference links below to
learn more about Palette.

Expand Down
4 changes: 2 additions & 2 deletions docs/docs-content/integrations/community_packs.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ integrations with Spectro Cloud Palette.
We welcome all contributions to the Spectro Cloud community packs, either by adding new packs or updating existing
packs. You can read our
[Contribution Guidelines](https://github.com/spectrocloud/pack-central?tab=readme-ov-file#contributing) in the community
packs repository. Check out the [Deploy a Custom Pack](../registries-and-packs/deploy-pack.md) tutorial to learn more
about how to build and deploy your own custom pack.
packs repository. Check out the [Deploy a Custom Pack](../tutorials/profiles/packs-registries/deploy-pack.md) tutorial
to learn more about how to build and deploy your own custom pack.

:::warning

Expand Down
2 changes: 1 addition & 1 deletion docs/docs-content/integrations/hello-universe.md
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,6 @@ data "spectrocloud_pack" "hellouniverse" {

- [Hello Universe GitHub Repository](https://github.com/spectrocloud/hello-universe)

- [Deploy a Custom Pack Tutorial](../registries-and-packs/deploy-pack.md)
- [Deploy a Custom Pack Tutorial](../tutorials/profiles/packs-registries/deploy-pack.md)

- [Registries and Packs](../registries-and-packs/registries-and-packs.md)
5 changes: 3 additions & 2 deletions docs/docs-content/integrations/kubernetes-support.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,5 +86,6 @@ To learn more about upgrading your cluster and cluster profiles, check out the r
- [Update a Cluster](../clusters/cluster-management/cluster-updates.md)
- [Version a Cluster Profile](../profiles/cluster-profiles/modify-cluster-profiles/version-cluster-profile.md)

We also recommend you check out [Deploy Cluster Profile Updates](../clusters/cluster-management/update-k8s-cluster.md)
tutorial to learn how to update your cluster profile.
We also recommend you check out
yuliiiah marked this conversation as resolved.
Show resolved Hide resolved
[Deploy Cluster Profile Updates](../tutorials/cluster-management/update-maintain/update-k8s-cluster.md) tutorial to
learn how to update your cluster profile.
Original file line number Diff line number Diff line change
Expand Up @@ -222,8 +222,8 @@ use it in a Kubernetes deployment configuration. This allows you to pull images
restrictions or limitations.

To learn more about Kubernetes and how to use it to deploy your application, check out
[Palette's Dev Engine](../../devx/apps/deploy-app.md) and how it can reduce the challenges often encountered with
deploying apps to Kubernetes. You can also read about
[Palette's Dev Engine](../../tutorials/cluster-deployment/pde/deploy-app.md) and how it can reduce the challenges often
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Vale.Terms] Use 'dev' instead of 'Dev'.

encountered with deploying apps to Kubernetes. You can also read about
[how to deploy a stateless frontend application](/kubernetes-knowlege-hub/tutorials/deploy-stateless-frontend-app) on
Kubernetes or join our
[slack channel](https://join.slack.com/t/spectrocloudcommunity/shared_invite/zt-1mw0cgosi-hZJDF_1QU77vF~qNJoPNUQ). Learn
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ create an app profile that contains a Helm chart.
:::info

A tutorial is available to help you learn how to use Palette Dev Engine by deploying an application. Check out
[Deploy an Application using Palette Dev Engine](../../../devx/apps/deploy-app.md) to get started with Palette Dev
Engine.
[Deploy an Application using Palette Dev Engine](../../../tutorials/cluster-deployment/pde/deploy-app.md) to get started
with Palette Dev Engine.

:::

Expand Down Expand Up @@ -98,8 +98,9 @@ Use the following steps to validate that your app profile is available and ready

5. Deploy your application to a virtual cluster to verify all the required configurations and dependencies are correct.
Review [Create and Manage Apps](../../../devx/apps/create-app.md) to learn how to deploy an app to a virtual cluster.
Check out the [Deploy an Application using Palette Dev Engine](../../../devx/apps/deploy-app.md) tutorial for a more
in-depth guide.
Check out the
[Deploy an Application using Palette Dev Engine](../../../tutorials/cluster-deployment/pde/deploy-app.md) tutorial
for a more in-depth guide.

## Next Steps

Expand All @@ -113,4 +114,4 @@ common third-party services such as databases, message queues, and more.

- [Create and Manage Apps](../../../devx/apps/create-app.md)

- [Deploy an Application using Palette Dev Engine](../../../devx/apps/deploy-app.md)
- [Deploy an Application using Palette Dev Engine](../../../tutorials/cluster-deployment/pde/deploy-app.md)
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ Use the following steps to create an app profile that contains a custom manifest
:::info

A tutorial is available to help you learn how to use Palette Dev Engine by deploying an application. Check out
[Deploy an Application using Palette Dev Engine](../../../devx/apps/deploy-app.md) to get started with Palette Dev
Engine.
[Deploy an Application using Palette Dev Engine](../../../tutorials/cluster-deployment/pde/deploy-app.md) to get started
with Palette Dev Engine.

:::

Expand Down Expand Up @@ -101,8 +101,9 @@ Use the following steps to validate that your app profile is available and ready

5. Deploy your application to a virtual cluster to verify all the required configurations and dependencies are correct.
Review [Create and Manage Apps](../../../devx/apps/create-app.md) to learn how to deploy an app to a virtual cluster.
Check out the [Deploy an Application using Palette Dev Engine](../../../devx/apps/deploy-app.md) tutorial for a more
in-depth guide.
Check out the
[Deploy an Application using Palette Dev Engine](../../../tutorials/cluster-deployment/pde/deploy-app.md) tutorial
for a more in-depth guide.

## Next Steps

Expand All @@ -116,4 +117,4 @@ common third-party services such as databases, message queues, and more.

- [Create and Manage Apps](../../../devx/apps/create-app.md)

- [Deploy an Application using Palette Dev Engine](../../../devx/apps/deploy-app.md)
- [Deploy an Application using Palette Dev Engine](../../../tutorials/cluster-deployment/pde/deploy-app.md)
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ object storage, database, and security services. Review the
:::info

A tutorial is available to help you learn how to use Palette Dev Engine by deploying an application. Check out
[Deploy an Application using Palette Dev Engine](../../../devx/apps/deploy-app.md) to get started with Palette Dev
Engine.
[Deploy an Application using Palette Dev Engine](../../../tutorials/cluster-deployment/pde/deploy-app.md) to get started
with Palette Dev Engine.

:::

Expand Down Expand Up @@ -82,8 +82,9 @@ Use the following steps to validate that your app profile is available and ready

5. Deploy your application to a virtual cluster to verify all the required configurations and dependencies are correct.
Review [Create and Manage Apps](../../../devx/apps/create-app.md) to learn how to deploy an app to a virtual cluster.
Check out the [Deploy an Application using Palette Dev Engine](../../../devx/apps/deploy-app.md) tutorial for a more
in-depth guide.
Check out the
[Deploy an Application using Palette Dev Engine](../../../tutorials/cluster-deployment/pde/deploy-app.md) tutorial
for a more in-depth guide.

## Next Steps

Expand All @@ -97,4 +98,4 @@ required for common third-party services such as databases, message queues, and

- [Create and Manage Apps](../../../devx/apps/create-app.md)

- [Deploy an Application using Palette Dev Engine](../../../devx/apps/deploy-app.md)
- [Deploy an Application using Palette Dev Engine](../../../tutorials/cluster-deployment/pde/deploy-app.md)
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,8 @@ Use the following steps to create a cluster profile by adding layers using Helm
[Profile Customization](../../../profile-customization.md).

For examples of pack structure for a Helm chart-based pack, review
[Build a Pack](../../../../registries-and-packs/deploy-pack.md#build-a-pack), and select the appropriate tab.
[Build a Pack](../../../../tutorials/profiles/packs-registries/deploy-pack.md#build-a-pack), and select the
appropriate tab.

:::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,8 @@ create a cluster profile by adding layers using manifests.
[Profile Customization](../../../profile-customization.md).

For examples of pack structure for a manifest-based pack, review
[Build a Pack](../../../../registries-and-packs/deploy-pack.md#build-a-pack), and select the appropriate tab.
[Build a Pack](../../../../tutorials/profiles/packs-registries/deploy-pack.md#build-a-pack), and select the
appropriate tab.

:::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ different from the legacy Pack registries. To interact with an OCI Pack registry
:::tip

For guidance on how to add a custom pack to an OCI pack registry, check out the
[Deploy a Custom Pack](../../deploy-pack.md) tutorial.
[Deploy a Custom Pack](../../../tutorials/profiles/packs-registries/deploy-pack.md) tutorial.

:::

Expand Down
4 changes: 4 additions & 0 deletions docs/docs-content/tutorials/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"position": 1000,
"className": "hidden-category"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Cluster Deployment",
"position": 30
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Data Center",
"position": 10
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Private Cloud Gateway",
"position": 20
}
Loading