istio.io icon indicating copy to clipboard operation
istio.io copied to clipboard

Rebrand and update lightstep docs

Open robswhitmore opened this issue 1 year ago • 27 comments

Please provide a description for what this PR is for.

Lightstep has been rebranded to Cloud Observability from ServiceNow. Additionally, we now use the OpenTelemetry Collector to ingest metrics, traces, and logs from third-parties. These updates include both changes.

And to help us figure out who should review this PR, please put an X in all the areas that this PR affects.

  • [ ] Ambient
  • [ X ] Docs
  • [ ] Installation
  • [ ] Networking
  • [ ] Performance and Scalability
  • [ ] Extensions and Telemetry
  • [ ] Security
  • [ ] Test and Release
  • [ ] User Experience
  • [ ] Developer Infrastructure

robswhitmore avatar Aug 28 '23 20:08 robswhitmore

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

  • You can learn about how we write and maintain documentation, about our style guidelines, and about all 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 as 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, we sanitize the markdown, we ensure all hyperlinks point to valid location, and more. If your PR doesn't pass one of these checks, you'll see a red X in the status section of the page. Click on the Details link to get a list of the problems with your PR. Fix those problems and push an update to your PR. This will automatically rerun the tests and 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).

Thanks for contributing!

Courtesy of your friendly welcome wagon.

istio-policy-bot avatar Aug 28 '23 20:08 istio-policy-bot

CLA Signed

The committers listed above are authorized under a signed CLA.

  • :white_check_mark: login: robswhitmore / name: Robin Whitmore (25a4d05be31de6f39cc0a1031362703f581d1009, f29ffbe75d67018e2c3da551709a0486db66d67a, b7a080300104a63772ef391da6ba94c613223df5, 13039b79aa8c009b1e627a172a2afe12f25112b6, b3bcaa3c7bd4f7cbefd8a4d7d053a6d59a0d1885, 8d10b6282669ccb969e627df7488f99c5fe63181, 1e7d7b7ba177f813ee3fafac4537e65a72794f58, a56f7c0eb7c7e02f0dec5bb290e4c9fb0cd9b769, 79e1bffe5c9d2ea132972fd152a6fe46f3d426bb, 474cebce3d1aa5346704a69a3ed5686ca3ecfa9b, 9c381e7aab5a37ce0b7cf8ca8b49f579683b2c0b, 5aaeaf6b0cd433074cfd328a36dc04ece98507c3, d5c1904037564fa2c2bdae0934a94fe3f81cefd9, 8c1be73c23b443cc2aec821f0a63c6fd82f13765)

Hi @robswhitmore. Thanks for your PR.

I'm waiting for a istio member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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/test-infra repository.

istio-testing avatar Aug 28 '23 20:08 istio-testing

I'd like to also add the label cherrypick/release-1.19 but I don't seem to be able to edit the labels field.

robswhitmore avatar Aug 28 '23 20:08 robswhitmore

/ok-to-test

ericvn avatar Aug 29 '23 00:08 ericvn

Depending on when this merges, it may or may not need the 1.19 label as there is no 1.19 branch (right now). The branch will be created when 1.19.0 is release.d.

ericvn avatar Aug 29 '23 00:08 ericvn

I fixed the lint errors that I can, but the errors for spacing around lists can't be fixed because those are inside yaml code blocks. What should I do?

Also, what should we tag this PR so that it goes into the latest release?

robswhitmore avatar Aug 29 '23 14:08 robswhitmore

I fixed the lint errors that I can, but the errors for spacing around lists can't be fixed because those are inside yaml code blocks. What should I do?

Also, what should we tag this PR so that it goes into the latest release?

The errors are:

./en/docs/tasks/observability/distributed-tracing/lightstep/index.md:79: MD029 Ordered list item prefix
./en/docs/tasks/observability/distributed-tracing/lightstep/index.md:211: MD029 Ordered list item prefix
./en/docs/tasks/observability/distributed-tracing/lightstep/index.md:223: MD029 Ordered list item prefix

This has to do with you incrementing the numbers. All ordered list items must be 1.. They will get incremented automatically. IE on line 79 you have 2., it should be 1. Our style is one as documented here: https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md#md029---ordered-list-item-prefix

dhawton avatar Aug 29 '23 15:08 dhawton

We can work on getting the PR into the latest releases once it's ready to merge. It'll first go into the preliminary.istio.io docs and ten we will cherry-pick to the branch that corresponds to istio.io. That branch is changing soon, so timing will dictate where we cherry-pick.

ericvn avatar Aug 29 '23 15:08 ericvn

@istio/wg-policies-and-telemetry-maintainers Can you review this as owners of the page as well. Thanks.

ericvn avatar Aug 29 '23 15:08 ericvn

