diff --git a/docs/intro.md b/docs/intro.md deleted file mode 100644 index dcf80e4835..0000000000 --- a/docs/intro.md +++ /dev/null @@ -1,281 +0,0 @@ ---- -slug: / -pagination_next: null -hide_table_of_contents: true ---- - -# Home - -
- - -
-
- -
-
- - -
-
- -
-
- - -
-
- - - -
-
- - -
-
- -
\ No newline at end of file diff --git a/docs/intro.mdx b/docs/intro.mdx new file mode 100644 index 0000000000..f47bcdfc80 --- /dev/null +++ b/docs/intro.mdx @@ -0,0 +1,407 @@ +--- +slug: / +pagination_next: null +title: Home +hide_table_of_contents: true +hide_title: true +--- + +import clsx from 'clsx'; + +
+

+ Welcome to Replicated Docs +

+

+ Learn how to use the Replicated Platform to secure and distribute your software to enterprise customers +

+
+ + Quick start + + + Browse product docs + +
+
+ +
+

Get started

+
+
+
+ + Lightbulb icon +

Explore labs

+

Learn about Replicated by completing common tasks in a lab environment

+ +
+
+ + Computer icon +

Set up your environment

+

Install required and optional tools on your local workstation

+ +
+
+ + Alien vault icon +

Follow the onboarding guide

+

Integrate Replicated features into your application releases

+ +
+
+
+
+ +
+
+
+
+ +
What's New
+

Announcing: Security Center (Alpha)

+

+ The Security Center (Alpha) makes it easier for vendors and their enterprise customers to monitor security risks, assess known vulnerabilities, and view security information for each release. +

+ +
+ +
+
+
+
Did You Know
+

Simulate Air Gap Networks With CMX

+

+ Set the network policy of VMs or VM-based clusters to `airgap` to simulate an environment with no outbound internet access. +

+ + Learn more → + +
+
+
+
+
+
+ +
+

Browse product documentation

+
+
+

Vendor Platform

+
+
+
+
+ Teams and Accounts +

Manage team members, RBAC, API tokens, and more

+
+
+
+
+ Applications +

Manage your application in the Vendor Portal

+
+
+
+
+ Channels and Releases +

Create and promote application versions

+
+
+
+
+ Customers and Licenses +

Manage customer records and license entitlements

+
+
+
+
+ Custom Domains +

Alias Replicated domains

+
+
+
+
+ Insights and Telemetry +

Get telemetry and event data from customer instances

+
+
+
+
+ Replicated CLI +

Use the CLI to manage applications, releases, and more

+
+
+
+
+ Vendor API +

Integrate Vendor Platform functionality into your workflows

+
+
+
+
+
+
+

Embedded Cluster

+
+
+
+
+ Overview +

Distribute a Kubernetes cluster and your application together as a single appliance

+
+
+
+
+ Embedded Cluster Config +

Embedded Cluster Config resource

+
+
+
+
+ Online Installation with Embedded Cluster +

Install with internet access using Embedded Cluster

+
+
+
+
+ Air Gap Installation with Embedded Cluster +

Install in environments without internet access

+
+
+
+
+ Perform Updates with Embedded Cluster +

Update an application and the cluster infrastructure

+
+
+
+
+
+
+

Helm CLI Installations

+
+
+
+
+ Overview +

An introduction to Helm CLI installations for applications distributed with Replicated

+
+
+
+
+ Install with the Helm CLI +

Install your application using Helm CLI

+
+
+
+
+ Install and Update with the Helm CLI in Air Gap Environments +

Use Helm in environments without internet access

+
+
+
+
+
+
+

Enterprise Portal

+
+
+
+
+ Overview +

Give customers access to releases and instance data

+
+
+
+
+ Customize the Enterprise Portal +

Configure branding and appearance for customers

+
+
+
+
+ Manage Enterprise Portal Access +

Invite and manage customer portal users

+
+
+
+
+ Use the Enterprise Portal +

Access and use the Enterprise Portal

+
+
+
+
+ Self-Service Sign-ups +

Enable self-service access to trial or community licenses for customers

+
+
+
+
+
+
+

Compatibility Matrix

+
+
+
+
+ Overview +

Test your application across customer-representative environments

+
+
+
+
+ CMX Pricing +

Learn about pricing for CMX clusters and VMs

+
+
+
+
+ Test in Air Gap Environments +

Simulate networks with no outbound internet access

+
+
+
+
+ Use CMX VMs +

Create and manage virtual machines for testing

+
+
+
+
+ Use CMX Clusters +

Create and manage Kubernetes clusters for testing

+
+
+
+
+ Test in CMX with CI/CD +

Automate testing workflows with continuous integration

