Skip to content

Commit

Permalink
LICENSE committed
Browse files Browse the repository at this point in the history
  • Loading branch information
microsoftopensource authored and cmendible committed Oct 6, 2023
1 parent 6481329 commit b8e2530
Show file tree
Hide file tree
Showing 35 changed files with 773 additions and 8 deletions.
20 changes: 20 additions & 0 deletions .devcontainer/Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Find the Dockerfile at this URL
# https://github.com/Azure/azure-functions-docker/blob/dev/host/4/bullseye/amd64/dotnet/dotnet-inproc/dotnet-core-tools.Dockerfile
FROM mcr.microsoft.com/azure-functions/dotnet:4-dotnet6-core-tools

# Uncomment following lines If you want to enable Development Container Script
# For more details https://github.com/microsoft/vscode-dev-containers/tree/main/script-library

# Avoid warnings by switching to noninteractive
# ENV DEBIAN_FRONTEND=noninteractive

# # Comment out these lines if you want to use zsh.

# ARG INSTALL_ZSH=true
# ARG USERNAME=vscode
# ARG USER_UID=1000
# ARG USER_GID=$USER_UID

# RUN apt-get update && curl -ssL https://raw.githubusercontent.com/microsoft/vscode-dev-containers/main/script-library/common-debian.sh -o /tmp/common-script.sh \
# && /bin/bash /tmp/common-script.sh "$INSTALL_ZSH" "$USERNAME" "$USER_UID" "$USER_GID" \
# && rm /tmp/common-script.sh
54 changes: 54 additions & 0 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
{
"name": "Activate GenAI with Azure",
"dockerFile": "Dockerfile",
"forwardPorts": [
7071
],
// Configure tool-specific properties.
"customizations": {
// Configure properties specific to VS Code.
"vscode": {
// Add the IDs of extensions you want installed when the container is created.
"extensions": [
"ms-azuretools.vscode-azurecontainerapps",
"ms-azuretools.vscode-azurefunctions",
"ms-dotnettools.csharp",
"ms-dotnettools.csdevkit",
"k--kato.docomment",
"hashicorp.terraform",
"golang.go",
"ms-semantic-kernel.semantic-kernel",
]
}
},
// Use 'postCreateCommand' to run commands after the container is created.
// "postCreateCommand": "dotnet restore",
// Set `remoteUser` to `root` to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
"remoteUser": "vscode",
"features": {
"ghcr.io/devcontainers/features/azure-cli:1": {
"version": "latest"
},
"ghcr.io/devcontainers-contrib/features/terraform-ls-asdf:2": {
"version": "latest"
},
"ghcr.io/devcontainers/features/go:1": {
"version": "latest"
},
"ghcr.io/devcontainers/features/hugo:1": {
"extended": true,
"version": "latest"
},
"ghcr.io/devcontainers/features/node:1": {
"version": "lts",
"nvmVersion": "latest"
},
"ghcr.io/devcontainers/features/docker-in-docker:2": {
"moby": true,
"azureDnsAutoDetection": true,
"installDockerBuildx": true,
"version": "latest",
"dockerDashComposeVersion": "none"
}
}
}
85 changes: 85 additions & 0 deletions .github/workflows/gh-pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
name: github pages

on:
# Runs on pushes targeting the default branch
push:
branches: [main]

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow one concurrent deployment
concurrency:
group: "pages"
cancel-in-progress: true

# Default to bash
defaults:
run:
shell: bash

jobs:
# Build job
build:
runs-on: ubuntu-latest
env:
HUGO_VERSION: 0.119.0
steps:
- name: Checkout
uses: actions/checkout@v3
with:
submodules: recursive

- name: Setup Node
uses: actions/setup-node@v3
with:
node-version: '18'

- name: Cache dependencies
uses: actions/cache@v2
with:
path: ~/.npm
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
restore-keys: |
${{ runner.os }}-node-
- name: Install Hugo CLI
run: |
wget -O ${{ runner.temp }}/hugo.deb https://github.com/gohugoio/hugo/releases/download/v${HUGO_VERSION}/hugo_extended_${HUGO_VERSION}_linux-amd64.deb \
&& sudo dpkg -i ${{ runner.temp }}/hugo.deb
- name: Setup Pages
id: pages
uses: actions/configure-pages@v1

- name: Build with Hugo
run: |
npm install -D autoprefixer
npm install -D postcss-cli
npm install -D postcss
npm install
hugo --gc --minify --cleanDestinationDir --baseURL https://azure.github.io/activate-genai/
working-directory: ./docs

- name: Upload artifact
uses: actions/upload-pages-artifact@v1
with:
path: ./docs/public

# Deployment job
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v1
12 changes: 5 additions & 7 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
_site/
.sass-cache/
.jekyll-cache/
.jekyll-metadata
# Ignore folders generated by Bundler
.bundle/
vendor/
public/
resources/
node_modules/
package-lock.json
.hugo_build.lock
14 changes: 14 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Contributing

This project welcomes contributions and suggestions. Most contributions require you to
agree to a Contributor License Agreement (CLA) declaring that you have the right to,
and actually do, grant us the rights to use your contribution. For details, visit
https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need
to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the
instructions provided by the bot. You will only need to do this once across all repositories using our CLA.

