Notable Event Types Doc Update - An include directive is not expanded properly

[knz]

Raphael ‘kena’ Poss (knz) commented:

Re: Notable Event Types

See:

The include should be expanded into a callout instead.

cc @taroface

Jira Issue: DOC-1584

[taroface]

@yzdocs Do you have any insight as to why this include isn't being properly rendered? Is it perhaps because we are using the remote_include functionality to embed the content in that screenshot, which contains the above include?

This experimental-warning include is placed here and generated into this doc, which is what the remote_include points to.

[taroface]

cc @ianjevans on the above remote_include question.

[ianjevans]

I looked into this, and the remote_include is being processed after the Liquid tags are all processed. I think there might be a way to trigger a Liquid converter within the plugin. https://github.com/ianjevans/jekyll-remote-include/issues/4

[exalate-issue-sync[bot]]

Andrew Feierabend (andf-crl) commented: Looks like Ryan merged a fix (removal of include directive from upstream generated docs content) to upstream branch {{master}}.

This has fixed live version of {{v21.1}} docs, which still referenced the {{master}} branch of eventlog.md (generated | source md), but the live versions of this page for {{v21.2}} and {{v22.1}} are still broken with the problem described in this ticket’s description.

The issue here is:

• We would need to edit the v21.2 and v21.2 versions of this generated content, which might be complicated because these versions have already shipped, and
• We must continue to point our per-version include in docs to its matching version in CRDB repo, for this resource, as event log items are indeed version-specific.

Pausing on this while I consider / consult.

Note: ideally, live version of {{v21.1}} docs should be fixed to reference {{release-21.1}} branch of upstream generated content, instead of {{master}}. Currently, its presented log events are not correct for the version presented.

[exalate-issue-sync[bot]]

Andrew Feierabend (andf-crl) commented: Much of my above comment surfaced here: https://github.com/cockroachdb/cockroach/issues/84024

[exalate-issue-sync[bot]]

Andrew Feierabend (andf-crl) commented: Also just stumbled on: https://github.com/cockroachdb/cockroach/pull/84111 . Probably this means that I should close dupe this ticket, but I’ll need to check versioning of upstream includes per my above message.

[exalate-issue-sync[bot]]

Andrew Feierabend (andf-crl) commented: Include no longer referenced in upstream branches:

• {{master}}
• {{release-22.2}}
• {{release-22.1}}
• {{release-21.2}}
• {{release-21.1}}

File does not exist previous to v21.1.

Closing ticket!