Create SchemaGuideLink with an icon that points to the schema guide#441
Merged
abelsiqueira merged 4 commits intomainfrom May 11, 2022
Merged
Create SchemaGuideLink with an icon that points to the schema guide#441abelsiqueira merged 4 commits intomainfrom
abelsiqueira merged 4 commits intomainfrom
Conversation
jspaaks
reviewed
May 10, 2022
| @@ -0,0 +1,25 @@ | |||
| <template> | |||
| <a v-bind:href="'https://github.com/citation-file-format/citation-file-format/blob/main/schema-guide.md#' + section"> | |||
Member
There was a problem hiding this comment.
Suggested change
| <a v-bind:href="'https://github.com/citation-file-format/citation-file-format/blob/main/schema-guide.md#' + section"> | |
| <a v-bind:href="'https://github.com/citation-file-format/citation-file-format/blob/1.2.0/schema-guide.md' + anchor"> |
- main -> 1.2.0 for more predictable results
- changed
sectiontoanchor, I believe that's what that is called (needs verification). Also I moved the#to be part of what components use, this makes it easier to recognize how that piece of data is used in my opinion
jspaaks
reviewed
May 10, 2022
| export default defineComponent({ | ||
| name: 'SchemaInfoIcon', | ||
| props: { | ||
| section: { |
Member
There was a problem hiding this comment.
Suggested change
| section: { | |
| anchor: { |
jspaaks
reviewed
May 10, 2022
| <div id="form-content"> | ||
| <p class="question"> | ||
| What is the abstract of the work? | ||
| <SchemaInfoIcon section="abstract" /> |
Member
There was a problem hiding this comment.
Suggested change
| <SchemaInfoIcon section="abstract" /> | |
| <SchemaInfoIcon anchor="#abstract" /> |
jspaaks
reviewed
May 10, 2022
| <div id="form-content"> | ||
| <p class="question"> | ||
| Who are the author(s) of the work? | ||
| <SchemaInfoIcon section="authors" /> |
Member
There was a problem hiding this comment.
Suggested change
| <SchemaInfoIcon section="authors" /> | |
| <SchemaInfoIcon anchor="#authors" /> |
jspaaks
reviewed
May 10, 2022
| > | ||
| schema guide | ||
| </a> for examples. | ||
| <SchemaInfoIcon section="identifiers" /> |
Member
There was a problem hiding this comment.
Suggested change
| <SchemaInfoIcon section="identifiers" /> | |
| <SchemaInfoIcon anchor="#identifiers" /> |
jspaaks
reviewed
May 10, 2022
| <div id="form-content"> | ||
| <p class="question"> | ||
| What keywords describe the work? | ||
| <SchemaInfoIcon section="keywords" /> |
Member
There was a problem hiding this comment.
Suggested change
| <SchemaInfoIcon section="keywords" /> | |
| <SchemaInfoIcon anchor="#keywords" /> |
jspaaks
reviewed
May 10, 2022
| <div id="form-content"> | ||
| <p class="question"> | ||
| What is the license of the work? | ||
| <SchemaInfoIcon section="license" /> |
Member
There was a problem hiding this comment.
Suggested change
| <SchemaInfoIcon section="license" /> | |
| <SchemaInfoIcon anchor="#license" /> |
jspaaks
reviewed
May 10, 2022
| <div id="form-content"> | ||
| <p class="question"> | ||
| What is the URL of the work in a source code repository? | ||
| <SchemaInfoIcon section="repository-code" /> |
Member
There was a problem hiding this comment.
Suggested change
| <SchemaInfoIcon section="repository-code" /> | |
| <SchemaInfoIcon anchor="#repository-code" /> |
jspaaks
reviewed
May 10, 2022
|
|
||
| <p class="question"> | ||
| What is the URL of a landing page/website for the work? | ||
| <SchemaInfoIcon section="url" /> |
Member
There was a problem hiding this comment.
Suggested change
| <SchemaInfoIcon section="url" /> | |
| <SchemaInfoIcon anchor="#url" /> |
jspaaks
reviewed
May 10, 2022
|
|
||
| <p class="question"> | ||
| What is the URL of the work in a repository? | ||
| <SchemaInfoIcon section="repository" /> |
Member
There was a problem hiding this comment.
Suggested change
| <SchemaInfoIcon section="repository" /> | |
| <SchemaInfoIcon anchor="#repository" /> |
jspaaks
reviewed
May 10, 2022
|
|
||
| <p class="question"> | ||
| What is the URL of the work in a build artifact/binary repository? | ||
| <SchemaInfoIcon section="repository-artifact" /> |
Member
There was a problem hiding this comment.
Suggested change
| <SchemaInfoIcon section="repository-artifact" /> | |
| <SchemaInfoIcon anchor="#repository-artifact" /> |
jspaaks
reviewed
May 10, 2022
| <div id="form-content"> | ||
| <p class="question"> | ||
| What is the title of the work? | ||
| <SchemaInfoIcon section="title" /> |
Member
There was a problem hiding this comment.
Suggested change
| <SchemaInfoIcon section="title" /> | |
| <SchemaInfoIcon anchor="#title" /> |
jspaaks
reviewed
May 10, 2022
| /> | ||
| <p class="question"> | ||
| What do you want citers to do with the information provided in your CITATION.cff file? | ||
| <SchemaInfoIcon section="message" /> |
Member
There was a problem hiding this comment.
Suggested change
| <SchemaInfoIcon section="message" /> | |
| <SchemaInfoIcon anchor="#message" /> |
jspaaks
reviewed
May 10, 2022
| </q-input> | ||
| <p class="question"> | ||
| What type of work does this CITATION.cff describe? | ||
| <SchemaInfoIcon section="type" /> |
Member
There was a problem hiding this comment.
Suggested change
| <SchemaInfoIcon section="type" /> | |
| <SchemaInfoIcon anchor="#type" /> |
jspaaks
reviewed
May 10, 2022
| <div id="form-content"> | ||
| <p class="question"> | ||
| What is the commit identifier of the work? | ||
| <SchemaInfoIcon section="commit" /> |
Member
There was a problem hiding this comment.
Suggested change
| <SchemaInfoIcon section="commit" /> | |
| <SchemaInfoIcon anchor="#commit" /> |
jspaaks
reviewed
May 10, 2022
|
|
||
| <p class="question"> | ||
| What is the version of the work? | ||
| <SchemaInfoIcon section="version" /> |
Member
There was a problem hiding this comment.
Suggested change
| <SchemaInfoIcon section="version" /> | |
| <SchemaInfoIcon anchor="#version" /> |
jspaaks
reviewed
May 10, 2022
|
|
||
| <p class="question"> | ||
| When was the version released? | ||
| <SchemaInfoIcon section="date-released" /> |
Member
There was a problem hiding this comment.
Suggested change
| <SchemaInfoIcon section="date-released" /> | |
| <SchemaInfoIcon anchor="#date-released" /> |
jspaaks
requested changes
May 10, 2022
Member
jspaaks
left a comment
jspaaks
left a comment
There was a problem hiding this comment.
Hi Abel, this is really nice thank you. I left some minor comments, what do you think? Also, how would you feel about changing the name of SchemaInfoIcon to SchemaGuideLink? For me that covers more of the role it has.
Collaborator
Author
|
Thanks for the review. I agree with the suggestions and I updated the PR with them. |
abelsiqueira
changed the title
jspaaks
reviewed
May 11, 2022
| </q-tooltip> | ||
| <q-tooltip | ||
| anchor="center left" | ||
| anchor="#center left" |
Member
There was a problem hiding this comment.
Suggested change
| anchor="#center left" | |
| anchor="center left" |
jspaaks
approved these changes
May 11, 2022
Member
jspaaks
left a comment
jspaaks
left a comment
There was a problem hiding this comment.
One minor suggestion to correct what seems like a find and replace error, otherwise good to go.
abelsiqueira
force-pushed
the
439-link-to-schema
branch
from
21f92a8 to
d543e27
Compare
Collaborator
Author
|
Nice catch. Thanks for the review |
This was referenced May 11, 2022
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Pull request details
Includes an i icon at each page question linking to the corresponding schema field
List of related issues or pull requests
Refs:
Describe the changes made in this pull request
Instructions to review the pull request