Re-format for hugo docs #5489
Open
Re-format for hugo docs #5489
+411
−447
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This was referenced Nov 20, 2024
philrz
reviewed
Nov 20, 2024
docs/commands/super.md
Outdated
Comment on lines
27
to
52
| <<<<<<< HEAD | ||
| Each `input` argument must be a file path, an HTTP or HTTPS URL, | ||
| an S3 URL, or standard input specified with `-`. | ||
|
|
||
| For built-in command help and a listing of all available options, | ||
| simply run `super` with no arguments. | ||
|
|
||
| `super` supports a number of [input](#input-formats) and [output](#output-formats) formats, but [Super Binary](../formats/bsup.md) | ||
| tends to be the most space-efficient and most performant. Super Binary has efficiency similar to | ||
| [Avro](https://avro.apache.org) | ||
| and [Protocol Buffers](https://developers.google.com/protocol-buffers) | ||
| but its comprehensive [type system](../formats/zed.md) obviates | ||
| the need for schema specification or registries. | ||
| Also, the [Super JSON](../formats/jsup.md) format is human-readable and entirely one-to-one with Super Binary | ||
| so there is no need to represent non-readable formats like Avro or Protocol Buffers | ||
| in a clunky JSON encapsulated form. | ||
|
|
||
| `super` typically operates on Super Binary-encoded data and when you want to inspect | ||
| human-readable bits of output, you merely format it as Super JSON, which is the | ||
| default format when output is directed to the terminal. Super Binary is the default | ||
| when redirecting to a non-terminal output like a file or pipe. | ||
|
|
||
| When run with input arguments, each input's format is [automatically inferred](#auto-detection) | ||
| and each input is scanned | ||
| in the order appearing on the command line forming the input stream. | ||
| ======= |
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
docs/commands/super.md
Outdated
| The `super` command works with data from ephemeral sources like files and URLs. | ||
| If you want to persist your data into a data lake for persistent storage, | ||
| check out the [`super db`](super-db.md) set of commands. | ||
| >>>>>>> origin/main |
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
… this hugo-docs branch
philrz
reviewed
Nov 24, 2024
| @@ -13,4 +13,4 @@ jobs: | |||
| steps: | |||
| - name: Send dispatch event | |||
| run: | | |||
| curl -XPOST -u "${{ secrets.PAT_USERNAME }}:${{ secrets.PAT_TOKEN }}" -H "Accept: application/vnd.github.v3+json" -H "Content-Type: application/json" https://api.github.com/repos/brimdata/zed-docs-site/dispatches --data '{"event_type":"zed-docs-update"}' | |||
| curl -XPOST -u "${{ secrets.PAT_USERNAME }}:${{ secrets.PAT_TOKEN }}" -H "Accept: application/vnd.github.v3+json" -H "Content-Type: application/json" https://api.github.com/repos/brimdata/superdb-website/dispatches --data '{"event_type":"super-docs-update", "client_payload": {"commit_sha": "${{ github.sha }}"}}' | |||
There was a problem hiding this comment.
For now I've just got this rigged up to send the commits on this hugo-docs branch. When we eventually merge this to main, we can switch over to an approach like the one in notify-downstream-merge.yaml that sends the merge commit SHA.
philrz
reviewed
Nov 24, 2024
| @@ -3,7 +3,7 @@ name: Notify docs update | |||
| on: | |||
| push: | |||
| branches: | |||
| - main | |||
| - hugo-docs | |||
There was a problem hiding this comment.
Make sure we change this back to main when we merge.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary of changes.
In the front matter:
• sidebar_position becomes weight.
• sidebar_title becomes title.
• README becomes _index
• h1's have been removed from the markdown and rendered in the template with .Title or .Heading
If you want a different heading that what the title is, you can use the heading: key in the front matter.
Remove the
=>between code examples since we will have interactive playgrounds for all examples.