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

validate that our documentation has HTML metadata #39

Open
edublancas opened this issue Mar 4, 2023 · 1 comment
Open

validate that our documentation has HTML metadata #39

edublancas opened this issue Mar 4, 2023 · 1 comment

Comments

@edublancas
Copy link
Contributor

edublancas commented Mar 4, 2023

we should fail the CI if any document in our docs is missing HTML metadata

documentation: https://github.com/ploomber/contributing/blob/main/documentation/seo.md

we can implement it as part of the pkgmt check command, since that runs in our CI already: https://github.com/ploomber/pkgmt/blob/main/src/pkgmt/cli.py#L56

we're also missing how to include a preview image. ideally we should have a default one because we wont have unique header images for all sections

@edublancas
Copy link
Contributor Author

note that in jupyter-book 0.14 the format has changed from:

html_meta:
    description lang=en: Create line, bar and pie charts from SQL queries in a Jupyter notebook using JupySQL
    keywords: jupyter, sql, jupysql, plotting, matplotlib
    property=og:locale: en_US

to

myst:
  html_meta:
    description lang=en: Create line, bar and pie charts from SQL queries in a Jupyter notebook using JupySQL
    keywords: jupyter, sql, jupysql, plotting, matplotlib
    property=og:locale: en_US

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