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

Update local deployment scripts and main readme for quickstart #94

Merged

Conversation

momuno
Copy link
Member

@momuno momuno commented Aug 2, 2023

Motivation and Context

  1. Why is this change required? To make onboarding smoother.
  2. What problem does it solve? The quick-start local deployment steps were difficult to follow.
  3. What scenario does it contribute to? Anyone trying out Chat Copilot locally for the first time.
  4. If it fixes an open issue, please link to the issue here. NA.

Description

Main Chat Copilot Readme is updated to present a quick-start beginner use case. This is the local deployment of Chat Copilot, not an Azure deployment. It removes the redirect for the scripts, and formats instructions to improve readability.

Bash and PowerShell scripts are also fixed to use environment variable ASPNETCORE_ENVIRONMENT, which is necessary for appsettings.json override (by appsettings.Development.json) when running the backend for OpenAI.

Contribution Checklist

@github-actions github-actions bot added documentation Improvements or additions to documentation webapi Pull requests that update .net code PR: ready for review labels Aug 2, 2023
@momuno
Copy link
Member Author

momuno commented Aug 2, 2023

replaces PR #71

Copy link
Member

@alliscode alliscode left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we use an updated screenshot of chat-copilot UI in the README? That one is missing a lot of the new goodness.

alliscode
alliscode previously approved these changes Aug 2, 2023
@alliscode alliscode added this pull request to the merge queue Aug 2, 2023
Merged via the queue into microsoft:main with commit c1fc7f5 Aug 2, 2023
8 checks passed
@momuno momuno deleted the momuno/update-readme-local-deploy-scripts branch August 4, 2023 21:04
teamleader-dev pushed a commit to vlink-group/chat-copilot that referenced this pull request Oct 7, 2024
…soft#94)

### Motivation and Context

  1. Why is this change required?  To make onboarding smoother.
2. What problem does it solve? The quick-start local deployment steps
were difficult to follow.
3. What scenario does it contribute to? Anyone trying out Chat Copilot
locally for the first time.
  4. If it fixes an open issue, please link to the issue here. NA.

### Description

Main Chat Copilot Readme is updated to present a quick-start beginner
use case. This is the local deployment of Chat Copilot, not an Azure
deployment. It removes the redirect for the scripts, and formats
instructions to improve readability.

Bash and PowerShell scripts are also fixed to use environment variable
`ASPNETCORE_ENVIRONMENT`, which is necessary for appsettings.json
override (by appsettings.Development.json) when running the backend for
OpenAI.

### Contribution Checklist

- [x] The code builds clean without any errors or warnings
- [x] The PR follows the [SK Contribution
Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
and the [pre-submission formatting
script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#development-scripts)
raises no violations
- [x] All unit tests pass, and I have added new tests where possible
- [x] I didn't break anyone 😄

---------

Co-authored-by: Mollie Munoz <[email protected]>
Co-authored-by: Gil LaHaye <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation webapi Pull requests that update .net code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants