Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation, with its own documentation site #21

Closed
simonw opened this issue Nov 24, 2023 · 9 comments
Closed

Documentation, with its own documentation site #21

simonw opened this issue Nov 24, 2023 · 9 comments
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@simonw
Copy link
Collaborator

simonw commented Nov 24, 2023

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 simonw added the documentation Improvements or additions to documentation label Nov 24, 2023
@simonw
Copy link
Collaborator Author

simonw commented Nov 24, 2023

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

@simonw
Copy link
Collaborator Author

simonw commented Nov 24, 2023

@simonw
Copy link
Collaborator Author

simonw commented Nov 24, 2023

@simonw
Copy link
Collaborator Author

simonw commented Nov 25, 2023

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
Copy link
Collaborator Author

simonw commented Nov 25, 2023

Realized I don't need cogapp for this project.

simonw added a commit that referenced this issue Nov 25, 2023
Also removed cogapp since I do not need it.
@simonw
Copy link
Collaborator Author

simonw commented Nov 25, 2023

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

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

@simonw
Copy link
Collaborator Author

simonw commented Nov 25, 2023

@simonw
Copy link
Collaborator Author

simonw commented Nov 25, 2023

@simonw
Copy link
Collaborator Author

simonw commented Nov 25, 2023

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

@simonw simonw closed this as completed in 1d3fa43 Nov 25, 2023
simonw added a commit that referenced this issue Nov 28, 2023
@simonw simonw added this to the First alpha milestone Nov 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant