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 9da4639
Show file tree
Hide file tree
Showing 25 changed files with 571 additions and 7 deletions.
86 changes: 86 additions & 0 deletions .github/workflows/gh-pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
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 dependencies
run: |
npm install -D autoprefixer
npm install -D postcss-cli
npm install -D postcss
npm install
- 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: hugo --gc --minify --cleanDestinationDir --baseURL https://azure.github.io/activate-genai/

- name: Upload artifact
uses: actions/upload-pages-artifact@v1
with:
path: ./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
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
6 changes: 6 additions & 0 deletions assets/scss/_variables_project.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
/*
Add styles or override variables from the theme here.
*/

15 changes: 15 additions & 0 deletions 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
31 changes: 31 additions & 0 deletions content/en/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
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">
Download <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="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 %}}
12 changes: 12 additions & 0 deletions content/en/docs/Concepts/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: Concepts
weight: 4
description: >
Understand the core components of the soltion: Azure Open AI, Azure Cognitive Search, Azure APIM and more.
---

{{% pageinfo %}}
This is a placeholder page that shows you how to use this template site.
{{% /pageinfo %}}

TODO: Add your content here.
8 changes: 8 additions & 0 deletions content/en/docs/Concepts/azure-apim.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Azure APIM
date: 2023-06-10
description: >
A short lead description about this content page. It can be **bold** or _italic_ and can be split over multiple paragraphs.
categories: [Examples]
tags: [test, sample, docs]
---
8 changes: 8 additions & 0 deletions content/en/docs/Concepts/azure-application-insights.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Azure Application Insights
date: 2023-06-10
description: >
A short lead description about this content page. It can be **bold** or _italic_ and can be split over multiple paragraphs.
categories: [Examples]
tags: [test, sample, docs]
---
8 changes: 8 additions & 0 deletions content/en/docs/Concepts/azure-cognitive-search.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Azure Cognitive Search
date: 2023-06-10
description: >
A short lead description about this content page. It can be **bold** or _italic_ and can be split over multiple paragraphs.
categories: [Examples]
tags: [test, sample, docs]
---
8 changes: 8 additions & 0 deletions content/en/docs/Concepts/azure-container-apps.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Azure Container Apps
date: 2023-06-10
description: >
A short lead description about this content page. It can be **bold** or _italic_ and can be split over multiple paragraphs.
categories: [Examples]
tags: [test, sample, docs]
---
8 changes: 8 additions & 0 deletions content/en/docs/Concepts/azure-openai.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Azure OpenAI
date: 2023-06-10
description: >
A short lead description about this content page. It can be **bold** or _italic_ and can be split over multiple paragraphs.
categories: [Examples]
tags: [test, sample, docs]
---
8 changes: 8 additions & 0 deletions content/en/docs/Concepts/semantic-kernel.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: Semantic Kernel
date: 2023-06-10
description: >
A short lead description about this content page. It can be **bold** or _italic_ and can be split over multiple paragraphs.
categories: [Examples]
tags: [test, sample, docs]
---
11 changes: 11 additions & 0 deletions content/en/docs/Contribution guidelines/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: Contribution Guidelines
weight: 10
description: How to contribute to the project
---

{{% pageinfo %}}
TODO
{{% /pageinfo %}}

TODO
11 changes: 11 additions & 0 deletions content/en/docs/Deploy the Architecture/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: Deploy the Architecture
weight: 3
description: This guide provides details and instructions to help you deploy the Activate GenAI with Azure Accelerator for your customer.
---

{{% pageinfo %}}
Deploy the Architecture
{{% /pageinfo %}}

TODO: Add your content here.
22 changes: 22 additions & 0 deletions content/en/docs/Overview/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: Overview
description: Here's where your user finds out if your project is for them.
weight: 1
---

{{% pageinfo %}}
This is a placeholder page that shows you how to use this template site.
{{% /pageinfo %}}

TODO

Try answering these questions for your user in this page:

## What is it?

Introduce your project, including what it does or lets you do, why you would use it, and its primary goal (and how it achieves it). This should be similar to your README description, though you can go into a little more detail here if you want.

## Where should I go next?

TODO

11 changes: 11 additions & 0 deletions content/en/docs/Reference/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: Resources & References
description: Check out other resources and references
weight: 9
---

{{% pageinfo %}}
This is a placeholder page that shows you how to use this template site.
{{% /pageinfo %}}

TODO: Add your content here.
11 changes: 11 additions & 0 deletions content/en/docs/Supported Scenarios/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: Supported Scenarios
weight: 2
description: Understand the supported Scenarios.
---

{{% pageinfo %}}
Supported Scenarios
{{% /pageinfo %}}

