Skip to content

Commit

Permalink
readme, support and copyrighht
Browse files Browse the repository at this point in the history
  • Loading branch information
cmendible committed Oct 10, 2023
1 parent 247e2c0 commit 8792155
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 28 deletions.
10 changes: 3 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,10 @@
# Activate GenAI with Azure

> This repo has been populated by an initial template to help get you started. Please
> make sure to update the content to build a great experience for community-building.
This delivery guide will help you build a ChatGPT-like experiences over your Enterprise data using the Retrieval Augmented Generation pattern.

As the maintainer of this project, please make a few updates:
Under the hood the solution uses Azure OpenAI Service to access the ChatGPT model (gpt-35-turbo), and Azure Cognitive Search for data indexing and retrieval.

- Improving this README.MD file to provide a great experience
- Updating SUPPORT.MD with content about this project's support experience
- Understanding the security reporting process in SECURITY.MD
- Remove this section from the README
For more information check **[Activate GenAI with Azure](https://azure.github.io/activate-genai)**.

## Contributing

Expand Down
26 changes: 6 additions & 20 deletions SUPPORT.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,11 @@
# TODO: The maintainer of this repo has not yet edited this file

**REPO OWNER**: Do you want Customer Service & Support (CSS) support for this product/project?

- **No CSS support:** Fill out this template with information about how to file issues and get help.
- **Yes CSS support:** Fill out an intake form at [aka.ms/onboardsupport](https://aka.ms/onboardsupport). CSS will work with/help you to determine next steps.
- **Not sure?** Fill out an intake as though the answer were "Yes". CSS will help you decide.

*Then remove this first heading from this SUPPORT.MD file before publishing your repo.*

# Support

## How to file issues and get help

This project uses GitHub Issues to track bugs and feature requests. Please search the existing
issues before filing new issues to avoid duplicates. For new issues, file your bug or
feature request as a new Issue.
This project uses GitHub Issues to track bugs and feature requests.
Before logging an issue please check our [troubleshooting](#troubleshooting) guide.

For help and questions about using this project, please **REPO MAINTAINER: INSERT INSTRUCTIONS HERE
FOR HOW TO ENGAGE REPO OWNERS OR COMMUNITY FOR HELP. COULD BE A STACK OVERFLOW TAG OR OTHER
CHANNEL. WHERE WILL YOU HELP PEOPLE?**.
Please search the existing issues before filing new issues to avoid duplicates.

## Microsoft Support Policy
- For new issues, file your bug or feature request as a new [issue](https://github.com/Azure/activate-genai/issues).
- For help, discussion, and support questions about using this project, join or start a [discussion](https://github.com/Azure/activate-genai/discussions).

Support for this **PROJECT or PRODUCT** is limited to the resources listed above.
Support for this project / product is limited to the resources listed above.
2 changes: 1 addition & 1 deletion docs/hugo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ description = "Activate GenAI with Azure"
section = ["HTML", "print", "RSS"]

[params]
copyright = "The Activate GenAI with Azure"
copyright = "Microsoft Corporation"
# privacy_policy = "https://github.com/azure/activate-genai/SECURITY.md"

# First one is picked as the Twitter card image if not set on page.
Expand Down

0 comments on commit 8792155

Please sign in to comment.