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

Add a CLI command allowing to check metadata #15

Closed
lebouquetin opened this issue Jun 27, 2024 · 1 comment
Closed

Add a CLI command allowing to check metadata #15

lebouquetin opened this issue Jun 27, 2024 · 1 comment

Comments

@lebouquetin
Copy link
Member

lebouquetin commented Jun 27, 2024

In web pages, metadata allow to improve searchability of the pages (SEO).

A CLI command which help to detect which pages are well documented and which ones are not would be very helpful.

Expected:

A a list of metadata keys to be found in every content, something like:

JFME_CONTENT_REQUIRED_METADATA=[
    "title", "slug", "description", "language", "lang", "og:title", "og:description", "og:type",
    "og:site_name", "og:url", "og:image", "og:locale"
]

The when running the CLI command the result would be to identify missing metatada.

./manage.py check-metadata [--verbose] [content path]

which would return a status for all pages with a percentage (x% computed based on required metadata found vs required metadata total number)

Example of result:

80% fr-index.md
90% en-index.md
✓✓✓ dns-generator.md

Example of verbose result:

80% fr-index.md
    - og:image is missing
    - language is empy
90% en-index.md
    - og:site_name is empty
✓✓✓ dns-generator.md
@ClmntBcqt
Copy link
Contributor

Merged in #36

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