Skip to content

Introduce an interstitial for selecting install mode #16426

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

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

Conversation

craigbox
Copy link
Contributor

The main CTA on istio.io is "Try Istio", which takes people straight into the sidecar documentationn.

This PR introduces an interstitial, which explains both modes, linking to the full description, and then asks you to click a button to choose.

This introduces friction that ultimately we have tried very hard to avoid.

Alternatives considered

Taking people straight into the ambient setup guide is probably a choice the project should make when we have closed some of the gaps on the 2025 roadmap.

@craigbox craigbox requested review from a team as code owners April 22, 2025 03:38
@istio-testing istio-testing added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Apr 22, 2025
@craigbox craigbox added the do-not-merge/work-in-progress Block merging of a PR because it isn't ready yet. label Apr 22, 2025
@linsun
Copy link
Member

linsun commented Apr 23, 2025

We reviewed the PR during the WG meeting and agreed this is a good step towards where we wanted to go. One suggestion: perhaps list ambient first before sidecars since this is quick start?

@craigbox
Copy link
Contributor Author

I reviewed the video and ultimately agree with Ian/Keith that we should ultimately make this decision for people.

perhaps list ambient first before sidecars since this is quick start

I agree with the reasoning @jshaughn but It's traditionally hard to explain "sidecarless" without explaining what "sidecar" is. I'll give it a go.

@craigbox craigbox removed the do-not-merge/work-in-progress Block merging of a PR because it isn't ready yet. label Apr 30, 2025
@craigbox craigbox requested a review from linsun April 30, 2025 02:54
@craigbox
Copy link
Contributor Author

(I don't know if you missed it when you were previewing Lin, but this page is now linked from "Try Istio" on every page.)

Copy link
Member

@dhawton dhawton left a comment

Choose a reason for hiding this comment

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

Very minor formatting nit just to make it a little easier to read in the future. Otherwise this lgtm. Will wait for @linsun's input before approving.

In general, **we recommend that new users start with ambient mode**. It is faster, cheaper, and easier to manage. There are [advanced use cases](/docs/overview/dataplane-modes/#unsupported-features) that still require the use of sidecar mode, but closing these gaps is on our 2025 roadmap.

<div style="display: flex; justify-content: center; align-items: center; gap: 1rem;">
<a href="/docs/ambient/getting-started" class="btn btn--secondary" id="get-started-ambient">Get started with ambient mode</a><a href="/docs/setup/getting-started" class="btn btn--secondary" id="get-started-sidecar">Get started with sidecar mode</a>
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
<a href="/docs/ambient/getting-started" class="btn btn--secondary" id="get-started-ambient">Get started with ambient mode</a><a href="/docs/setup/getting-started" class="btn btn--secondary" id="get-started-sidecar">Get started with sidecar mode</a>
<a href="/docs/ambient/getting-started" class="btn btn--secondary" id="get-started-ambient">Get started with ambient mode</a>
<a href="/docs/setup/getting-started" class="btn btn--secondary" id="get-started-sidecar">Get started with sidecar mode</a>

@craigbox
Copy link
Contributor Author

Oh, I forgot; the CSS is completely horrible on mobile. We need to address that before merging!

@dhawton dhawton added the do-not-merge Block automatic merging of a PR. label Apr 30, 2025
@dhawton
Copy link
Member

dhawton commented Apr 30, 2025

Oh, I forgot; the CSS is completely horrible on mobile. We need to address that before merging!

I added back the DNM pending that and will refrain from review.

@istio-testing istio-testing added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels May 15, 2025
@craigbox craigbox removed the do-not-merge Block automatic merging of a PR. label May 15, 2025
@craigbox craigbox requested a review from dhawton May 15, 2025 22:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants