docs: break apart the ambient getting start guide (WIP)

[peterj]

Description

[WIP] Breaking up the Ambient Getting Started section into multiple smaller sections.

Reviewers

• Ambient
• Docs
• Installation
• Networking
• Performance and Scalability
• Extensions and Telemetry
• Security
• Test and Release
• User Experience
• Developer Infrastructure
• Localization/Translation

TODOs:

• make the tests work
• update the bookinfo screenshot (once new docker images are published)
• show L7 metrics (for some reason I don't see them in Kiali)

[istio-testing]

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

[istio-policy-bot]

😊 Welcome! This is either your first contribution to the Istio documentation repo, or
it's been a while since you've been here. A few things you should know:

• You can learn about how we write and maintain documentation, our style guidelines,
  and the available web site features by visiting Contributing to the Docs.

• In the next few minutes, an automatic preview of your change will be built with
  a full copy of the istio.io website. You can find this preview by clicking on
  the Details link next to the deploy/netlify entry in the status section of this
  page.

• We care about quality, so we've put in place a number of checks to ensure our documentation
  is top-notch. We do spell checking, sanitize the Markdown, ensure all hyperlinks point to a
  valid location, and more. If your PR doesn't pass one of these checks, you'll see a red X in the
  lint_istio.io entry in the status section. Click on the Details link to get a list of the
  problems with your PR. Fix those problems and push an update; this will automatically re-run the
  tests. Hopefully this time everything will be perfect!

• Once your changes are accepted and merged into the repository, they will initially show up
  on https://preliminary.istio.io. The changes will be published to https://istio.io
  the next time we do a major release (which typically happens every 3 months or so).
  To publish them sooner, add a cherrypick/release-x.xx label, where x.xx is the current
  release of Istio.

Thanks for contributing!

Courtesy of your friendly welcome wagon.

[peterj]

CC @craigbox; I started working on this - not ready for review yet, but wanted to get the draft PR in.

[peterj]

The first draft is ready to review -- cc @craigbox

[peterj]

working on tests

[craigbox]

https://deploy-preview-15168--preliminary-istio.netlify.app/latest/docs/ambient/getting-started/

[craigbox]

I've broken the testing pipeline. (#15200)

At one stage this PR contained a setup/index.md' with a matching snips.sh`. I moved that content back into the main index.md but the tests think that it used to be there, so it adds it to the list and fails when it's not.

In order to unblock this I'm going to try a commit with just the empty directory, and then one with a no-op snips.sh if needed.

(On the plus side, now is a good time for someone else to learn how istio.io testing works in great depth)

[craigbox]

/test doc.test.profile-none

[dhawton]

Couple of minor nits.

[peterj]

/test doc.test.profile-none

[peterj]

/test doc.test.profile-default

[craigbox]

/test doc.test.profile-ambient

That's new

[craigbox]

No tests in this profile yet @kfaseela ?

[kfaseela]

Test was migrated in #15210 yet to be merged

[craigbox]

OK - I don't know the dependency order here but this PR is now being checked against the ambient test and it's failing, with no apparent error - because there are no tests using it that succeed?

[kfaseela]

The folder for running ambient-profile is created in the other PR, so not available here and failing. But the test currently is non blocking. So u can merge this PR

[kfaseela]

The first PR is waiting for another Istio PR, so not yet merged

[craigbox]

approved it and the clean-up PR. Most others i saw had merged already. Let me know what I can do. We will need to follow with a PR removing the otherwise empty snips folder/file which will probably require forcing through

[istio-testing]

@peterj: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name	Commit	Details	Required	Rerun command
doc.test.profile-ambient_istio.io	d79466e	link	false	/test doc.test.profile-ambient

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

[craigbox]

/retest-required

…

On Sun, 2 Jun 2024 at 19:55, Istio Automation ***@***.***> wrote: @peterj <https://github.com/peterj>: The following tests *failed*, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests: Test name Commit Details Required Rerun command doc.test.profile-ambient_istio.io d79466e <d79466e> link <https://prow.istio.io/view/gs/istio-prow/pr-logs/pull/istio_istio.io/15168/doc.test.profile-ambient_istio.io/1797122071340257280> false /test doc.test.profile-ambient doc.test.profile-demo_istio.io d79466e <d79466e> link <https://prow.istio.io/view/gs/istio-prow/pr-logs/pull/istio_istio.io/15168/doc.test.profile-demo_istio.io/1797168367237337088> unknown /test doc.test.profile-demo Instructions for interacting with me using PR comments are available here <https://git.k8s.io/community/contributors/guide/pull-requests.md>. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow <https://github.com/kubernetes-sigs/prow/issues/new?title=Prow%20issue:> repository. I understand the commands that are listed here <https://go.k8s.io/bot-commands>. — Reply to this email directly, view it on GitHub <#15168 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AABALHT4ZIKAFBIOVNTE23TZFLFVPAVCNFSM6AAAAABIESRBT2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCNBTG4ZTSMZQGQ> . You are receiving this because you were mentioned.Message ID: <istio/istio .***@***.***>

[craigbox]

/cherry-pick release-1.22

[istio-testing]

@craigbox: #15168 failed to apply on top of branch "release-1.22":

Applying: break apart the ambient getting start guide
Applying: wip
Applying: wip
Applying: fix linter issues
Applying: wip
Applying: add tests
Applying: Craig's first edits
Applying: lint fixes
Applying: Fix tests
Applying: fix tests
Applying: test for #15200 workaround
Applying: fix tests (thanks Faseela for helping me get them running locally!)
Applying: Fix the snip generator?
Applying: remove Wasm test because it depends on snips we're moving around
Using index info to reconstruct a base tree...
M	content/en/docs/ambient/usage/extend-waypoint-wasm/index.md
M	go.mod
Falling back to patching base and 3-way merge...
Auto-merging go.mod
CONFLICT (content): Merge conflict in go.mod
Auto-merging content/en/docs/ambient/usage/extend-waypoint-wasm/index.md
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0014 remove Wasm test because it depends on snips we're moving around
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".

In response to this:

/cherry-pick release-1.22

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

[istio-testing]

@craigbox: new issue created for failed cherrypick: #15332

In response to this:

/cherry-pick release-1.22

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.