microsoft / microsoft/asclepius

Missing steps in Readme.md

Open
#24 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Jupyter Notebook
Stars
9
Forks
8
PR merge metrics
No merged PRs in 30d

Description

Describe the issue:
When running the azd up command, the console will prompt to enter the values ​​of aoaiApiKey and aoaiEndpointUrl(as shown below). It need to create Azure OpenAI in advance.
image

Suggestion:
In Readme.md, before running azd up, add steps to create Azure OpenAI.

@pjirsa, @cajetzer and @jongio for notification.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Update Readme.md before the azd up instructions. Start by reviewing the existing setup steps and determine what Azure OpenAI resource and values for aoaiApiKey and aoaiEndpointUrl must be prepared; done means a reader can create the prerequisite and run azd up without unexpected prompts.

Written by the indexing model from the issue text.

Assessment

Tech stack
azure
Domain
cloud, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.