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
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: quote placeholders in shell examples so the blocks paste safely
An unquoted <placeholder> inside a shell-tagged fence is redirection from
a file of that name, so a copied command aborts (exit 1), fails to parse
(exit 2), or — where it sits mid-block — is silently skipped while the
block still reports exit 0. Quote the placeholder, which keeps it visible
as a placeholder and passes it through verbatim.
Usage synopses are left alone: where a fence carries [...] optional-argument
notation, or a placeholder fills a command slot, the <> is grammar for the
command's shape rather than a command to paste.
Fixes #2196
a month 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
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
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
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
Integrate async queries API into distributed query docs (#1388)
* Integrate async queries API into distributed query docs
- Add full async queries API reference (HTTP REST + Arrow Flight) as a
section within the distributed query feature doc
- Add spice query CLI and interactive REPL documentation
- Add job lifecycle, error codes, storage layout, and defaults
- Fix duplicated Network Ports and mTLS sections (appeared 3x, now 1x)
- Add scheduler.state_location prerequisite and configuration examples
* Update command references and fix links in CLI documentation
* Update CLI documentation for async query command and improve formatting
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
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: quote placeholders in shell examples so the blocks paste safely
An unquoted <placeholder> inside a shell-tagged fence is redirection from
a file of that name, so a copied command aborts (exit 1), fails to parse
(exit 2), or — where it sits mid-block — is silently skipped while the
block still reports exit 0. Quote the placeholder, which keeps it visible
as a placeholder and passes it through verbatim.
Usage synopses are left alone: where a fence carries [...] optional-argument
notation, or a placeholder fills a command slot, the <> is grammar for the
command's shape rather than a command to paste.
Fixes #2196
a month 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
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
Integrate async queries API into distributed query docs (#1388)
* Integrate async queries API into distributed query docs
- Add full async queries API reference (HTTP REST + Arrow Flight) as a
section within the distributed query feature doc
- Add spice query CLI and interactive REPL documentation
- Add job lifecycle, error codes, storage layout, and defaults
- Fix duplicated Network Ports and mTLS sections (appeared 3x, now 1x)
- Add scheduler.state_location prerequisite and configuration examples
* Update command references and fix links in CLI documentation
* Update CLI documentation for async query command and improve formatting
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
docs(cli): correct spice run --metrics-endpoint default (disabled by default, not 127.0.0.1:9090) (#1808)
Co-authored-by: claudespice <claudespice@users.noreply.github.com>
3 months ago
docs: quote placeholders in shell examples so the blocks paste safely
An unquoted <placeholder> inside a shell-tagged fence is redirection from
a file of that name, so a copied command aborts (exit 1), fails to parse
(exit 2), or — where it sits mid-block — is silently skipped while the
block still reports exit 0. Quote the placeholder, which keeps it visible
as a placeholder and passes it through verbatim.
Usage synopses are left alone: where a fence carries [...] optional-argument
notation, or a placeholder fills a command slot, the <> is grammar for the
command's shape rather than a command to paste.
Fixes #2196
a month ago
docs: quote placeholders in shell examples so the blocks paste safely
An unquoted <placeholder> inside a shell-tagged fence is redirection from
a file of that name, so a copied command aborts (exit 1), fails to parse
(exit 2), or — where it sits mid-block — is silently skipped while the
block still reports exit 0. Quote the placeholder, which keeps it visible
as a placeholder and passes it through verbatim.
Usage synopses are left alone: where a fence carries [...] optional-argument
notation, or a placeholder fills a command slot, the <> is grammar for the
command's shape rather than a command to paste.
Fixes #2196
a month 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
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
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
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