nephila / djangocms-page-meta

OpenGraph, Twitter Card and Google+ snippet tags for django CMS 3 pages
https://djangocms-page-meta.readthedocs.io/
BSD 3-Clause "New" or "Revised" License
60 stars 64 forks source link

Update Docs to Avoid Confusion About Usage of App #121

Open wesleyboar opened 4 years ago

wesleyboar commented 4 years ago

Description

A user (that is new to interoperability of djangocms apps) is likely to encounter some issues when following the documentation:

  1. Be unaware how to set "page meta" (#86, #66).
  2. Be unaware how to render "page meta" ("6. That's all!" without mentioning "Usage").
  3. Be unclear of the distinction between "meta"s (comment on djangocms-blog #550):
    • "page meta" (django-page-meta)
    • "blog article meta" (djangocms-blog using django-meta).
  4. Add both of, or be unsure what to do about, the two "render meta stuff" template markups (one from django-meta and one from djangocms-page-meta (comment on #86).

Proposal

Ideas

wesleyboar commented 4 years ago

I've created this issue with the intent for me to learn a little .rst and update the documentation. Expect a PR.