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

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

Merged
merged 25 commits into from
Jun 2, 2024

Conversation

peterj
Copy link
Member

@peterj peterj commented May 22, 2024

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
Copy link
Contributor

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-testing istio-testing added the do-not-merge/work-in-progress Block merging of a PR because it isn't ready yet. label May 22, 2024
@istio-policy-bot
Copy link

😊 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.

@istio-testing istio-testing added the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label May 22, 2024
@peterj
Copy link
Member Author

peterj commented May 22, 2024

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

@peterj peterj marked this pull request as ready for review May 28, 2024 22:44
@peterj peterj requested a review from a team as a code owner May 28, 2024 22:44
@istio-testing istio-testing removed the do-not-merge/work-in-progress Block merging of a PR because it isn't ready yet. label May 28, 2024
@peterj
Copy link
Member Author

peterj commented May 28, 2024

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

@peterj
Copy link
Member Author

peterj commented May 28, 2024

working on tests

@istio-testing istio-testing added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels May 29, 2024
@craigbox
Copy link
Contributor

@craigbox
Copy link
Contributor

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 craigbox requested a review from a team as a code owner May 30, 2024 09:30
@istio-testing istio-testing added the needs-rebase Indicates a PR needs to be rebased before being merged label May 30, 2024
peterj and others added 9 commits May 30, 2024 22:19
Signed-off-by: Peter Jausovec <peter.jausovec@solo.io>
Signed-off-by: Peter Jausovec <peter.jausovec@solo.io>
Signed-off-by: Peter Jausovec <peter.jausovec@solo.io>
Signed-off-by: Peter Jausovec <peter.jausovec@solo.io>
Signed-off-by: Peter Jausovec <peter.jausovec@solo.io>
Signed-off-by: Peter Jausovec <peter.jausovec@solo.io>
@craigbox
Copy link
Contributor

/test doc.test.profile-none

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.

Couple of minor nits.

peterj and others added 2 commits May 31, 2024 07:58
…ndex.md

Co-authored-by: Daniel Hawton <daniel@hawton.org>
Signed-off-by: Peter Jausovec <peter.jausovec@solo.io>
@peterj
Copy link
Member Author

peterj commented May 31, 2024

/test doc.test.profile-none

@peterj
Copy link
Member Author

peterj commented Jun 1, 2024

/test doc.test.profile-default

@craigbox
Copy link
Contributor

craigbox commented Jun 2, 2024

/test doc.test.profile-ambient

That's new

@craigbox
Copy link
Contributor

craigbox commented Jun 2, 2024

No tests in this profile yet @kfaseela ?

@kfaseela
Copy link
Member

kfaseela commented Jun 2, 2024

Test was migrated in #15210 yet to be merged

@craigbox
Copy link
Contributor

craigbox commented Jun 2, 2024

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
Copy link
Member

kfaseela commented Jun 2, 2024

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
Copy link
Member

kfaseela commented Jun 2, 2024

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

@craigbox
Copy link
Contributor

craigbox commented Jun 2, 2024 via email

@istio-testing
Copy link
Contributor

istio-testing commented Jun 2, 2024

@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
Copy link
Contributor

craigbox commented Jun 2, 2024 via email

@istio-testing istio-testing merged commit 8b3072f into istio:master Jun 2, 2024
12 of 13 checks passed
@craigbox
Copy link
Contributor

/cherry-pick release-1.22

@craigbox craigbox mentioned this pull request Jun 26, 2024
1 task
@istio-testing
Copy link
Contributor

@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
Copy link
Contributor

@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.

craigbox added a commit to craigbox/istio.io that referenced this pull request Jun 26, 2024
* break apart the ambient getting start guide

Signed-off-by: Peter Jausovec <peter.jausovec@solo.io>

* wip

Signed-off-by: Peter Jausovec <peter.jausovec@solo.io>

* wip

Signed-off-by: Peter Jausovec <peter.jausovec@solo.io>

* fix linter issues

Signed-off-by: Peter Jausovec <peter.jausovec@solo.io>

* wip

Signed-off-by: Peter Jausovec <peter.jausovec@solo.io>

* add tests

Signed-off-by: Peter Jausovec <peter.jausovec@solo.io>

* Craig's first edits

* lint fixes

* Fix tests

* fix tests

* test for istio#15200 workaround

* fix tests (thanks Faseela for helping me get them running locally!)

* Fix the snip generator?

* remove Wasm test because it depends on snips we're moving around

* rebase go.mod properly

* remove spelling

* new screenshots + pr fixes

Signed-off-by: Peter Jausovec <peter.jausovec@solo.io>

* can't test locally so let's hope

* lint fixes

* make gen & fix test

* fixy testy

* Fix snip

* fix tests as we learn more

* Update content/en/docs/ambient/getting-started/secure-and-visualize/index.md

Co-authored-by: Daniel Hawton <daniel@hawton.org>

* fixing the wasm tests

Signed-off-by: Peter Jausovec <peter.jausovec@solo.io>

---------

Signed-off-by: Peter Jausovec <peter.jausovec@solo.io>
Co-authored-by: Craig Box <craig.box@gmail.com>
Co-authored-by: Daniel Hawton <daniel@hawton.org>
craigbox added a commit to craigbox/istio.io that referenced this pull request Jun 27, 2024
* break apart the ambient getting start guide

Signed-off-by: Peter Jausovec <peter.jausovec@solo.io>

* wip

Signed-off-by: Peter Jausovec <peter.jausovec@solo.io>

* wip

Signed-off-by: Peter Jausovec <peter.jausovec@solo.io>

* fix linter issues

Signed-off-by: Peter Jausovec <peter.jausovec@solo.io>

* wip

Signed-off-by: Peter Jausovec <peter.jausovec@solo.io>

* add tests

Signed-off-by: Peter Jausovec <peter.jausovec@solo.io>

* Craig's first edits

* lint fixes

* Fix tests

* fix tests

* test for istio#15200 workaround

* fix tests (thanks Faseela for helping me get them running locally!)

* Fix the snip generator?

* remove Wasm test because it depends on snips we're moving around

* rebase go.mod properly

* remove spelling

* new screenshots + pr fixes

Signed-off-by: Peter Jausovec <peter.jausovec@solo.io>

* can't test locally so let's hope

* lint fixes

* make gen & fix test

* fixy testy

* Fix snip

* fix tests as we learn more

* Update content/en/docs/ambient/getting-started/secure-and-visualize/index.md

Co-authored-by: Daniel Hawton <daniel@hawton.org>

* fixing the wasm tests

Signed-off-by: Peter Jausovec <peter.jausovec@solo.io>

---------

Signed-off-by: Peter Jausovec <peter.jausovec@solo.io>
Co-authored-by: Craig Box <craig.box@gmail.com>
Co-authored-by: Daniel Hawton <daniel@hawton.org>
istio-testing pushed a commit that referenced this pull request Jun 28, 2024
* docs: break apart the ambient getting start guide (WIP) (#15168)

* break apart the ambient getting start guide

Signed-off-by: Peter Jausovec <peter.jausovec@solo.io>

* wip

Signed-off-by: Peter Jausovec <peter.jausovec@solo.io>

* wip

Signed-off-by: Peter Jausovec <peter.jausovec@solo.io>

* fix linter issues

Signed-off-by: Peter Jausovec <peter.jausovec@solo.io>

* wip

Signed-off-by: Peter Jausovec <peter.jausovec@solo.io>

* add tests

Signed-off-by: Peter Jausovec <peter.jausovec@solo.io>

* Craig's first edits

* lint fixes

* Fix tests

* fix tests

* test for #15200 workaround

* fix tests (thanks Faseela for helping me get them running locally!)

* Fix the snip generator?

* remove Wasm test because it depends on snips we're moving around

* rebase go.mod properly

* remove spelling

* new screenshots + pr fixes

Signed-off-by: Peter Jausovec <peter.jausovec@solo.io>

* can't test locally so let's hope

* lint fixes

* make gen & fix test

* fixy testy

* Fix snip

* fix tests as we learn more

* Update content/en/docs/ambient/getting-started/secure-and-visualize/index.md

Co-authored-by: Daniel Hawton <daniel@hawton.org>

* fixing the wasm tests

Signed-off-by: Peter Jausovec <peter.jausovec@solo.io>

---------

Signed-off-by: Peter Jausovec <peter.jausovec@solo.io>
Co-authored-by: Craig Box <craig.box@gmail.com>
Co-authored-by: Daniel Hawton <daniel@hawton.org>

* cherrypick #15227 too

* move ambient tests to ambient profile (#15241)

Signed-off-by: Faseela K <faseela.k@est.tech>

* Manual cherry-pick the last of 15293

* Fix gencheck with release-1.22 versions of the tests

* re-add setup snips to fix the tests again; there's no avoiding #15200

* Update content/en/docs/ambient/getting-started/test.sh

---------

Signed-off-by: Peter Jausovec <peter.jausovec@solo.io>
Signed-off-by: Faseela K <faseela.k@est.tech>
Co-authored-by: Peter Jausovec <peterj@users.noreply.github.com>
Co-authored-by: Daniel Hawton <daniel@hawton.org>
Co-authored-by: Faseela K <faseela.k@est.tech>
Co-authored-by: Faseela K <k.faseela@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/docs size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants