Skip to content

Conversation

@obulat
Copy link
Contributor

@obulat obulat commented Dec 9, 2020

Fixes

Fixes #216 by @panchovm
Fixes #226 by @obulat
Fixes #209 by @panchovm

Description

This PR moves the Help section to the end of the left column to match v2 mockups.

Technical details

This PR is using Vue Vocabulary AppModal component to open Help links in the modals.
Using the Vocabulary component also solves the problem of page jumping up whenever the help link has been clicked.
One point that still needs addressing, probably in the Vocabulary component, is the fact that the body can still be scrolled when a modal is open.

This PR also adds markdown-it package for writing the longer Modal texts in markdown instead of html/plain text. This approach has two advantages:

  1. The logic of i18n interpolation becomes more complicated with links and images inside the texts, which is especially problematic for translators. With the previous approach, the translators would get a broken-up string like:
'text': 'Read more about the license at {link}',
'link': 'The Creative Commons site'

With markdown, it becomes:

'text': 'Read more about the licenses at [The Creative Commons site](www.creativecommons.org...)

So, the whole sentence is in one place, instead of being broken up into chunks.

  1. We can stop using raw HTML with v-html directive, which might be dangerous with the user-provided text (or translator-provided).

Screenshots

Help Section:

image

Modal open:

image

Checklist

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the default branch of the repository (main or master).
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no
    visible errors.

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@obulat obulat requested a review from a team as a code owner December 9, 2020 06:59
@obulat obulat requested review from akmadian and removed request for a team December 9, 2020 06:59
# Conflicts:
#	src/components/Stepper.vue
#	tests/unit/specs/components/__snapshots__/Stepper.spec.js.snap
},
data: () => ({
sixLicensesImg: '',
modals: {
Copy link
Member

Choose a reason for hiding this comment

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

Better to use an Array when keys are sequential integers?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The reason I didn't want to use an Array, I think, was I wanted the keys to start at 1, not at 0. With an array, I can't check if the modal is open with if modals[openModal], because when the open modal is at index 0, this returns false. I've solved it by checking if openModal !== null instead, and now it looks much cleaner, I think.

Copy link
Member

Choose a reason for hiding this comment

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

You can always create an Array with n+1 elements and leave the index 0 empty.

@obulat obulat merged commit 63823e8 into creativecommons:master Dec 15, 2020
@obulat obulat deleted the help_modals branch January 19, 2021 07:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Use Vocabulary AppModal component Move the FAQ to the end of left section Modals load on top of the page

2 participants