Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(hack) Convert guides to YAML and pretty print #2937

Merged
merged 1 commit into from
Jul 20, 2021

Commits on Jul 20, 2021

  1. (hack) Convert guides to YAML and pretty print

    When we first implemented the `guide` subcommand, we chose to make the
    file format of guides flat text and documented how users could add their
    own guides to Bolt to be loaded by the `bolt guide` subcommand. While
    useful, we haven't seen anyone use this functionality, and further it
    does not seem like the file format has much impact on whether users add
    their own guides or not. This converts the file format from flat text to
    YAML, which supports both being read as data and formatting multiline
    strings. This lets us format the `bolt guide <guide>` output to be more
    readable and inline with other bolt output, make the guide text easily
    editable (as opposed to JSON), and still lets users add their own guides
    if they choose.
    
    !feature
    
    * **Beautify `bolt guide` output** (hack)
      This converts our existing guides from flat text to YAML so that they
      can be pretty printed.
    lucywyman committed Jul 20, 2021
    Configuration menu
    Copy the full SHA
    2324455 View commit details
    Browse the repository at this point in the history