This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) Microsoft Corporation.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Project
# 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.
Expand Down
15 changes: 15 additions & 0 deletions docs/config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# THIS IS A TEST CONFIG ONLY!
# FOR THE CONFIGURATION OF YOUR SITE USE hugo.yaml.
#
# As of Docsy 0.7.0, Hugo 0.110.0 or later must be used.
#
# The sole purpose of this config file is to detect Hugo-module builds that use
# an older version of Hugo.
#
# DO NOT add any config parameters to this file. You can safely delete this file
# if your project is using the required Hugo version.

module:
hugoVersion:
extended: true
min: 0.110.0
40 changes: 40 additions & 0 deletions docs/content/en/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
title: Activate GenAI with Azure
---

{{< blocks/cover title="Activate GenAI with Azure!" image_anchor="top" height="full" >}}
<a class="btn btn-lg btn-primary me-3 mb-4" href="/activate-genai/docs/">
Learn More <i class="fas fa-arrow-alt-circle-right ms-2"></i>
</a>
<a class="btn btn-lg btn-secondary me-3 mb-4" href="https://github.com/azure/activate-genai">
GitHub Repo <i class="fab fa-github ms-2 "></i>
</a>
<p class="lead mt-5">Talk with your Enterprise data with Azure OpenAI and Cognitive Search.</p>
{{< blocks/link-down color="info" >}}
{{< /blocks/cover >}}


{{% blocks/lead color="primary" %}}

This delivery guide will help you build a ChatGPT-like experiences over your Enterprise data using the Retrieval Augmented Generation pattern.

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.

{{% /blocks/lead %}}


{{% blocks/section color="dark" type="row" %}}

{{% blocks/feature icon="fab fa-github" title="Read the Docs!" url="https://azure.github.io/activate-genai/" %}}
Read the delivery guide and learn how to deploy the solution.
{{% /blocks/feature %}}

{{% blocks/feature icon="fab fa-github" title="Deploy the Solution!" url="https://github.com/azure/activate-genai/" %}}
Use `terraform` to deploy the complete solution.
{{% /blocks/feature %}}

{{% blocks/feature icon="fab fa-github" title="Contributions welcome!" url="https://github.com/azure/activate-genai" %}}
We do a [Pull Request](https://github.com/azure/activate-genai/pulls) contributions workflow on **GitHub**. New users are always welcome!
{{% /blocks/feature %}}

{{% /blocks/section %}}
6 changes: 6 additions & 0 deletions docs/content/en/docs/Concepts/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Concepts
weight: 4
description: >
Understand the core components of the soltion: Azure Open AI, Azure Cognitive Search, Azure APIM and more.
---
10 changes: 10 additions & 0 deletions docs/content/en/docs/Concepts/azure-apim.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Azure APIM
date: 2023-10-06
description: >
Use Azure APIM to monitor and load balance 2 or more Azure OpenAI instances.
categories: [Azure]
tags: [docs, apim]
---

Azure API Management is a platform-as-a-service that provides a hybrid, multicloud management platform for APIs across all environments [1](https://learn.microsoft.com/en-us/azure/api-management/api-management-key-concepts).. It supports the complete API lifecycle and helps customers manage APIs as first-class assets throughout their lifecycle [1](https://learn.microsoft.com/en-us/azure/api-management/api-management-key-concepts).
10 changes: 10 additions & 0 deletions docs/content/en/docs/Concepts/azure-application-insights.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Azure Application Insights
date: 2023-10-06
description: >
A short lead description about this content page. It can be **bold** or _italic_ and can be split over multiple paragraphs.
categories: [Azure]
tags: [docs, application-insights]
---

TODO
10 changes: 10 additions & 0 deletions docs/content/en/docs/Concepts/azure-cognitive-search.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Azure Cognitive Search
date: 2023-10-06
description: >
A short lead description about this content page. It can be **bold** or _italic_ and can be split over multiple paragraphs.
categories: [Azure]
tags: [docs, cognitive-search]
---

TODO
10 changes: 10 additions & 0 deletions docs/content/en/docs/Concepts/azure-container-apps.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Azure Container Apps
date: 2023-10-06
description: >
A short lead description about this content page. It can be **bold** or _italic_ and can be split over multiple paragraphs.
categories: [Azure]
tags: [docs, container-apps, serverless]
---

TODO
10 changes: 10 additions & 0 deletions docs/content/en/docs/Concepts/azure-functions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Azure Functions
date: 2023-10-06
description: >
A short lead description about this content page. It can be **bold** or _italic_ and can be split over multiple paragraphs.
categories: [Azure]
tags: [docs, functions, serverless]
---

TODO
10 changes: 10 additions & 0 deletions docs/content/en/docs/Concepts/azure-openai.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Azure OpenAI
date: 2023-10-06
description: >
A short lead description about this content page. It can be **bold** or _italic_ and can be split over multiple paragraphs.
categories: [Azure]
tags: [docs, openai]
---

TODO
10 changes: 10 additions & 0 deletions docs/content/en/docs/Concepts/azure-storage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Azure Storage
date: 2023-10-06
description: >
A short lead description about this content page. It can be **bold** or _italic_ and can be split over multiple paragraphs.
categories: [Azure]
tags: [docs, storage]
---

TODO
10 changes: 10 additions & 0 deletions docs/content/en/docs/Concepts/semantic-kernel.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Semantic Kernel
date: 2023-10-06
description: >
A short lead description about this content page. It can be **bold** or _italic_ and can be split over multiple paragraphs.
categories: [SDK]
tags: [docs, tools]
---

TODO
Loading

0 comments on commit b8e2530

Please sign in to comment.