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.

Sign up for GitHub

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

Jump to bottom

Docs: Update user quick-start readme and fix scripts #71

Closed
wants to merge 12 commits into from
Closed

Docs: Update user quick-start readme and fix scripts #71

wants to merge 12 commits into from

Conversation

momuno
Copy link
Member

@momuno momuno commented Jul 31, 2023 •
edited
Loading

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 the documentation Improvements or additions to documentation label Jul 31, 2023
@momuno momuno changed the title Initial commit Docs: Update user quick-start readme and fix scripts for OpenAI Jul 31, 2023
@momuno momuno changed the title Docs: Update user quick-start readme and fix scripts for OpenAI Docs: Update user quick-start readme and fix scripts Jul 31, 2023
glahaye
glahaye reviewed Jul 31, 2023
View reviewed changes
README.md Outdated Show resolved Hide resolved
@momuno
Copy link
Member Author

momuno commented Aug 1, 2023 •
edited
Loading

OpenAI and Azure OpenAI with Windows tested. Works.

Update README for homebrew and chmod, add brew script, fix configure …
53ff872 
…script, remove unised config ps script in webapi/
@github-actions github-actions bot added the webapi Pull requests that update .net code label Aug 2, 2023
@momuno
Copy link
Member Author

momuno commented Aug 2, 2023

testing on linux and macos

@momuno momuno marked this pull request as ready for review August 2, 2023 18:05
@momuno momuno mentioned this pull request Aug 2, 2023
Merged
4 tasks
@momuno momuno closed this Aug 2, 2023
@momuno momuno reopened this Aug 2, 2023
@momuno
Copy link
Member Author

momuno commented Aug 2, 2023

closed in favor of PR #94

@momuno momuno closed this Aug 2, 2023
@momuno momuno deleted the momuno/fix-local-deploy-scripts-readme branch August 2, 2023 19:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@glahaye glahaye glahaye left review comments

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation webapi Pull requests that update .net code
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@momuno @glahaye