datasette / datasette-enrichments

Tools for running enrichments against data stored in Datasette
https://enrichments.datasette.io
Apache License 2.0
19 stars 0 forks source link

Documentation, with its own documentation site #21

Closed simonw closed 10 months ago

simonw commented 10 months ago

I think the documentation for this is going to deserve a full site, ala https://shot-scraper.datasette.io/ and https://llm.datasette.io/

I think enrichments.datasette.io

It needs a site rather than just a README beacuse it will need things like a tutorial on how to write enrichments.

simonw commented 10 months ago

I'm going to implement this pattern: https://til.simonwillison.net/readthedocs/stable-docs

simonw commented 10 months ago

Now live at https://datasette-enrichments.readthedocs.io/en/latest/

simonw commented 10 months ago

Extracted a TIL: https://til.simonwillison.net/readthedocs/pip-install-docs

simonw commented 10 months ago

When I write the tutorial I can start with this bit:


## Using the cookiecutter template

The [datasette-plugin cookiecutter template](https://github.com/simonw/datasette-plugin) is a useful starting point for a new plugin.

Once you have [installed cookiecutter](https://cookiecutter.readthedocs.io/en/stable/installation.html) you can create a new plugin like this:
```bash
cookiecutter gh:simonw/datasette-plugin

Then answer the questions. Be sure to call your plugin enrichments-something:

plugin_name []: enrichments-favicon
description []: Fetch favicons for a URL
hyphenated [enrichments-favicon]: <enter>
underscored [enrichments_favicon]: <enter>
github_username []: simonw
author_name []: Simon Willison
include_static_directory []: <enter>
include_templates_directory []: <enter>

Hitting <enter> accepts the default value.

Running this command will create a new plugin in a datasette-enrichments-favicon/ folder.

simonw commented 10 months ago

Realized I don't need cogapp for this project.

simonw commented 10 months ago

I'm going to point enrichments.datasette.io at this.

https://til.simonwillison.net/readthedocs/custom-subdomain

simonw commented 10 months ago

https://vercel.com/dashboard/domains/datasette.io

CleanShot 2023-11-24 at 21 00 20@2x

simonw commented 10 months ago

https://readthedocs.org/dashboard/datasette-enrichments/domains/

CleanShot 2023-11-24 at 21 01 28@2x

simonw commented 10 months ago

https://enrichments.datasette.io/ works now.