TODO: Add your content here.
13 changes: 13 additions & 0 deletions content/en/docs/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: Activate GenAI with Azure
linkTitle: Documentation
menu: {main: {weight: 20}}
weight: 20
---

{{% pageinfo %}}
Activate GenAI with Azure! &mdash; Talk with your Enterprise data with Azure OpenAI and Cognitive Search.
{{% /pageinfo %}}

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.

4 changes: 4 additions & 0 deletions content/en/search.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: Search Results
layout: search
---
9 changes: 9 additions & 0 deletions go.mod
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
module github.com/google/docsy-example

go 1.12

require (
github.com/FortAwesome/Font-Awesome v0.0.0-20230327165841-0698449d50f2 // indirect
github.com/google/docsy v0.7.1 // indirect
github.com/twbs/bootstrap v5.2.3+incompatible // indirect
)
22 changes: 22 additions & 0 deletions go.sum
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
github.com/FortAwesome/Font-Awesome v0.0.0-20220831210243-d3a7818c253f h1:bvkUptSRPZBr3Kxuk+bnWCEmQ5MtEJX5fjezyV0bC3g=
github.com/FortAwesome/Font-Awesome v0.0.0-20220831210243-d3a7818c253f/go.mod h1:IUgezN/MFpCDIlFezw3L8j83oeiIuYoj28Miwr/KUYo=
github.com/FortAwesome/Font-Awesome v0.0.0-20221115183454-96cafbd73ec4 h1:xfr9SidRCMEh4A8fdkLhFPcHAVbrdv3Ua0Jp/nSmhhQ=
github.com/FortAwesome/Font-Awesome v0.0.0-20221115183454-96cafbd73ec4/go.mod h1:IUgezN/MFpCDIlFezw3L8j83oeiIuYoj28Miwr/KUYo=
github.com/FortAwesome/Font-Awesome v0.0.0-20230327165841-0698449d50f2 h1:Uv1z5EqCfmiK4IHUwT0m3h/u/WCk+kpRfxvAZhpC7Gc=
github.com/FortAwesome/Font-Awesome v0.0.0-20230327165841-0698449d50f2/go.mod h1:IUgezN/MFpCDIlFezw3L8j83oeiIuYoj28Miwr/KUYo=
github.com/google/docsy v0.5.1 h1:D/ZdFKiE29xM/gwPwQzmkyXhcbQGkReRS6aGrF7lnYk=
github.com/google/docsy v0.5.1/go.mod h1:maoUAQU5H/d+FrZIB4xg1EVWAx7RyFMGSDJyWghm31E=
github.com/google/docsy v0.6.0 h1:43bVF18t2JihAamelQjjGzx1vO2ljCilVrBgetCA8oI=
github.com/google/docsy v0.6.0/go.mod h1:VKKLqD8PQ7AglJc98yBorATfW7GrNVsn0kGXVYF6G+M=
github.com/google/docsy v0.7.0 h1:JaeZ0/KufX/BJ3SyATb/fmZa1DFI7o5d9KU+i6+lLJY=
github.com/google/docsy v0.7.0/go.mod h1:5WhIFchr5BfH6agjcInhpLRz7U7map0bcmKSpcrg6BE=
github.com/google/docsy v0.7.1 h1:DUriA7Nr3lJjNi9Ulev1SfiG1sUYmvyDeU4nTp7uDxY=
github.com/google/docsy v0.7.1/go.mod h1:JCmE+c+izhE0Rvzv3y+AzHhz1KdwlA9Oj5YBMklJcfc=
github.com/google/docsy/dependencies v0.5.1/go.mod h1:EDGc2znMbGUw0RW5kWwy2oGgLt0iVXBmoq4UOqstuNE=
github.com/google/docsy/dependencies v0.6.0/go.mod h1:EDGc2znMbGUw0RW5kWwy2oGgLt0iVXBmoq4UOqstuNE=
github.com/google/docsy/dependencies v0.7.0/go.mod h1:gihhs5gmgeO+wuoay4FwOzob+jYJVyQbNaQOh788lD4=
github.com/google/docsy/dependencies v0.7.1/go.mod h1:gihhs5gmgeO+wuoay4FwOzob+jYJVyQbNaQOh788lD4=
github.com/twbs/bootstrap v4.6.2+incompatible h1:TDa+R51BTiy1wEHSYjmqDb8LxNl/zaEjAOpRE9Hwh/o=
github.com/twbs/bootstrap v4.6.2+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0=
github.com/twbs/bootstrap v5.2.3+incompatible h1:lOmsJx587qfF7/gE7Vv4FxEofegyJlEACeVV+Mt7cgc=
github.com/twbs/bootstrap v5.2.3+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0=
Loading

0 comments on commit 9da4639

Please sign in to comment.