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

html_meta and substitutions topmatter keys deprecated, moved under myst key #1263

Closed
6 of 7 tasks
stevepiercy opened this issue Jun 23, 2022 · 0 comments
Closed
6 of 7 tasks

html_meta and substitutions topmatter keys deprecated, moved under myst key #1263

stevepiercy opened this issue Jun 23, 2022 · 0 comments
Assignees
@stevepiercy
Labels
99 tag: Plone 6.x
Milestone
Plone 6.0

Comments

@stevepiercy
Copy link
Contributor

stevepiercy commented Jun 23, 2022 •
edited
Loading

Plone Documentation versions affected

  • 5.x
  • 6.x

Description

The release of myst-parser 0.18.0 on 2022-06-07 introduced a breaking change. From https://myst-parser.readthedocs.io/en/latest/develop/_changelog.html#breaking-changes

The top-level html_meta and substitutions top-matter keys have also been deprecated (i.e. they will still work but will emit a warning), as they now form part of the myst config, e.g.

html_meta:
  "description lang=en": "metadata description"
substitutions:
  key1: I'm a **substitution**

is replaced by:

myst:
  html_meta:
    "description lang=en": "metadata description"
  substitutions:
    key1: I'm a **substitution**

This will need to be pushed out to all other repos that are imported by this one, as well as training.

  • documentation
  • plone.api
  • plone.restapi
  • volto
  • training

Related issues:
@stevepiercy stevepiercy added this to the Plone 6.0 milestone Jun 23, 2022
@stevepiercy stevepiercy moved this from New to Todo in Release Plone 6 docs Jun 23, 2022
@stevepiercy stevepiercy self-assigned this Sep 5, 2022
@stevepiercy stevepiercy moved this from Todo to In Progress in Release Plone 6 docs Sep 5, 2022
stevepiercy added a commit to plone/plone.restapi that referenced this issue Sep 5, 2022
@stevepiercy
Update topmatter keys to reside under myst key.
740bea4 
Closes plone/documentation#1263
stevepiercy added a commit to plone/plone.api that referenced this issue Sep 5, 2022
@stevepiercy
Update topmatter keys to reside under myst key.
19b3d04 
Closes plone/documentation#1263
stevepiercy added a commit that referenced this issue Sep 5, 2022
@stevepiercy
Update topmatter keys to reside under myst key.
834e395 
Closes #1263
This was referenced Sep 5, 2022
Merged
Merged
Merged
Merged
stevepiercy added a commit to plone/training that referenced this issue Sep 5, 2022
@stevepiercy
Insert topmatter key myst.
e214f73 
See plone/documentation#1263
@stevepiercy stevepiercy mentioned this issue Sep 5, 2022
Merged
Repository owner moved this from In Progress to Done in Release Plone 6 docs Sep 5, 2022
ksuess added a commit that referenced this issue Sep 5, 2022
@ksuess
Merge pull request #1293 from plone/1263-topmatter-to-myst-keys
259a32b 
Fix #1263 topmatter to myst keys
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@stevepiercy stevepiercy

Labels
99 tag: Plone 6.x
Projects
Release Plone 6 docs
Status: Done
Milestone
Plone 6.0
Development

No branches or pull requests
1 participant
@stevepiercy