diff --git a/docs/docs/icechunk-python/quickstart2.ipynb b/docs/docs/icechunk-python/quickstart2.ipynb new file mode 100644 index 00000000..db896d84 --- /dev/null +++ b/docs/docs/icechunk-python/quickstart2.ipynb @@ -0,0 +1,49 @@ +{ + "cells": [ + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "\n", + "# Quickstart\n", + "\n", + "Icechunk is designed to be mostly in the background.\n", + "As a Python user, you'll mostly be interacting with Zarr.\n", + "If you're not familiar with Zarr, you may want to start with the [Zarr Tutorial](https://zarr.readthedocs.io/en/latest/tutorial.html)\n", + "\n", + "## Installation\n", + "\n", + "Icechunk can be installed using pip or conda:\n", + "\n", + "=== \"pip\"\n", + "\n", + " ```bash\n", + " python -m pip install icechunk\n", + " ```\n", + "\n", + "=== \"conda\"\n", + "\n", + " ```bash\n", + " conda install -c conda-forge icechunk\n", + " ```\n", + "\n", + "!!! note\n", + "\n", + " Icechunk is currently designed to support the [Zarr V3 Specification](https://zarr-specs.readthedocs.io/en/latest/v3/core/v3.0.html).\n", + " Using it today requires installing Zarr Python 3.\n" + ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [] + } + ], + "metadata": { + "language_info": { + "name": "python" + } + }, + "nbformat": 4, + "nbformat_minor": 2 +} diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 00c70734..2dfe0136 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -138,7 +138,7 @@ plugins: paths: [../icechunk-python/python] - mkdocs-jupyter: include_source: True - include: ["*.ipynb"] # Default: ["*.py", "*.ipynb"] + # include: ["*.ipynb"] # Default: ["*.py", "*.ipynb"] - markdown-exec # - "icechunk-python/docs/**/*.ipynb" # - "icechunk-python/docs/docs/icechunk-python/*.ipynb" @@ -176,7 +176,6 @@ nav: - FAQ: faq.md - Icechunk Python: - Quickstart: icechunk-python/quickstart.md - - Quickstart2: icechunk-python/quickstart2.ipynb - Configuration: icechunk-python/configuration.md - Storage: icechunk-python/storage.md - FAQ: icechunk-python/faq.md