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 22, 2022

Right now, guidebooks can only have markdown content in splits. Some use cases would benefit from having one of their splits be a normal terminal.

This PR adds a terminal option to the guidebook topmatter, e.g. (from terminal1.md test input) this guidebook would have the first split offer a normal terminal interaction, and the second split be markdown only, without a normal terminal interaction (which is the default behavior for splits in guidebooks, hence the 2: default)

---
layout:
    1: terminal
    2: default
---

XXXX

---

YYYY

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.

@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 22, 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 22, 2022
@starpit starpit force-pushed the terminals-in-markdown branch 2 times, most recently from 150e6af to 43be2c7 Compare February 22, 2022 23:06
Right now, guidebooks can only have markdown content in splits. Some use cases would benefit from having one of their splits be a normal terminal.

This PR adds a `terminal` option to the guidebook topmatter, e.g. (from terminal1.md test input) this guidebook would have the first split offer a normal terminal interaction, and the second split be markdown only, without a normal terminal interaction (which is the default behavior for splits in guidebooks,  hence the `2: default`)

New splits can also now have inverted colors. See terminal3.md for an example.

```markdown
---
layout:
    1: terminal
    2: default
---

XXXX

---

YYYY
```
@starpit starpit force-pushed the terminals-in-markdown branch from 43be2c7 to 80cb571 Compare February 22, 2022 23:45
@starpit starpit merged commit dfb70f3 into kubernetes-retired:master Feb 23, 2022
@starpit starpit deleted the terminals-in-markdown branch February 23, 2022 00:06
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