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

Step-by-Step Visual Guides for Enabling Azure Hybrid Benefit #265

Open
Mustafa-Hassan2001 opened this issue May 30, 2024 · 1 comment
Open
Labels
enhancement New feature or request

Comments

@Mustafa-Hassan2001
Copy link

Mustafa-Hassan2001 commented May 30, 2024

Is your feature requested related to a problem?

Bug on: Azure Hybrid Benefit - Azure SQL Database & SQL Managed Instance

The current documentation for enabling the Azure Hybrid Benefit (AHB) for Azure SQL Database and SQL Managed Instance is text-heavy and lacks visual aids. This can lead to several issues for users. 1) Complexity and Confusion 2) Increased Error Rate 3) Time Consumption

Describe the solution you'd like.

Implementing step-by-step visual guides or video tutorials within the documentation can address these issues. Each guide will provide a clear, visual walkthrough of the process for enabling Azure Hybrid Benefit via different methods: the Azure portal, PowerShell, Azure CLI, and REST API. The guides will include:

  1. Screenshots and Descriptions: Each step will be accompanied by screenshots with concise text descriptions.
  2. Video Tutorials: Short video clips demonstrating the process in real time.
  3. Interactive Elements: Where possible, include interactive elements or clickable areas on screenshots to enhance user engagement.

Details for Each Method:

  1. Azure Portal:
  • Screenshots: Show the exact navigation path in the Azure portal.
  • Video: A short video demonstrating the entire process.
  • Interactive Guide: Clickable steps within screenshots to show detailed instructions.
  1. PowerShell:
  • Screenshots: Show the PowerShell commands and their expected output.
  • Video: A video showing how to execute the commands in PowerShell.
  • Interactive Command Builder: An interactive tool to help users build their PowerShell commands.
  1. Azure CLI:
  • Screenshots: Display the command line interface with the necessary commands.
  • Video: A video demonstrating the commands being executed.
  • Interactive CLI Guide: An interactive guide to assist with command syntax.
  1. REST API:
  • Screenshots: Show the API requests in a REST client like Postman.
  • Video: A video tutorial on setting up and sending API requests.
  • Interactive API Explorer: An interactive explorer to help users understand API endpoints and payloads.

Additional context

  • Importance:

User Onboarding: Helps new users get started with Azure Hybrid Benefit more smoothly.
Efficiency: Saves time for users by providing clear and quick references.
Error Reduction: Minimizes the chances of configuration errors by providing visual confirmation.

  • Implementation Considerations:

Maintenance: Regular updates to visual guides and videos will be necessary to keep up with changes in the Azure interface and command syntax.
Localization: Consider creating localized versions of the guides for non-English speaking users.
Accessibility: Ensure that visual guides and videos are accessible, including captions for videos and alt text for images.

  • User Feedback:
    Collect user feedback on the effectiveness of the visual guides and videos to continually improve the content.

What is your current role?

None

What technical topic is this feature related to?

No response

Relevant log output

No response

@Student @StudentAmbassador

@Mustafa-Hassan2001 Mustafa-Hassan2001 added the enhancement New feature or request label May 30, 2024
Copy link

Thank you for submitting this issue! The team will review your issue, tag with the appropriate tags, and comment with any additional questions on information needed. ✨

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant