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

Configuration Analysis Messages does not include IST0114-117 and 120-133

Open esnible opened this issue 5 years ago • 9 comments

https://preliminary.istio.io/latest/docs/reference/config/analysis/ shows, but does not link to, IST0114-117 and 120-127.

The text is not hyperlinked. The URLs are not included in the documentation, when istioctl supplies direct URLs to the messages that are not present.

Related:

  • [ ] https://github.com/istio/istio.io/pull/8486 Add documentation for Analysis messsage IST0132 VirtualServiceHostNotFoundInGateway

esnible avatar Aug 03 '20 15:08 esnible

Those directories have never been created and filled with the docs: https://github.com/istio/istio.io/tree/master/content/en/docs/reference/config/analysis

ericvn avatar Aug 03 '20 18:08 ericvn

@ericvn Is the expectation that UX, who wrote the analyzers, contribute those directories?

I had hoped a tool made them from galley/pkg/config/analysis/msg/messages.yaml, and that we just improved them. However, I am willing to assign someone to make them. Use the existing ones as a template?

esnible avatar Aug 03 '20 21:08 esnible

I believe Adam created the ones that are there, but maybe nobody has been keeping them up to date with new codes??

cc @adammil2000, do you know what the process is supposed to be to manage these?

Generating them would be nice, if possible.

frankbu avatar Aug 04 '20 17:08 frankbu

@jasonwzm are you still working on this? cc @frankbu

This seems important, so I have added myself.

esnible avatar Nov 12 '20 15:11 esnible

Four of the messages are no longer generated by Istio and should be removed from the docs: IST0114, IST0115, IST0120, IST0121

Twelve messages are still generated and lack detail pages (and are not targetted by another PR): IST0116, IST0117, IST0122, IST0123, IST0125, IST0126, IST0127, IST0128, IST0129, IST0130, IST0131, IST0133

esnible avatar Nov 12 '20 21:11 esnible

@jasonwzm I wrote docs for all of the codes except 126. It seemed complicated, so I decided to leave it for the original analyzer author -- you.

esnible avatar Nov 13 '20 20:11 esnible

@esnible 126's logic is obsolete. I will work with Steven on refactoring that. https://github.com/istio/istio/issues/28906

jasonwzm avatar Nov 15 '20 07:11 jasonwzm

@jasonwzm If you remove 126's logic, remove 126 from messages.yaml and close this Issue.

esnible avatar Nov 16 '20 16:11 esnible

Just looking at https://preliminary.istio.io/latest/docs/reference/config/analysis/ and there are a number of messages without links.

ericvn avatar Aug 12 '22 20:08 ericvn

🚧 This issue or pull request has been closed due to not having had activity from an Istio team member since 2022-08-12. If you feel this issue or pull request deserves attention, please reopen the issue. Please see this wiki page for more information. Thank you for your contributions.

Created by the issue and PR lifecycle manager.

istio-policy-bot avatar Jun 04 '24 20:06 istio-policy-bot