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.

Sign up for GitHub

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

Jump to bottom

Update Docs to Avoid Confusion About Usage of App #121

Open
wesleyboar opened this issue Jun 25, 2020 · 1 comment
Open

Update Docs to Avoid Confusion About Usage of App #121

wesleyboar opened this issue Jun 25, 2020 · 1 comment
Labels
type: documentation

Comments

@wesleyboar
Copy link
Contributor

wesleyboar commented Jun 25, 2020 •
edited
Loading

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" (Page -> Meta-information options aren't selectable (greyed out) #86, Can't find option to add metatags on a per page basis #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

  • In the the readme, between the current (as of this issue's creation date) step 5 and step 6 of "Quickstart", add a step that mentions and links to "Usage".
  • In the usage doc, add mention, for indirect users of django-meta (perhaps via djangocms-blog), that they need not have both of these lines of markup:
    • {% include 'djangocms_page_meta/meta.html' with meta=page_meta %}
    • {% include "meta/meta.html" %}
      Only the top one is necessary.
  • In djangocms-blog docs (via a separate, unwritten, issue), add mention of djangocms-page-meta and describe its purpose and distinction from and relation to django-meta, in the context of djangocms-blog usage.
    • Also, possibly, note that <head {% meta_namespaces %}> is still necessary for djangocms-blog usage of django-meta

Ideas

  • Google+ is dead. Remove the documentation about it (and create an issue to remove the code)?
@wesleyboar
Copy link
Contributor Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
type: documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@yakky @wesleyboar