plone / volto

React-based frontend for the Plone Content Management System
https://demo.plone.org/
MIT License
448 stars 610 forks source link

Docs need meta_html values #3033

Closed stevepiercy closed 2 years ago

stevepiercy commented 2 years ago

On plone6-docs branch, the html_meta values are missing from every page. These values are used to improve SEO. Omitting them results in errors when building the docs with Sphinx.

Note that the values for description and property=og:description should be identical.

html_meta:
  "description": ""
  "property=og:description": ""
  "property=og:title": ""
  "keywords": ""
ktsrivastava29 commented 2 years ago

@stevepiercy I think I can work on this issue, may I? Should I create a new branch for this or should I start pushing on the updates in the docs-lang branch itself?

stevepiercy commented 2 years ago

Yes, please!

See instructions:

https://6-dev-docs.plone.org/contributing/index.html#editing-external-package-documentation

For this task, please use the following as a base for keywords, adding to it as needed for each page.

  "keywords": "Volto, Plone, frontend, React"

Thank you!

ktsrivastava29 commented 2 years ago

@stevepiercy as the plone/documentation is a separate repository, should I create a pull request in that repository after making the modifications?

stevepiercy commented 2 years ago

No. These changes should be made in the volto project only. The main documentation repository imports volto and plone.restapi repositories.