docs(datatypes): Parquet BYTE_ARRAY strings and binaries read as LargeUtf8/LargeBinary (#2252)
Co-authored-by: claudespice <claudespice@users.noreply.github.com>
19 days ago
docs(reference): document the sub-second duration units and fractional values
The Duration reference listed only s/m/h/d/w and described durations as
integers. Both parsers the runtime uses accept more: duration-parse (used
by spicepod runtime fields) and fundu 2.0.1 (used by acceleration duration
params) both accept ns, microseconds, and ms, accept fractional and
exponent forms, treat a bare number as seconds, and reject month/year.
fundu is pinned at 2.0.1 in every release tag from v1.5.2 through v2.1.1
and on trunk, so this correction applies to all versioned snapshots.
2 months ago
docs(datasets): a time_format mismatch fails the dataset, and iso8601 on a timestamp or date column is ignored with a warning (#2325)
* docs(datasets): a time_format mismatch fails the dataset, and iso8601 on a timestamp or date column is ignored with a warning (spiceai/spiceai#14777)
* docs(datasets): a string time_column needs time_format iso8601 (spiceai/spiceai#14777)
6 days ago
docs(sql): SQL PREPARE/EXECUTE need a Flight SQL session; document parameter binding (#2251)
19 days ago
Check in versioned docs and remove generate-versions script (#1386)
* Check in versioned docs and remove generate-versions script
Transition from per-branch versioning to all versions checked in.
Generated versioned docs from release branches 1.5 through 1.11.
Removed generate-versions.sh and updated .gitignore.
* Remove generate-versions script from build workflow
Versioned docs are now checked in directly. Remove the script
invocation from package.json build, drop the fetch-depth: 0 from CI
(no longer needed), and update README to reflect the new process.
8 months ago
docs(distributions): make install-nas and make build-runtime do not exist
`reference/distributions.md` documents three things the build system does not
support:
1. `make install-nas` — no such target. The string "nas" appears nowhere in the
Makefile. On trunk / v2.0.1 / v2.1.4 the NFS build target is `install-nfs`;
at v1.11.6 no convenience target exists and the equivalent invocation is
`make install SPICED_NON_DEFAULT_FEATURES="nfs"`.
2. `make build-runtime` — no such target on trunk / v2.0.x / v2.1.x; the build
targets are `build` (→ `build-cli build-spiced`) and `install`. The target
did exist at v1.11.6, so the 1.11.x snapshot is left unchanged.
3. The "NAS (SMB + NFS)" grouping mis-scopes SMB. `smb` is in the `spiced`
`default` feature set (and in `SPICED_DATA_FEATURES`) at every release
checked, so SMB ships in the standard open-source build. Only `nfs` is
feature-gated — which is what `components/data-connectors/nfs.md` already
says, while `smb.md` correctly carries no Enterprise callout.
Renames the variant to "NFS" across the availability table, the section, the
platform-support table, and the "Choosing a Distribution" table.
2 months ago
docs: Update file formats and data connectors documentation (#1409)
7 months ago
Check in versioned docs and remove generate-versions script (#1386)
* Check in versioned docs and remove generate-versions script
Transition from per-branch versioning to all versions checked in.
Generated versioned docs from release branches 1.5 through 1.11.
Removed generate-versions.sh and updated .gitignore.
* Remove generate-versions script from build workflow
Versioned docs are now checked in directly. Remove the script
invocation from package.json build, drop the fetch-depth: 0 from CI
(no longer needed), and update README to reflect the new process.
8 months ago
Add Distributions reference page (#1483)
6 months ago
Check in versioned docs and remove generate-versions script (#1386)
* Check in versioned docs and remove generate-versions script
Transition from per-branch versioning to all versions checked in.
Generated versioned docs from release branches 1.5 through 1.11.
Removed generate-versions.sh and updated .gitignore.
* Remove generate-versions script from build workflow
Versioned docs are now checked in directly. Remove the script
invocation from package.json build, drop the fetch-depth: 0 from CI
(no longer needed), and update README to reflect the new process.
8 months ago
Add Distributions reference page (#1483)
6 months ago
Update documentation for Spice CLI and runtime
- Changed Spicepod version from v1beta1 to v1 in add.md
- Enabled dataset acceleration by default in dataset.md
- Expanded command reference in index.md to include new commands and descriptions
- Updated run.md to reflect new flags and options for the Spice runtime
- Removed OpenTelemetry status from status.md
- Updated version.md to reflect new CLI and runtime versions
- Added optional metrics configuration in Docker deployment documentation
- Updated Kubernetes deployment parameters for image repository and tag
- Cleaned up getting started documentation by removing unnecessary metrics log
- Removed Go installation instructions from installation.md
- Added new runtime configuration options for flight, ready_state, and scheduler in runtime.md
- Clarified system requirements documentation regarding port usage and requirements
8 months ago
docs(task_history): the default retention period is 8h, not 30 minutes
The intro said task history is enabled by default with a 30-minute retention
period, contradicting the same page's parameter list (and runtime.md), both of
which correctly document 8h. default_retention_period() has returned "8h"
since the retention options were introduced.
2 months ago