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

Add known caveats/issues section to readme #48

Merged
merged 1 commit into from
Nov 22, 2019
Merged

Conversation

jeffpaul
Copy link
Member

@jeffpaul jeffpaul commented Nov 21, 2019

Description of the Change

This adds a "Known Caveats/Issues" section to the README.md and includes details about differences between a Gutenberg export and a Classic Editor export.

Alternate Designs

none

Benefits

Ensures Eight Day Week consumers are aware of potential differences in using Gutenberg versus Classic Editor for their print production workflows.

Possible Drawbacks

none identified

Verification Process

Manually verified via the GitHub web UI.

Checklist:

  • I have read the CONTRIBUTING document.
  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my change.
  • All new and existing tests passed.

Applicable Issues

Relates to #43, #47.

@jeffpaul jeffpaul added the needs:documentation This requires documentation. label Nov 21, 2019
@jeffpaul jeffpaul added this to the 1.1.1 milestone Nov 21, 2019
@jeffpaul jeffpaul self-assigned this Nov 21, 2019
@jeffpaul jeffpaul requested a review from helen November 22, 2019 04:05
@jeffpaul jeffpaul merged commit 61488d5 into develop Nov 22, 2019
@jeffpaul jeffpaul deleted the add/known-caveats branch September 30, 2020 01:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs:documentation This requires documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants