From 62ad8b6cd61c570461f66a7083ff18c79804543a Mon Sep 17 00:00:00 2001 From: Archie Wood <58074498+archiewood@users.noreply.github.com> Date: Fri, 1 Nov 2024 23:06:45 -0400 Subject: [PATCH 1/2] add evidence --- docs/hub/_toctree.yml | 2 + docs/hub/spaces-sdks-docker-evidence.md | 56 +++++++++++++++++++++++++ 2 files changed, 58 insertions(+) create mode 100644 docs/hub/spaces-sdks-docker-evidence.md diff --git a/docs/hub/_toctree.yml b/docs/hub/_toctree.yml index d5b2f0405..5f83433ae 100644 --- a/docs/hub/_toctree.yml +++ b/docs/hub/_toctree.yml @@ -279,6 +279,8 @@ title: Tabby on Spaces - local: spaces-sdks-docker-giskard title: Giskard on Spaces + - local: spaces-sdks-docker-evidence + title: Evidence on Spaces - local: spaces-embed title: Embed your Space - local: spaces-run-with-docker diff --git a/docs/hub/spaces-sdks-docker-evidence.md b/docs/hub/spaces-sdks-docker-evidence.md new file mode 100644 index 000000000..3d4867d13 --- /dev/null +++ b/docs/hub/spaces-sdks-docker-evidence.md @@ -0,0 +1,56 @@ +# Evidence on Spaces + +**Evidence** is an open-source framework designed for building data-driven applications, reports, and dashboards using SQL and Markdown. With Evidence, you can quickly create decision-support tools, reports, and interactive dashboards without relying on traditional drag-and-drop business intelligence (BI) platforms. + +Evidence enables you to: +- Write reports and dashboards directly in Markdown with SQL-backed components. +- Integrate data from multiple sources, including SQL databases and APIs. +- Use templated pages to automatically generate multiple pages based on a single template. +- Deploy reports seamlessly to various hosting solutions. + +Visit [Evidence’s documentation](https://docs.evidence.dev/) for guides, examples, and best practices for using Evidence to create data products. + +## Deploy Evidence on Spaces + +You can deploy Evidence on Hugging Face Spaces with just a few clicks: + + + + + +Once created, the Space will display `Building` status. Refresh the page if the status doesn't automatically update to `Running`. + +Your Evidence app will automatically be deployed on Hugging Face Spaces. + +## Editing your Evidence app from the CLI + +To edit your app, clone the Space and edit the files locally. + +```bash +git clone https://huggingface.co/spaces/your-username/your-space-name +cd your-space-name +npm install +npm run sources +npm run dev +``` + +You can then modify pages/index.md to change the content of your app. + +## Editing your Evidence app from VS Code + +The easiest way to develop with Evidence is using the [VS Code Extension](https://marketplace.visualstudio.com/items?itemName=Evidence.evidence-vscode): + +1. Install the extension from the VS Code Marketplace +2. Open the Command Palette (Ctrl/Cmd + Shift + P) and enter `Evidence: Copy Existing Project` +3. Paste the URL of the Hugging Face Spaces Evidence app you'd like to copy (e.g. `https://huggingface.co/spaces/your-username/your-space-name`) and press Enter +4. Select the folder you'd like to clone the project to and press Enter +5. Press `Start Evidence` in the bottom status bar + +Check out the docs for [alternative install methods](https://docs.evidence.dev/getting-started/install-evidence), Github Codespaces, and alongside dbt. + +## Learning More + +- [Docs](https://docs.evidence.dev/) +- [Github](https://github.com/evidence-dev/evidence) +- [Slack Community](https://slack.evidence.dev/) +- [Evidence Home Page](https://www.evidence.dev) \ No newline at end of file From 96f98b23fc5d6b198cab32b71f540781482c8ab6 Mon Sep 17 00:00:00 2001 From: Archie Sarre Wood <58074498+archiewood@users.noreply.github.com> Date: Mon, 4 Nov 2024 17:19:40 -0500 Subject: [PATCH 2/2] Update docs/hub/_toctree.yml Co-authored-by: Caleb Fahlgren --- docs/hub/_toctree.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/hub/_toctree.yml b/docs/hub/_toctree.yml index 5f83433ae..288c6fb1c 100644 --- a/docs/hub/_toctree.yml +++ b/docs/hub/_toctree.yml @@ -281,6 +281,8 @@ title: Giskard on Spaces - local: spaces-sdks-docker-evidence title: Evidence on Spaces + - local: spaces-sdks-docker-marimo + title: marimo on Spaces - local: spaces-embed title: Embed your Space - local: spaces-run-with-docker