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

Wetu Importer - Simplify API Key Configuration for Wetu Importer #156

Open
ashleyshaw opened this issue Oct 9, 2024 · 0 comments
Open
Labels
[Status] Needs Figma Update Needs an update to Figma for design purposes [Type] Discussion For issues that are high-level and not yet ready to implement. [Type] Enhancement A suggestion for improvement

Comments

@ashleyshaw
Copy link
Member

ashleyshaw commented Oct 9, 2024

Wetu Importer - Simplify API Key Configuration - Feature Request

Overview

The current process for setting up the API key for the Wetu Importer can be confusing and overwhelming, especially for new users. The manual process increases the likelihood of user errors, slowing down the onboarding experience.

Problem

  • The API key configuration process for the Wetu Importer lacks guidance, leading to confusion for users who are unfamiliar with setting up APIs.
  • New users are more likely to make mistakes during setup, which can prevent successful integration and data imports.

Proposed Solution

  • Step-by-Step Wizard: Implement an interactive step-by-step wizard that guides users through the API key configuration process.

    • Step 1: Explain what the API key is and why it’s needed.
    • Step 2: Provide a direct link or instructions to obtain the API key from Wetu.
    • Step 3: Create a field to input the API key, with real-time validation to ensure the key format is correct.
    • Step 4: Add a final confirmation screen to verify the API key has been successfully saved.

    Example:

    • Success Message: "API key successfully saved! You're now ready to sync data from Wetu."

Alternatives Considered

  • Extensive Documentation: While detailed documentation is helpful, it’s not as intuitive as a wizard. A step-by-step wizard ensures users stay on track and avoid mistakes without needing to reference external guides.

Benefits

  • Improved User Experience: Simplifying the setup process will reduce user frustration and speed up the onboarding process.
  • Fewer Errors: An interactive wizard with real-time validation will minimize incorrect API key entries and other setup mistakes.
  • Reduced Support Requests: With a simpler setup, users are less likely to run into issues, reducing the number of support tickets related to API key configuration.

Additional Context

By creating a more user-friendly API key configuration process, we can streamline the Wetu Importer setup, making it accessible to a broader range of users—especially those with limited technical knowledge.

@ashleyshaw ashleyshaw added [Type] Enhancement A suggestion for improvement [Status] Needs Figma Update Needs an update to Figma for design purposes [Type] Discussion For issues that are high-level and not yet ready to implement. labels Oct 9, 2024
@ashleyshaw ashleyshaw modified the milestone: 2.1.0 Oct 9, 2024
@ashleyshaw ashleyshaw changed the title Simplify API Key Configuration for Wetu Importer Wetu Importer - Simplify API Key Configuration for Wetu Importer Oct 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Status] Needs Figma Update Needs an update to Figma for design purposes [Type] Discussion For issues that are high-level and not yet ready to implement. [Type] Enhancement A suggestion for improvement
Projects
Status: Needs Testing
Development

No branches or pull requests

1 participant