-
Notifications
You must be signed in to change notification settings - Fork 213
Feature: Update Getting Started Guide #1395
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
base: main
Are you sure you want to change the base?
Conversation
Signed-off-by: Brian Kane <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
6 issues found across 12 files
Prompt for AI agents (all 6 issues)
Understand the root cause of the following 6 issues and fix them.
<file name="versioned_docs/version-v1.10/quick-start.md">
<violation number="1" location="versioned_docs/version-v1.10/quick-start.md:15">
Because this file lives at the version root, the `../getting-started/...` links resolve outside of the v1.10 docs (e.g. they become `/docs/getting-started/quick-install` instead of `/docs/v1.10/getting-started/quick-install`), leading to broken navigation. Please point these links to `./getting-started/...` (and update the other new `../…` links in this file as well).</violation>
</file>
<file name="docs/getting-started/advanced-application.md">
<violation number="1" location="docs/getting-started/advanced-application.md:1">
The duplicate front matter delimiter ends the metadata block early, so the page renders without its intended title metadata.</violation>
</file>
<file name="versioned_docs/version-v1.10/getting-started/advanced-application.md">
<violation number="1" location="versioned_docs/version-v1.10/getting-started/advanced-application.md:1">
The extra `---` line closes the front matter before the `title` entry, so the page renders `title: Deploy an Advanced Application` as body text and loses its metadata. Please collapse the front matter to a single block.</violation>
</file>
<file name="versioned_docs/version-v1.10/getting-started/quick-install.md">
<violation number="1" location="versioned_docs/version-v1.10/getting-started/quick-install.md:13">
Using https://static.kubevela.net/script/install-velad.sh fails because the site’s SSL certificate is expired, so newcomers cannot install VelaD by following these steps. Please switch to the working https://kubevela.io/script/install-velad.sh mirror.
(Based on your team's feedback about ensuring curl commands use reachable HTTPS URLs.) [FEEDBACK_USED]</violation>
</file>
<file name="docs/quick-start.md">
<violation number="1" location="docs/quick-start.md:15">
Because this Markdown heading sits inside a raw JSX <div>, it renders as literal text instead of a styled heading. Replace it with an explicit <h3> element (or move the content outside the JSX wrapper) so the step formats correctly.</violation>
</file>
<file name="docs/getting-started/first-application.md">
<violation number="1" location="docs/getting-started/first-application.md:313">
The links to “Deploy an Advanced Application” and “Understand Core Concepts” step outside the getting-started directory, so they resolve to nonexistent pages. Update both to use ./ to keep the current directory.</violation>
</file>
React with 👍 or 👎 to teach cubic. Mention @cubic-dev-ai to give feedback, ask questions, or re-run the review.
| <div className="getting-started-cards"> | ||
|
|
||
| * Create an environment for your first app. | ||
| ### 1. 📦 [Quick Install](../getting-started/quick-install) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Because this file lives at the version root, the ../getting-started/... links resolve outside of the v1.10 docs (e.g. they become /docs/getting-started/quick-install instead of /docs/v1.10/getting-started/quick-install), leading to broken navigation. Please point these links to ./getting-started/... (and update the other new ../… links in this file as well).
Prompt for AI agents
Address the following comment on versioned_docs/version-v1.10/quick-start.md at line 15:
<comment>Because this file lives at the version root, the `../getting-started/...` links resolve outside of the v1.10 docs (e.g. they become `/docs/getting-started/quick-install` instead of `/docs/v1.10/getting-started/quick-install`), leading to broken navigation. Please point these links to `./getting-started/...` (and update the other new `../…` links in this file as well).</comment>
<file context>
@@ -1,269 +1,59 @@
+<div className="getting-started-cards">
-* Create an environment for your first app.
+### 1. 📦 [Quick Install](../getting-started/quick-install)
+Choose between standalone installation (no Kubernetes required) or installing on an existing cluster.
</file context>
| ### 1. 📦 [Quick Install](../getting-started/quick-install) | |
| ### 1. 📦 [Quick Install](./getting-started/quick-install) |
| @@ -0,0 +1,429 @@ | |||
| --- | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The duplicate front matter delimiter ends the metadata block early, so the page renders without its intended title metadata.
Prompt for AI agents
Address the following comment on docs/getting-started/advanced-application.md at line 1:
<comment>The duplicate front matter delimiter ends the metadata block early, so the page renders without its intended title metadata.</comment>
<file context>
@@ -0,0 +1,429 @@
+---
+---
+title: Deploy an Advanced Application
</file context>
| @@ -0,0 +1,429 @@ | |||
| --- | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The extra --- line closes the front matter before the title entry, so the page renders title: Deploy an Advanced Application as body text and loses its metadata. Please collapse the front matter to a single block.
Prompt for AI agents
Address the following comment on versioned_docs/version-v1.10/getting-started/advanced-application.md at line 1:
<comment>The extra `---` line closes the front matter before the `title` entry, so the page renders `title: Deploy an Advanced Application` as body text and loses its metadata. Please collapse the front matter to a single block.</comment>
<file context>
@@ -0,0 +1,429 @@
+---
+---
+title: Deploy an Advanced Application
</file context>
|
|
||
| ```bash | ||
| # Install VelaD (includes KubeVela + Kubernetes) | ||
| curl -fsSl https://static.kubevela.net/script/install-velad.sh | bash |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Prompt for AI agents
~~~ Address the following comment on versioned_docs/version-v1.10/getting-started/quick-install.md at line 13: Using https://static.kubevela.net/script/install-velad.sh fails because the site’s SSL certificate is expired, so newcomers cannot install VelaD by following these steps. Please switch to the working https://kubevela.io/script/install-velad.sh mirror. (Based on your team's feedback about ensuring curl commands use reachable HTTPS URLs.) @@ -0,0 +1,52 @@ + +```bash +# Install VelaD (includes KubeVela + Kubernetes) +curl -fsSl https://static.kubevela.net/script/install-velad.sh | bash + +# Start KubeVela with UI console ~~~| <div className="getting-started-cards"> | ||
|
|
||
| * Create an environment for your first app. | ||
| ### 1. 📦 [Quick Install](../getting-started/quick-install) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Because this Markdown heading sits inside a raw JSX
element (or move the content outside the JSX wrapper) so the step formats correctly.
Prompt for AI agents
Address the following comment on docs/quick-start.md at line 15:
<comment>Because this Markdown heading sits inside a raw JSX <div>, it renders as literal text instead of a styled heading. Replace it with an explicit <h3> element (or move the content outside the JSX wrapper) so the step formats correctly.</comment>
<file context>
@@ -1,269 +1,59 @@
+<div className="getting-started-cards">
-* Create an environment for your first app.
+### 1. 📦 [Quick Install](../getting-started/quick-install)
+Choose between standalone installation (no Kubernetes required) or installing on an existing cluster.
</file context>
| ### 1. 📦 [Quick Install](../getting-started/quick-install) | |
| +<h3>1. 📦 <a href="../getting-started/quick-install">Quick Install</a></h3> |
|
|
||
| Now that you've deployed your first application, you're ready to: | ||
|
|
||
| - **[Deploy an Advanced Application](../advanced-application)** - Learn about multi-environment deployments |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The links to “Deploy an Advanced Application” and “Understand Core Concepts” step outside the getting-started directory, so they resolve to nonexistent pages. Update both to use ./ to keep the current directory.
Prompt for AI agents
Address the following comment on docs/getting-started/first-application.md at line 313:
<comment>The links to “Deploy an Advanced Application” and “Understand Core Concepts” step outside the getting-started directory, so they resolve to nonexistent pages. Update both to use ./ to keep the current directory.</comment>
<file context>
@@ -0,0 +1,315 @@
+
+Now that you've deployed your first application, you're ready to:
+
+- **[Deploy an Advanced Application](../advanced-application)** - Learn about multi-environment deployments
+- **[Understand Core Concepts](../core-concept)** - Deep dive into KubeVela's architecture
+- **[Explore Examples](https://github.com/kubevela/kubevela/tree/master/docs/examples)** - View the community curated examples
</file context>
| - **[Deploy an Advanced Application](../advanced-application)** - Learn about multi-environment deployments | |
| - **[Deploy an Advanced Application](./advanced-application)** - Learn about multi-environment deployments |
Description of your changes
Updates the Getting Started guide to be more structured and welcoming to new users.
I have:
sidebar.jsif adding a new page.yarn startto ensure the changes has taken effect.Special notes for your reviewer
Summary by cubic
Reorganized the Getting Started experience into a clear, step-by-step path with new install and tutorial guides, and updated navigation to make onboarding faster. Changes are mirrored in v1.10 versioned docs.