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

Myst compat #509

Closed
wants to merge 4 commits into from
Closed

Myst compat #509

wants to merge 4 commits into from

Conversation

stevepiercy
Copy link
Contributor

This PR provides MyST compatibility and cleans up English grammar, syntax, and spelling for the Mastering Plone training only. I did not do any other trainings, as this is for a POC. See also #508, #507, and #506.

spereverde and others added 3 commits July 8, 2021 21:15
Copy link
Member

@spereverde spereverde left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tested it locally, LGTM

@stevepiercy
Copy link
Contributor Author

Excellent. I'd like @pbauer and @ksuess to also test and review.

I still have to share the workflow I used to create this PR. I'll share during our sprint tomorrow.

@pbauer
Copy link
Member

pbauer commented Aug 25, 2021

I tested it locally and converted transmogrifier as described in myst-parser.md and it worked great.

@stevepiercy
Copy link
Contributor Author

DO NOT MERGE! I want to discuss how to migrate all the trainings, not just this one.

@ksuess
Copy link
Member

ksuess commented Aug 25, 2021

Sorry for responding so late.
The converted mastering chapters already look great. Special elements could be fixed manually. I would volonteer.
I converted locally the /voltoaddons training. Also fine; just the glossary needs some manual fix, as the directive 'glossary' seems to be not available.

That's what I checked:

  • code block, line numbers
  • collapsed blocks
  • footnote
  • highlighted blocks (note, see also,..)
  • strange conversion, but OK: images. see
    /mastering-plone-myst/volto_addon.html
:::{figure} _static/volto-columns-block.png
:alt: The eea volto-columns-block package gives you a block with columns. Each column
:  is its own separate blocks container.
:::

@ksuess ksuess marked this pull request as draft August 25, 2021 14:25
@ksuess
Copy link
Member

ksuess commented Aug 25, 2021

I wonder if it would be easier to document what's going on, if we separate four pull requests for:

@stevepiercy
Copy link
Contributor Author

Aim to complete the following PRs by Thu, Sep 2, 7pm CEST/10am Pacific, when we next meet.

  1. Agree upon the process to convert all trainings from reST to MyST. @stevepiercy
  2. Convert all the files per the process. @stevepiercy
  3. Technical corrections. @spereverde @ksuess
  4. English language fixes, grammar, spelling. @stevepiercy
  5. Apply sphinxbook theme. @spereverde @ksuess
  6. Merge all individual trainings' conf.pys and glossary into a single conf.py and glossary at the root level. @stevepiercy

@stevepiercy
Copy link
Contributor Author

stevepiercy commented Aug 26, 2021

I converted locally the /voltoaddons training. Also fine; just the glossary needs some manual fix, as the directive 'glossary' seems to be not available.

Try:

:term:`myterm`

I think the original should move the alt text into the caption.

.. figure:: _static/volto-columns-block.png
    :alt: Default layout options for eea.volto-columns-block

    The `eea.volto-columns-block` package gives you a block with columns.
    Each column is its own separate blocks container.

There was a somewhat related issue that was resolved. It would be good to file a report.

@stevepiercy
Copy link
Contributor Author

This PR is superseded by PR #511.

One commit 869c3e7 is useful when updating the source .rst files. It should be cherry picked into a separate PR, either one that is part of the rst2myst conversion or before that process begins. I would vote for the latter to keep the steps distinct.

@ksuess
Copy link
Member

ksuess commented Sep 2, 2021

This PR is superseded by PR #511.

One commit 869c3e7 is useful when updating the source .rst files. It should be cherry picked into a separate PR, either one that is part of the rst2myst conversion or before that process begins. I would vote for the latter to keep the steps distinct.

hi @stevepiercy, this is superseeded, as you mentioned. Would you update your thoughts about this in "relaunch" milestone, tahnks.

@ksuess ksuess removed this from the Relaunch milestone Sep 2, 2021
@stevepiercy
Copy link
Contributor Author

Closing in favor of #511,

@stevepiercy stevepiercy closed this Sep 2, 2021
@ksuess ksuess deleted the myst-compat branch September 10, 2021 16:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants