Skip to content

Commit

Permalink
Rename README.md->_index.md to fix broken hyperlinks
Browse files Browse the repository at this point in the history
  • Loading branch information
philrz committed Nov 25, 2024
1 parent fbf68a8 commit 6b125c0
Show file tree
Hide file tree
Showing 23 changed files with 63 additions and 63 deletions.
34 changes: 17 additions & 17 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@
* Improve the performance of the [`load` operator](docs/language/operators/load.md) by removing an unnecessary/inefficient merge (#5200)
* Improve the [`sort` operator](docs/language/operators/sort.md) to allow different ordering for each key (#5203, #5262)
* Update the [Zeek reference shaper docs](docs/integrations/zeek/shaping-zeek-json.md#reference-shaper-contents) to incorporate changes for [Zeek v7.0.0](https://github.com/zeek/zeek/releases/tag/v7.0.0) logs (#5212)
* Update the [`summarize` operator docs](docs/language/operators/summarize.md) to show the use of `by` without an [aggregate function](docs/language/aggregates/README.md) (#5216)
* Update the [`summarize` operator docs](docs/language/operators/summarize.md) to show the use of `by` without an [aggregate function](docs/language/aggregates/_index.md) (#5216)
* Update the [`grok` function docs](docs/language/functions/grok.md) with additional examples and guidance (#5243)
* Update the [Lateral Subquery docs](docs/language/lateral-subqueries.md) with an emphasis on when primitive values or arrays are returned by [Lateral Expressions](docs/language/lateral-subqueries.md#lateral-expressions) (#5264)
* The terms "pipeline" and "branch" are now used throughout the [Zed docs](docs/README.md) instead of "dataflow" and "leg" (#5272)
* The terms "pipeline" and "branch" are now used throughout the [Zed docs](docs/_index.md) instead of "dataflow" and "leg" (#5272)
* Add docs for [`lake` output format](docs/commands/super.md#superdb-data-lake-metadata-output) and [`zed ls`](docs/commands/super-db.md#ls) (#5187)
* Add docs for the [`top` operator](docs/language/operators/top.md) (#5276)
* Add [`fluentd` integration docs](docs/integrations/fluentd.md) (#5190, #5195)
Expand All @@ -22,13 +22,13 @@
* Add the `-pool` flag to [`zed manage`](docs/commands/super-db.md#manage) (#5164)
* Fix an issue where the lake API was not providing query descriptions for Zed programs that contain scopes (#5152)
* Fix an issue where attempts to use the [`load` operator](docs/language/operators/load.md) in `zq` caused a panic (#5162)
* Fix a parser issue with collisions between the names of [user-defined operators](docs/language/statements.md#operator-statements) and [functions](docs/language/statements.md#func-statements) and some built-in [operators](docs/language/operators/README.md) (#5161)
* Fix a parser issue with collisions between the names of [user-defined operators](docs/language/statements.md#operator-statements) and [functions](docs/language/statements.md#func-statements) and some built-in [operators](docs/language/operators/_index.md) (#5161)
* Fix an issue where using `null` values in math caused a panic (#5163)

## v1.16.0
* Improve ZNG scanning performance (#5101, #5103)
* Improve the error message shown when `zq` is invoked with a single argument that's not a valid query and doesn't contain a source (#5119)
* Update [Zeek integration docs](docs/integrations/zeek/README.md), including [reference shaper](docs/integrations/zeek/shaping-zeek-json.md) changes for [Zeek v6.2.0](https://github.com/zeek/zeek/releases/tag/v6.2.0) data (#5106)
* Update [Zeek integration docs](docs/integrations/zeek/_index.md), including [reference shaper](docs/integrations/zeek/shaping-zeek-json.md) changes for [Zeek v6.2.0](https://github.com/zeek/zeek/releases/tag/v6.2.0) data (#5106)
* [String literals](docs/language/expressions.md#formatted-string-literals) now use the "f-string" format `f"{ <expr> }"` instead of the previous `${ <expr> }` (#5123)
* Prototype SQL support has been dropped from the Zed language (full SQL support is expected at a later date) (#5109)
* Empty objects and arrays in JSON output are now consistently printed on a single line (#5127)
Expand Down Expand Up @@ -241,8 +241,8 @@

## v1.0.0

* Comprehensive [documentation](docs/README.md)
* Substantial improvements to the [Zed language](docs/language/README.md)
* Comprehensive [documentation](docs/_index.md)
* Substantial improvements to the [Zed language](docs/language/_index.md)
* Revamped [`zed` command](docs/commands/super-db.md)
* New Zed lake format (see #3634 for a migration script)
* New version of the [ZNG format](docs/formats/bsup.md) (with read-only support for the previous version)
Expand All @@ -264,7 +264,7 @@
* `zapi`, `zed lake serve`: Add authentication with Auth0 (#3266)
* Fix an issue preventing casting from `ip` to `ip` (#3259)
* `zed lake serve`: Respect the Accept request header for `GET /events` (#3246)
* Add [function documentation](docs/language/functions/README.md) (#3215)
* Add [function documentation](docs/language/functions/_index.md) (#3215)
* `zed lake serve`: Change the default response content encoding to ZSON (#3242)
* `zapi load`, `zed lake load`: Add the `-meta` flag to embed custom metadata in commits (#3237)

Expand All @@ -280,7 +280,7 @@
* Fix a panic when compiling `SELECT ... GROUP BY ...` (#3193)
* Fix a bug in which data loaded through the Zed lake service was stored uncompressed (#3198)
* Add all lake index commands to Zed lake service (#3181)
* Reorganize [language documentation](docs/language/README.md) (#3187)
* Reorganize [language documentation](docs/language/_index.md) (#3187)
* Make `fuse()` output deterministic (#3190)
* Use lake indexes to speed up queries (#3158)
* Fix bug where constants blocked `from` operator wiring logic (#3185)
Expand Down Expand Up @@ -329,7 +329,7 @@ As you can see below, there's been many changes since the last Zed GA release!
* Enhancements to the Zed language to unify search and expression syntax,
introduce new operators and functions for data exploration and shaping, and
more! Review the
[Zed language docs](docs/language/README.md)
[Zed language docs](docs/language/_index.md)
for details.

The exhaustive set of changes is listed below. Come talk to us on
Expand Down Expand Up @@ -454,7 +454,7 @@ questions.
* Fix an issue where `len()` of a `null` array was evaluating to something greater than zero (#2761)
* Fix an issue where `sort` with no fields was ignoring alias types and nested fields when picking a sort field (#2762)
* Fix an issue where unexpected `cut: no record found` warnings were returned by `zed lake query` but not when the same data was queried via `zq` (#2764)
* Move and extend the [Zeek interoperability docs](docs/integrations/zeek/README.md) (#2770, #2782, #2830)
* Move and extend the [Zeek interoperability docs](docs/integrations/zeek/_index.md) (#2770, #2782, #2830)
* Create endpoints in the Zed lake service API that correspond to underlying Zed lake operations, and expose them via `zapi` commands (#2741, #2774, #2786, #2775, #2794, #2795, #2796, #2920, #2925, #2928)
* Fix an issue where `zq` would surface a syntax error when reading ZSON it had sent as output (#2792)
* Add an `/events` endpoint to the API, which can be used by clients such as the Brim app to be notified of pool updates (#2791)
Expand All @@ -469,8 +469,8 @@ questions.
* Have the [Python client](python) use the `/query` endpoint for the Zed lake (#2869)
* Minimize the amount of surrounding context shown when reporting parse errors (#2864)
* Field assignments in [`join`](docs/language/operators/join.md) now behave like [`cut`](docs/language/operators/cut.md) instead of `pick` (#2868)
* Add more background/context to Zed top-level language [README](docs/language/README.md) (#2866 #2878, #2901)
* Unify `from`, `split`, and `switch` syntax to the forms shown [here](docs/language/README.md) (#2871, #2896)
* Add more background/context to Zed top-level language [README](docs/language/_index.md) (#2866 #2878, #2901)
* Unify `from`, `split`, and `switch` syntax to the forms shown [here](docs/language/_index.md) (#2871, #2896)
* Shapers can now cast values of the `null` type to any type (e.g., arrays or records) (#2882)
* Fix an issue where [`join`](docs/language/operators/join.md) was failing to match on values of comparable types (e.g., `string` and `bstring`) (#2880, #2884)
* Shapers can now cast a value to a `union` type (#2881)
Expand Down Expand Up @@ -628,7 +628,7 @@ questions.

## v0.23.0
* zql: Add `week` as a unit for [time grouping with `every`](docs/language/functions/every.md) (#1374)
* zq: Fix an issue where a `null` value in a [JSON type definition](docs/integrations/zeek/README.md) caused a failure without an error message (#1377)
* zq: Fix an issue where a `null` value in a [JSON type definition](docs/integrations/zeek/_index.md) caused a failure without an error message (#1377)
* zq: Add [`zst` format](docs/formats/csup.md) to `-i` and `-f` command-line help (#1384)
* zq: ZNG spec and `zq` updates to introduce the beta ZNG storage format (#1375, #1415, #1394, #1457, #1512, #1523, #1529), also addressing the following:
* New data type `bytes` for storing sequences of bytes encoded as base64 (#1315)
Expand All @@ -644,11 +644,11 @@ questions.
* zqd: Check and convert alpha ZNG filestores to beta ZNG (#1574, #1576)
* zq: Fix an issue where spill-to-disk file names could collide (#1391)
* zq: Allow the [`fuse` operator](docs/language/operators/fuse.md) to spill-to-disk to avoid memory limitations (#1355, #1402)
* zq: No longer require `_path` as a first column in a [JSON type definition](docs/integrations/zeek/README.md) (#1370)
* zq: No longer require `_path` as a first column in a [JSON type definition](docs/integrations/zeek/_index.md) (#1370)
* zql: Improve ZQL docs for [aggregate functions](docs/language/operators/summarize.md) and grouping (#1385)
* zql: Point links for developer docs at [pkg.go.dev](https://pkg.go.dev/) instead of [godoc.org](https://godoc.org/) (#1401)
* zq: Add support for timestamps with signed timezone offsets (#1389)
* zq: Add a [JSON type definition](docs/integrations/zeek/README.md) for alert events in [Suricata EVE logs](https://suricata.readthedocs.io/en/suricata-5.0.2/output/eve/eve-json-output.html) (#1400)
* zq: Add a [JSON type definition](docs/integrations/zeek/_index.md) for alert events in [Suricata EVE logs](https://suricata.readthedocs.io/en/suricata-5.0.2/output/eve/eve-json-output.html) (#1400)
* zq: Update the [ZNG over JSON (ZJSON)](docs/formats/zjson.md) spec and implementation (#1299)
* zar: Use buffered streaming for archive import (#1397)
* zq: Add an `ast` command that prints parsed ZQL as its underlying JSON object (#1416)
Expand Down Expand Up @@ -695,7 +695,7 @@ questions.
* zql: Fix broken links in documentation (#1321, #1339)
* zst: Introduce the [ZST format](docs/formats/csup.md) for columnar data based on ZNG (#1268, #1338)
* pcap: Fix an issue where certain pcapng files could fail import with a `bad option length` error (#1341)
* zql: [Document the `**` operator](docs/language/README.md#search-syntax) for type-specific searches that look within nested records (#1337)
* zql: [Document the `**` operator](docs/language/search-expressions.md) for type-specific searches that look within nested records (#1337)
* zar: Change the archive data file layout to prepare for handing chunk files with overlapping ranges and improved S3 support (#1330)
* zar: Support archive data files with overlapping time spans (#1348)
* zqd: Add a page containing guidance for users that directly access the root `zqd` endpoint in a browser (#1350)
Expand Down Expand Up @@ -789,7 +789,7 @@ questions.
* zql: Add a new function `Time.trunc()` (#842)
* zql: Support grouping by computed keys (#860)
* zq: Change implementation of `every X` to use a computed groupby key (#893)
* zql: Clean up the [ZQL docs](docs/language/README.md) (#884)
* zql: Clean up the [ZQL docs](docs/language/_index.md) (#884)
* zql: Change `cut` operator to emit any matching fields (#899)
* zq: Allow output to an S3 bucket (#889)

Expand Down
10 changes: 5 additions & 5 deletions docs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ heading: SuperDB
---

SuperDB offers a new approach that makes it easier to manipulate and manage
your data. With its [super-structured data model](formats/README.md#2-a-super-structured-pattern),
your data. With its [super-structured data model](formats/_index.md#2-a-super-structured-pattern),
messy JSON data can easily be given the fully-typed precision of relational tables
without giving up JSON's uncanny ability to represent eclectic data.

Expand All @@ -26,7 +26,7 @@ while for a technical user, SuperDB exposes its technical underpinnings
in a gradual slope, providing as much detail as desired,
packaged up in the easy-to-understand
[Super JSON data format](formats/jsup.md) and
[SuperPipe language](language/README.md).
[SuperPipe language](language/_index.md).

While `super` and its accompanying data formats are production quality, the project's
[SuperDB data lake](commands/super-db.md) is a bit [earlier in development](commands/super-db.md#status).
Expand All @@ -37,12 +37,12 @@ While `super` and its accompanying data formats are production quality, the proj
a number of different elements of the system:
* The [super data model](formats/zed.md) is the abstract definition of the data types and semantics
that underlie the super-structured data formats.
* The [super data formats](formats/README.md) are a family of
* The [super data formats](formats/_index.md) are a family of
[human-readable (Super JSON, JSUP)](formats/jsup.md),
[sequential (Super Binary, BSUP)](formats/bsup.md), and
[columnar (Super Columnar, CSUP)](formats/csup.md) formats that all adhere to the
same abstract super data model.
* The [SuperPipe language](language/README.md) is the system's pipeline language for performing
* The [SuperPipe language](language/_index.md) is the system's pipeline language for performing
queries, searches, analytics, transformations, or any of the above combined together.
* A [SuperPipe query](language/overview.md) is a script that performs
search and/or analytics.
Expand All @@ -57,7 +57,7 @@ accessed via a [Git](https://git-scm.com/)-like API.

## Digging Deeper

The [SuperPipe language documentation](language/README.md)
The [SuperPipe language documentation](language/_index.md)
is the best way to learn about `super` in depth.
All of its examples use `super` commands run on the command line.
Run `super -h` for a list of command options and online help.
Expand Down
4 changes: 2 additions & 2 deletions docs/commands/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ into, querying, and orchestrating SuperDB data lakes. These sub-commands are
organized into further subcommands like the familiar command patterns
of `docker` or `kubectl`.

All operations with these commands utilize the [super data model](../formats/README.md)
and provide querying via [SuperSQL](../language/README.md).
All operations with these commands utilize the [super data model](../formats/_index.md)
and provide querying via [SuperSQL](../language/_index.md).

Built-in help for `super` and all sub-commands is always accessible with the `-h` flag.
6 changes: 3 additions & 3 deletions docs/commands/super-db.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: super db

> **TL;DR** `super db` is a sub-command of `super` to manage and query SuperDB data lakes.
> You can import data from a variety of formats and it will automatically
> be committed in [super-structured](../formats/README.md)
> be committed in [super-structured](../formats/_index.md)
> format, providing full fidelity of the original format and the ability
> to reconstruct the original data without loss of information.
>
Expand All @@ -16,7 +16,7 @@ title: super db
<p id="status"></p>

:::tip Status
While [`super`](super.md) and its accompanying [formats](../formats/README.md)
While [`super`](super.md) and its accompanying [formats](../formats/_index.md)
are production quality, the SuperDB data lake is still fairly early in development
and alpha quality.
That said, SuperDB data lakes can be utilized quite effectively at small scale,
Expand Down Expand Up @@ -657,7 +657,7 @@ according to configured policies and logic.
```
super db query [options] <query>
```
The `query` command runs a [SuperSQL](../language/README.md) query with data from a lake as input.
The `query` command runs a [SuperSQL](../language/_index.md) query with data from a lake as input.
A query typically begins with a [`from` operator](../language/operators/from.md)
indicating the pool and branch to use as input.

Expand Down
18 changes: 9 additions & 9 deletions docs/commands/super.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ weight: 1
title: super
---

> **TL;DR** `super` is a command-line tool that uses [SuperSQL](../language/README.md)
> **TL;DR** `super` is a command-line tool that uses [SuperSQL](../language/_index.md)
> to query a variety of data formats in files, over HTTP, or in [S3](../integrations/amazon-s3.md)
> storage. Best performance is achieved when operating on data in binary formats such as
> [Super Binary](../formats/bsup.md), [Super Columnar](../formats/csup.md),
Expand All @@ -18,7 +18,7 @@ super [ options ] [ -c query ] input [ input ... ]

`super` is a command-line tool for processing data in diverse input
formats, providing data wrangling, search, analytics, and extensive transformations
using the [SuperSQL](../language/README.md) dialect of SQL. Any SQL query expression
using the [SuperSQL](../language/_index.md) dialect of SQL. Any SQL query expression
may be extended with [pipe syntax](https://research.google/pubs/sql-has-problems-we-can-fix-them-pipe-syntax-in-sql/)
to filter, transform, and/or analyze input data.
Super's SQL pipes dialect is extensive, so much so that it can resemble
Expand All @@ -28,10 +28,10 @@ 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.

By invoking the `-c` option, a query expressed in the [SuperSQL language](../language/README.md)
By invoking the `-c` option, a query expressed in the [SuperSQL language](../language/_index.md)
may be specified and applied to the input stream.

The [super data model](../formats/zed.md) is based on [super-structured data](../formats/README.md#2-a-super-structured-pattern), meaning that all data
The [super data model](../formats/zed.md) is based on [super-structured data](../formats/_index.md#2-a-super-structured-pattern), meaning that all data
is both strongly _and_ dynamically typed and need not conform to a homogeneous
schema. The type structure is self-describing so it's easy to daisy-chain
queries and inspect data at any point in a complex query or data pipeline.
Expand Down Expand Up @@ -571,15 +571,15 @@ error("divide by zero")

## Examples

As you may have noticed, many examples of the [SuperSQL language](../language/README.md)
As you may have noticed, many examples of the [SuperSQL language](../language/_index.md)
are illustrated using this pattern
```
echo <values> | super -c <query> -
```
which is used throughout the [language documentation](../language/README.md)
and [operator reference](../language/operators/README.md).
which is used throughout the [language documentation](../language/_index.md)
and [operator reference](../language/operators/_index.md).

The language documentation and [tutorials directory](../tutorials/README.md)
The language documentation and [tutorials directory](../tutorials/_index.md)
have many examples, but here are a few more simple `super` use cases.

_Hello, world_
Expand Down Expand Up @@ -613,7 +613,7 @@ produces
<[(int64,string)]>
<|[string]|>
```
_A simple [aggregation](../language/aggregates/README.md)_
_A simple [aggregation](../language/aggregates/_index.md)_
```mdtest-command
echo '{key:"foo",val:1}{key:"bar",val:2}{key:"foo",val:3}' |
super -z -c 'sum(val) by key | sort key' -
Expand Down
2 changes: 1 addition & 1 deletion docs/formats/csup.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ heading: Super Columnar Specification
Super Columnar is a file format based on
the [super data model](zed.md) where data is stacked to form columns.
Its purpose is to provide for efficient analytics and search over
bounded-length sequences of [super-structured data](./README.md#2-a-super-structured-pattern) that is stored in columnar form.
bounded-length sequences of [super-structured data](./_index.md#2-a-super-structured-pattern) that is stored in columnar form.

Like [Parquet](https://github.com/apache/parquet-format),
Super Columnar provides an efficient representation for semi-structured data,
Expand Down
Loading

0 comments on commit 6b125c0

Please sign in to comment.