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

Expand config docs #15

Closed
jefftriplett opened this issue Nov 28, 2020 · 1 comment
Closed

Expand config docs #15

jefftriplett opened this issue Nov 28, 2020 · 1 comment

Comments

@jefftriplett
Copy link

Feel free to close this, but I struggled to figure out how to configure this plugin, what the config file should be called, and where it should live.

I skimmed docs and started with config.json, but I keep seeing The path plugin configuration is required.

Eventually, I noticed datasette serve --metadata=metadata.json in some examples from your main docs. (I'll submit a patch for a typo I noticed too.)

I'm opening this for anyone else who tries it out and runs into this issue.

@simonw
Copy link
Owner

simonw commented Nov 28, 2020

Yeah, this is a wider problem with Datasette: metadata.json started out as a feature for adding license/source metadata, but it grew all kinds of extra features related to configuration, especially for plugins.

I have an open issue for fixing that here: simonw/datasette#493 - it's included in the 1.0 milestone, but it's going to take a fair bit of work to redesign everything.

In the meantime, expanding the documentation for this plugin feels like a good idea.

@simonw simonw closed this as completed in 16601d8 Nov 28, 2020
simonw added a commit that referenced this issue Nov 28, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants