add info dialog #646
add info dialog #646
Conversation
|
Once the build has completed, you can preview your PR at this URL: https://cffinit.netlify.app/PR646/ |
|
Once the build has completed, you can preview your PR at this URL: https://cffinit.netlify.app/PR646/ |
|
Once the build has completed, you can preview your PR at this URL: https://cffinit.netlify.app/PR646/ |
|
Once the build has completed, you can preview your PR at this URL: https://cffinit.netlify.app/PR646/ |
|
Once the build has completed, you can preview your PR at this URL: https://cffinit.netlify.app/PR646/ |
|
Once the build has completed, you can preview your PR at this URL: https://cffinit.netlify.app/PR646/ |
abelsiqueira
left a comment
abelsiqueira
left a comment
There was a problem hiding this comment.
Thanks for the PR. I made some suggestions which I think are relevant for future PRs and will be harder to change later. They are:
- I think examples should be optional
data.titleshould be uppercase (Type,Related Resources), etc.
Either way, I think this is good to go.
| } | ||
| const helpData = { | ||
| type: { | ||
| title: 'type', |
There was a problem hiding this comment.
| title: 'type', | |
| title: 'Type', |
There was a problem hiding this comment.
repository-artifact field
Artifact Repository
CFF Field: repository-artifact
| ] | ||
| }, | ||
| message: { | ||
| title: 'message', |
There was a problem hiding this comment.
| title: 'message', | |
| title: 'Message', |
src/components/ScreenStart.vue
Outdated
| ] | ||
| }, | ||
| title: { | ||
| title: 'title', |
There was a problem hiding this comment.
| title: 'title', | |
| title: 'Title', |
src/css/app.css
Outdated
| #help-dialog { | ||
| background-color: var(--fgcolor, lightslategray); | ||
| } | ||
|
|
There was a problem hiding this comment.
I would put these scoped in the component.
src/components/InfoDialog.vue
Outdated
| <q-card-section> | ||
| {{ data.description }} | ||
| </q-card-section> | ||
| <q-card-section> |
There was a problem hiding this comment.
| <q-card-section> | |
| <q-card-section v-if="data.examples"> |
I would make this optional since sometimes there are no examples (radio for types, for instance).
src/components/ScreenStart.vue
Outdated
| description: 'The type of the work that is being described by this CITATION.cff file.', | ||
| examples: [ | ||
| 'software', | ||
| 'dataset' | ||
| ] |
There was a problem hiding this comment.
| description: 'The type of the work that is being described by this CITATION.cff file.', | |
| examples: [ | |
| 'software', | |
| 'dataset' | |
| ] | |
| description: 'The type of the work that is being described by this CITATION.cff file.' |
If we make examples optional.
src/components/InfoDialog.vue
Outdated
| }, | ||
| data: { | ||
| type: Object, | ||
| required: false, |
There was a problem hiding this comment.
| required: false, | |
| required: true, |
| } | ||
| const helpData = { | ||
| type: { | ||
| title: 'type', |
There was a problem hiding this comment.
repository-artifact field
Artifact Repository
CFF Field: repository-artifact
abelsiqueira
left a comment
abelsiqueira
left a comment
There was a problem hiding this comment.
I'm gonna have another look later
|
Once the build has completed, you can preview your PR at this URL: https://cffinit.netlify.app/PR646/ |
|
Once the build has completed, you can preview your PR at this URL: https://cffinit.netlify.app/PR646/ |
abelsiqueira
left a comment
abelsiqueira
left a comment
There was a problem hiding this comment.
Looks great, thanks for the updates.
Pull request details
Adds a dialog to the start screen which shows description, examples, and documentation link for a field.
List of related issues or pull requests
Refs:
Describe the changes made in this pull request
Instructions to review the pull request