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

feat(install): add separate install guide for each env #2054

Open
wants to merge 8 commits into
base: master
Choose a base branch
from

Conversation

Automaat
Copy link
Contributor

@Automaat Automaat commented Oct 30, 2024

We should have all install guide centralized and easy to find, as now they are buried somewhere in production docs

Fix: #1334 and #1249

Signed-off-by: Marcin Skalski <skalskimarcin33@gmail.com>
Copy link

netlify bot commented Oct 30, 2024

Deploy Preview for kuma ready!

Name Link
🔨 Latest commit 3850fe7
🔍 Latest deploy log https://app.netlify.com/sites/kuma/deploys/6728e686c93a9a0008954b11
😎 Deploy Preview https://deploy-preview-2054--kuma.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 92 (🟢 up 3 from production)
Accessibility: 90 (no change from production)
Best Practices: 100 (no change from production)
SEO: 92 (no change from production)
PWA: 80 (no change from production)
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

Signed-off-by: Marcin Skalski <skalskimarcin33@gmail.com>
Signed-off-by: Marcin Skalski <skalskimarcin33@gmail.com>
Copy link
Contributor Author

Choose a reason for hiding this comment

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

this page looks poor, can we do something to improve it?

Copy link
Contributor

Choose a reason for hiding this comment

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

Do we need it?

@Automaat Automaat changed the title WIP feat(install): add separate install guide for each env feat(install): add separate install guide for each env Oct 30, 2024
@Automaat Automaat marked this pull request as ready for review October 30, 2024 16:32
@Automaat Automaat requested a review from a team as a code owner October 30, 2024 16:32
@Automaat Automaat requested review from michaelbeaumont and bartsmykla and removed request for a team October 30, 2024 16:32
Signed-off-by: Marcin Skalski <skalskimarcin33@gmail.com>
@@ -19,8 +19,27 @@ items:
url: "/introduction/how-kuma-works/#kuma-vs-xyz"
- text: Architecture
url: /introduction/architecture/
- text: Install Kuma
url: /introduction/install-kuma/
- title: Install Kuma
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Maybe this could be a separate top level entry in sidebar?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

this should replace: https://kuma.io/docs/2.9.x/production/cp-deployment/multi-zone/ do we need to move anything from old guide somewhere before we remove it?

# Conflicts:
#	.github/styles/config/vocabularies/Base/reject.txt
Signed-off-by: Marcin Skalski <skalskimarcin33@gmail.com>
Signed-off-by: Marcin Skalski <skalskimarcin33@gmail.com>
```
3. Find the external IP and port of the `{{site.mesh_product_name}}-global-zone-sync` service in the {{site.mesh_namespace}} namespace:
```shell
kubectl get service {{site.mesh_product_name}}-global-zone-sync -n {{site.mesh_namespace}} -ojson -o jsonpath='{.status.loadBalancer.ingress[0].ip}'
Copy link
Contributor

Choose a reason for hiding this comment

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

Would it make sense to add this to an env var and use it just after?

Copy link
Contributor

@lahabana lahabana left a comment

Choose a reason for hiding this comment

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

This is a nice improvement.
One thing comes to me is do we need to differentiate single-zone and multi-zone.

Should we have instead a guide to install a zone and a guide to install a global.

In the zone we'd have a tab to select whether this zone is federated (connects to a global CP) or not (old standalone).

Feels to me that this would create less pages but also less options and in the end be clearer?

Copy link
Contributor

Choose a reason for hiding this comment

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

Do we need it?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Installation docs are missing/confusing
3 participants