+
+
+
+
+
+
+

Replicated Proxy Registry

+
+
+
+
+ Overview +

Grant proxy access to private images

+
+
+
+
+ Add and Manage External Registries +

Connect external image registries

+
+
+
+
+ Use the Proxy Registry with Embedded Cluster +

Proxy images for Embedded Cluster installations

+
+
+
+
+ Use the Proxy Registry with Helm CLI Installations +

Proxy images for Helm CLI installations

+
+
+
+
+ Connect to a Public Registry +

Pull images from public registries

+
+
+
+
+
+ +
+

Replicated SDK

+
+
+
+
+ Overview +

In-cluster service and API to integrate key Replicated functionality into your application

+
+
+
+
+ Install the Replicated SDK +

Install alongside an application or as a standalone component

+
+
+
+
+ Development Mode +

Develop against the SDK API to test changes locally

+
+
+
+
+ Replicated SDK API +

API reference for Replicated SDK endpoints

+
+
+
+
+ Customize the Replicated SDK +

Customize RBAC, set environment variables, add tolerations, and more

+
+
+
+
+
+
+

Troubleshoot

+
+
+
+
+ Overview +

Learn about troubleshooting tools for customer environments

+
+
+
+
+ Define Preflight Checks +

Verify that customer environments meet application requirements

+
+
+
+
+ Add and Customize Support Bundles +

Configure support bundles for troubleshooting

+
+
+
+
+ Generate Support Bundles +

Collect support bundles in customer environments

+
+
+
+
+ Inspect Support Bundles +

Analyze support bundles to troubleshoot issues

+
+
+
+
+ Submit a Support Request +

Contact Replicated support for assistance

+
+
+
+
+
+
+
\ No newline at end of file diff --git a/sidebars.js b/sidebars.js index c5759e313a..8a48eefb61 100644 --- a/sidebars.js +++ b/sidebars.js @@ -34,7 +34,7 @@ const sidebars = { }, //GET STARTED - {type: 'html', value: '
get started
', defaultStyle: true}, + {type: 'html', value: '
Get started
', defaultStyle: true}, 'intro-replicated', 'vendor/kots-faq', 'vendor/quick-start', @@ -69,7 +69,7 @@ const sidebars = { ], }, // PRODUCT DOCS - {type: 'html', value: '
product docs
', defaultStyle: true}, + {type: 'html', value: '
Product docs
', defaultStyle: true}, { type: 'category', label: 'Vendor Portal', @@ -839,12 +839,12 @@ const sidebars = { }, //OPEN SOURCE DOCS - {type: 'html', value: '
open source docs
', defaultStyle: true}, + {type: 'html', value: '
Open source docs
', defaultStyle: true}, {type: 'link', href: 'https://kurl.sh/docs/introduction/', label: 'kURL.sh'}, {type: 'link', href: 'https://troubleshoot.sh/docs/collect/', label: 'Troubleshoot.sh'}, // POLICIES - {type: 'html', value: '
platform overview
', defaultStyle: true}, + {type: 'html', value: '
Platform overview
', defaultStyle: true}, { type: 'category', label: 'Replicated Policies', @@ -891,4 +891,4 @@ const sidebars = { ], }; -module.exports = sidebars; +module.exports = sidebars; \ No newline at end of file diff --git a/src/components/CopyMarkdown.js b/src/components/CopyMarkdown.js index 95c1991584..e5c523fc7a 100644 --- a/src/components/CopyMarkdown.js +++ b/src/components/CopyMarkdown.js @@ -35,8 +35,8 @@ function CopyMarkdown() { ? currentPath.slice(0, -1) : currentPath; - // For the homepage/intro, use /intro.md specifically - const markdownPath = normalizedPath === '/' ? '/intro.md' : `${normalizedPath}.md`; + // For the homepage/intro, use /intro.mdx specifically + const markdownPath = normalizedPath === '/' ? '/intro.mdx' : `${normalizedPath}.md`; // Fetch the markdown content const response = await fetch(markdownPath); @@ -74,8 +74,8 @@ function CopyMarkdown() { ? currentPath.slice(0, -1) : currentPath; - // For the homepage/intro, use /intro.md specifically - const markdownPath = normalizedPath === '/' ? '/intro.md' : `${normalizedPath}.md`; + // For the homepage/intro, use /intro.mdx specifically + const markdownPath = normalizedPath === '/' ? '/intro.mdx' : `${normalizedPath}.md`; // Open in a new tab window.open(markdownPath, '_blank'); @@ -178,7 +178,11 @@ function CopyMarkdown() { if (!hasContent) { return null; } - + // Don't render on the homepage + if (window.location.pathname === '/') { + return null; + } + return (