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

[Feature] Add Links to JSON Schema in Import Dialog #2159

Open
1 of 5 tasks
lightyoruichi opened this issue Jan 15, 2025 · 0 comments
Open
1 of 5 tasks

[Feature] Add Links to JSON Schema in Import Dialog #2159

lightyoruichi opened this issue Jan 15, 2025 · 0 comments
Assignees
Labels
enhancement New feature or request needs triage Issues that need to be triaged v4 Issues related to the latest version

Comments

@lightyoruichi
Copy link

Is there an existing issue for this feature?

  • Yes, I have searched the existing issues and it doesn't exist.

Feature Description

Description
As a user, when I select .json files as the file type in the Import Dialog, I would like to see clickable links to the JSON schema documentation. This would allow me to reference the correct file format with both the official schema on GitHub and the user-friendly presentation on [jsonresume.org](https://jsonresume.org/schema).

Proposed Solution
Update the helper text for the .json file type to include two clickable links:

  1. GitHub: https://github.com/jsonresume/resume-schema/blob/master/schema.json
    For users who need direct access to the schema file.
  2. JsonResume.org: https://jsonresume.org/schema
    For users who prefer a user-friendly overview of the schema.

Ensure both links are styled for accessibility (e.g., target="_blank" and rel="noopener noreferrer") and clearly indicate their purpose.

Acceptance Criteria

  • The helper text for .json files includes both hyperlinks (GitHub and JsonResume.org).
  • Links open in a new browser tab.
  • Text clearly identifies each link for its intended audience (e.g., "GitHub schema" and "JsonResume.org schema").
  • Feature is tested for accessibility and functionality.

Example Text for Helper Message

Accepts only .json files. See the schema documentation:

Additional Context
Providing both links ensures users have flexibility to choose between a developer-centric view (GitHub) and a more accessible overview (JsonResume.org). This reduces confusion and errors during the import process while improving overall usability.

@lightyoruichi lightyoruichi added enhancement New feature or request needs triage Issues that need to be triaged v4 Issues related to the latest version labels Jan 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request needs triage Issues that need to be triaged v4 Issues related to the latest version
Projects
None yet
Development

No branches or pull requests

2 participants