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

Update markdown parser config to fix issue with broken line breaks handling in resource descriptions #7613

Merged
merged 1 commit into from
Oct 27, 2020

Conversation

kollivier
Copy link
Contributor

Summary

Although we have a markdown parser rendering descriptions, it turns out when we use the 'zero' parser it disables the break handling we are using it for resulting in descriptions not being able to be multi-line.

This PR fixes that by using the default markdown parser. This does have the side-effect of rendering more markdown syntax. I think this is okay if we treat it as an undocumented feature, and use it sparingly until we have some strong evidence that a majority of users are on 0.15 or above.

Reviewer guidance

Ping me if you want a channel to test this with, basically testing with any description containing line breaks will show the issue.

References


Contributor Checklist

PR process:

  • PR has the correct target branch and milestone
  • PR has 'needs review' or 'work-in-progress' label
  • If PR is ready for review, a reviewer has been added. (Don't use 'Assignees')
  • If this is an important user-facing change, PR or related issue has a 'changelog' label
  • If this includes an internal dependency change, a link to the diff is provided

Testing:

  • Contributor has fully tested the PR manually
  • If there are any front-end changes, before/after screenshots are included
  • Critical user journeys are covered by Gherkin stories
  • Critical and brittle code paths are covered by unit tests

Reviewer Checklist

  • Automated test coverage is satisfactory
  • PR is fully functional
  • PR has been tested for accessibility regressions
  • External dependency files were updated if necessary (yarn and pip)
  • Documentation is updated
  • Contributor is in AUTHORS.md

…wn content, by using the default markdown parser.
@kollivier kollivier self-assigned this Oct 23, 2020
@kollivier kollivier added the TODO: needs review Waiting for review label Oct 23, 2020
@kollivier kollivier added this to the 0.14.4 milestone Oct 23, 2020
@codecov
Copy link

codecov bot commented Oct 24, 2020

Codecov Report

Merging #7613 into release-v0.14.x will decrease coverage by 0.00%.
The diff coverage is 0.00%.

Impacted Files Coverage Δ
...bri/plugins/learn/assets/src/views/ContentPage.vue 16.49% <0.00%> (ø)
kolibri/core/content/utils/check_schema_db.py 91.30% <0.00%> (-8.70%) ⬇️
.../core/deviceadmin/management/commands/dbrestore.py 76.56% <0.00%> (ø)

@jonboiser jonboiser added changelog Important user-facing changes and removed TODO: needs review Waiting for review labels Oct 27, 2020
@jonboiser jonboiser changed the title Fix issue with broken linebreak handling in descriptions Update markdown parser config to fix issue with broken line breaks handling in resource descriptions Oct 27, 2020
@jonboiser jonboiser merged commit 3abc1b2 into learningequality:release-v0.14.x Oct 27, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog Important user-facing changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants