Skip to content
This repository was archived by the owner on Jul 30, 2025. It is now read-only.

Conversation

@starpit
Copy link
Contributor

@starpit starpit commented Feb 21, 2022

When replaying a guidebook in an offline client (e.g. in a static single page web app), you may still want to allow users of that guidebook to experience drilling down from tables. This PR enables this by default on save: every code block response that is a table will have its rows prefetched, at least for those rows that indicate onclickIdempotent: true.

This PR adds a feature to execOptions called masquerade which allows one controller to invoke another, but to have that command appear in the UI as something else. For this use case, the masquerade feature allows us to register a single replay-content command, but to have it appear to the guidebook user as if that command were the original drilldown command.

Description of what you did:

My PR is a:

  • 💥 Breaking change
  • 🐛 Bug fix
  • 💅 Enhancement
  • 🚀 New feature

Please confirm that your PR fulfills these requirements

  • Multiple commits are squashed into one commit.
  • The commit message follows Conventional Commits, which allows us to autogenerate release notes; e.g. fix(plugins/plugin-k8s): fixed annoying bugs
  • All npm dependencies are pinned.

When replaying a guidebook in an offline client (e.g. in a static single page web app), you may still want to allow users of that guidebook to experience drilling down from tables. This PR enables this by default on save: every code block response that is a table will have its rows prefetched, at least for those rows that indicate `onclickIdempotent: true`.

This PR adds a feature to `execOptions` called `masquerade` which allows one controller to invoke another, but to have that command appear in the UI as something else. For this use case, the masquerade feature allows us to register a single `replay-content` command, but to have it appear to the guidebook user as if that command were the original drilldown command.
@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Feb 21, 2022
@k8s-ci-robot
Copy link

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: starpit

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Feb 21, 2022
@starpit starpit merged commit 15cecd8 into kubernetes-retired:master Feb 21, 2022
@starpit starpit deleted the prefetch-replay branch February 21, 2022 20:51
@starpit starpit restored the prefetch-replay branch February 21, 2022 22:14
@starpit starpit deleted the prefetch-replay branch February 21, 2022 22:14
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants