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

Metadata standard for guides #17

Open
jonathansick opened this issue Sep 14, 2021 · 0 comments
Open

Metadata standard for guides #17

jonathansick opened this issue Sep 14, 2021 · 0 comments

Comments

@jonathansick
Copy link
Contributor

In tutorials, we currently extract metadata based on a standardized format. For guides, with only one currently available, there isn't any such standard. And further, there's some metadata types that aren't currently extracted for guides: namely keywords. This is a good opportunity to design a metadata system for guides that is straightforward for authors to use, and provides a rich set of metadata that can be reliably extracted by Librarian.

One possibility is to use standard HTML meta headers in the JupyterBook output. Another possibility is to include a JSON sidecar file with each JupyterBook that's linked via a <link> header.

Note a related issue, #14, to automatically capture package keywords. I think that an explicity metadata file could still be useful for types of metadata such as authors and scientific domain/task keywords that may be tricky to extract from the JupyterBook HTML

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

1 participant