Also, note that you can click on the Details to the right of the deploy-preview job to get at the docs corresponding to this change. https://deploy-preview-13779--preliminary-istio.netlify.app/latest/docs/tasks/observability/distributed-tracing/lightstep/ would be the new page.

ericvn avatar Aug 29 '23 15:08 ericvn

/test lint

robswhitmore avatar Aug 29 '23 23:08 robswhitmore

I don't think I can fix this link because it's in a news post, right? The link goes to /news/releases/1.1.x/announcing-1.1/change-notes/

robswhitmore avatar Aug 30 '23 00:08 robswhitmore

@lei-tang or whoever else might be able to help - The linter is failing with a broken link to an old change note. I don't think I should update this, correct? image

robswhitmore avatar Sep 06 '23 00:09 robswhitmore

@ericvn Do you have suggestions for fixing the broken link error above?

lei-tang avatar Sep 06 '23 00:09 lei-tang

Lint error is Running linkinator... [404] http://localhost:5080/docs/tasks/observability/distributed-tracing/lightstep/ ERROR: Detected 1 broken links. Scanned 5787 links in 39.311 seconds.

You removed this file so makes sense that the link isn't found.

What do you want people who pointed to it to point to now? You could point to an older release's version of the file by changing the URL to point to a specific older release. Maybe you want to add an alias to a new page so the page would then be used for the deleted page (ie. replace the alias I've asked you to remove with /docs/tasks/observability/distributed-tracing/lightstep/).

ericvn avatar Sep 06 '23 01:09 ericvn

Also added the cherry-pick label since we have cut the new branch.

ericvn avatar Sep 06 '23 02:09 ericvn

@ericvn I did what you suggested and changed the alias to the page I deleted (/docs/tasks/observability/distributed-tracing/lightstep/), but I'm still getting the same broken link and now an additional broken link for that alias. I followed the directions here, but I must be missing something?

robswhitmore avatar Sep 06 '23 23:09 robswhitmore

@ericvn I did what you suggested and changed the alias to the page I deleted (/docs/tasks/observability/distributed-tracing/lightstep/), but I'm still getting the same broken link and now an additional broken link for that alias. I followed the directions here, but I must be missing something?

The lint report tells you the file the link is originating from, which is https://github.com/robswhitmore/istio.io/blob/robswhitmore/rebrand-update-lightstep/content/en/news/releases/1.1.x/announcing-1.1/change-notes/index.md?plain=1#L165

Since you're changing the name of the file, link to an archived version of the page, for example: https://istio.io/v1.18/docs/tasks/observability/distributed-tracing/lightstep/

dhawton avatar Sep 06 '23 23:09 dhawton

@robswhitmore Daniel is correct. There are two ways to fix the issue. One is to update the link which is pointing to the file you removed in news/releases/1.1.x/announcing-1.1/change-notes/ to point to and older existing version of the page (use 1.19 or 1.18 for example). You can look at a commit where I did that yesterday: https://github.com/istio/istio.io/commit/fbb5c8df9bf9f0e6969a4413f0a669c69b62042b prefixing https://archive.istio.io/v1.17 to the /docs/... that was removed. In this case, the link will point to the same information as before.

As I noted, if the new page you replaced the deleted page with is an acceptable alternative, then you can simply add /docs/tasks/observability/distributed-tracing/lightstep/ to the aliases list on the new page, and when they click the link it will take them to the new page. (Edit: It looks like you did this. Maybe it's a formatting issue and the items need to be indented 4 spaces).

Pick whichever way yields the best information to the reader.

ericvn avatar Sep 07 '23 00:09 ericvn

@ericvn and @lei-tang - my commit finally passed the lint check, so I think it's good to go. Thanks for all your help!

robswhitmore avatar Sep 07 '23 18:09 robswhitmore

Does https://github.com/istio/istio.io/pull/13996 replace this?

ericvn avatar Oct 17 '23 01:10 ericvn

News to me! 😕 Let me find out what's going on...

robswhitmore avatar Oct 17 '23 13:10 robswhitmore

Looks like the eng team decided to focus on Tracing, so that new PR is separate from this one, and is taking precedence. Sorry for all the confusion!

robswhitmore avatar Oct 30 '23 18:10 robswhitmore

Looks like the eng team decided to focus on Tracing, so that new PR is separate from this one, and is taking precedence. Sorry for all the confusion!

I think you are saying that at some point this PR will be revisited.

ericvn avatar Dec 06 '23 17:12 ericvn

Yes, at some point. Thanks -

robswhitmore avatar Dec 06 '23 19:12 robswhitmore

PR needs rebase.

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/test-infra repository.

istio-testing avatar Mar 06 '24 22:03 istio-testing