From 9d9e21101489538a0ac3be07b26bf6eb87ab15a3 Mon Sep 17 00:00:00 2001 From: Microsoft Open Source Date: Fri, 6 Oct 2023 00:53:11 -0700 Subject: [PATCH] LICENSE committed --- .github/workflows/gh-pages.yml | 85 ++++++++ .gitignore | 12 +- CONTRIBUTING.md | 14 ++ LICENSE | 21 ++ docs/config.yaml | 15 ++ docs/content/en/_index.md | 40 ++++ docs/content/en/docs/Concepts/_index.md | 6 + docs/content/en/docs/Concepts/azure-apim.md | 10 + .../Concepts/azure-application-insights.md | 10 + .../docs/Concepts/azure-cognitive-search.md | 10 + .../en/docs/Concepts/azure-container-apps.md | 10 + .../en/docs/Concepts/azure-functions.md | 10 + docs/content/en/docs/Concepts/azure-openai.md | 10 + .../content/en/docs/Concepts/azure-storage.md | 10 + .../en/docs/Concepts/semantic-kernel.md | 10 + .../en/docs/Contribution guidelines/_index.md | 20 ++ .../en/docs/Deploy the Architecture/_index.md | 12 ++ docs/content/en/docs/Overview/_index.md | 50 +++++ docs/content/en/docs/Reference/_index.md | 26 +++ .../en/docs/Supported Scenarios/_index.md | 37 ++++ docs/content/en/docs/_index.md | 13 ++ docs/content/en/search.md | 4 + docs/go.mod | 9 + docs/go.sum | 22 ++ docs/hugo.toml | 188 ++++++++++++++++++ docs/layouts/404.html | 7 + docs/package.json | 38 ++++ docs/scss/_variables_project.scss | 6 + infra/README.md | 0 infra/main.tf | 0 infra/providers.tf | 0 infra/variables.tf | 0 32 files changed, 698 insertions(+), 7 deletions(-) create mode 100644 .github/workflows/gh-pages.yml create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE create mode 100644 docs/config.yaml create mode 100644 docs/content/en/_index.md create mode 100644 docs/content/en/docs/Concepts/_index.md create mode 100644 docs/content/en/docs/Concepts/azure-apim.md create mode 100644 docs/content/en/docs/Concepts/azure-application-insights.md create mode 100644 docs/content/en/docs/Concepts/azure-cognitive-search.md create mode 100644 docs/content/en/docs/Concepts/azure-container-apps.md create mode 100644 docs/content/en/docs/Concepts/azure-functions.md create mode 100644 docs/content/en/docs/Concepts/azure-openai.md create mode 100644 docs/content/en/docs/Concepts/azure-storage.md create mode 100644 docs/content/en/docs/Concepts/semantic-kernel.md create mode 100644 docs/content/en/docs/Contribution guidelines/_index.md create mode 100644 docs/content/en/docs/Deploy the Architecture/_index.md create mode 100644 docs/content/en/docs/Overview/_index.md create mode 100644 docs/content/en/docs/Reference/_index.md create mode 100644 docs/content/en/docs/Supported Scenarios/_index.md create mode 100644 docs/content/en/docs/_index.md create mode 100644 docs/content/en/search.md create mode 100644 docs/go.mod create mode 100644 docs/go.sum create mode 100644 docs/hugo.toml create mode 100644 docs/layouts/404.html create mode 100644 docs/package.json create mode 100644 docs/scss/_variables_project.scss create mode 100644 infra/README.md create mode 100644 infra/main.tf create mode 100644 infra/providers.tf create mode 100644 infra/variables.tf diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml new file mode 100644 index 0000000..1da6eb6 --- /dev/null +++ b/.github/workflows/gh-pages.yml @@ -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 \ No newline at end of file diff --git a/.gitignore b/.gitignore index 74a9223..0d4f356 100644 --- a/.gitignore +++ b/.gitignore @@ -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 \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..c282e9a --- /dev/null +++ b/CONTRIBUTING.md @@ -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 [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..9e841e7 --- /dev/null +++ b/LICENSE @@ -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 diff --git a/docs/config.yaml b/docs/config.yaml new file mode 100644 index 0000000..9070e38 --- /dev/null +++ b/docs/config.yaml @@ -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 diff --git a/docs/content/en/_index.md b/docs/content/en/_index.md new file mode 100644 index 0000000..320a71c --- /dev/null +++ b/docs/content/en/_index.md @@ -0,0 +1,40 @@ +--- +title: Activate GenAI with Azure +--- + +{{< blocks/cover title="Activate GenAI with Azure!" image_anchor="top" height="full" >}} + + Learn More + + + GitHub Repo + +

Talk with your Enterprise data with Azure OpenAI and Cognitive Search.

+{{< 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 %}} diff --git a/docs/content/en/docs/Concepts/_index.md b/docs/content/en/docs/Concepts/_index.md new file mode 100644 index 0000000..5427ff5 --- /dev/null +++ b/docs/content/en/docs/Concepts/_index.md @@ -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. +--- diff --git a/docs/content/en/docs/Concepts/azure-apim.md b/docs/content/en/docs/Concepts/azure-apim.md new file mode 100644 index 0000000..7667e4d --- /dev/null +++ b/docs/content/en/docs/Concepts/azure-apim.md @@ -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). \ No newline at end of file diff --git a/docs/content/en/docs/Concepts/azure-application-insights.md b/docs/content/en/docs/Concepts/azure-application-insights.md new file mode 100644 index 0000000..2396805 --- /dev/null +++ b/docs/content/en/docs/Concepts/azure-application-insights.md @@ -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 \ No newline at end of file diff --git a/docs/content/en/docs/Concepts/azure-cognitive-search.md b/docs/content/en/docs/Concepts/azure-cognitive-search.md new file mode 100644 index 0000000..49c7225 --- /dev/null +++ b/docs/content/en/docs/Concepts/azure-cognitive-search.md @@ -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 \ No newline at end of file diff --git a/docs/content/en/docs/Concepts/azure-container-apps.md b/docs/content/en/docs/Concepts/azure-container-apps.md new file mode 100644 index 0000000..f7176ea --- /dev/null +++ b/docs/content/en/docs/Concepts/azure-container-apps.md @@ -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 \ No newline at end of file diff --git a/docs/content/en/docs/Concepts/azure-functions.md b/docs/content/en/docs/Concepts/azure-functions.md new file mode 100644 index 0000000..9f6bc88 --- /dev/null +++ b/docs/content/en/docs/Concepts/azure-functions.md @@ -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 \ No newline at end of file diff --git a/docs/content/en/docs/Concepts/azure-openai.md b/docs/content/en/docs/Concepts/azure-openai.md new file mode 100644 index 0000000..edfa373 --- /dev/null +++ b/docs/content/en/docs/Concepts/azure-openai.md @@ -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 \ No newline at end of file diff --git a/docs/content/en/docs/Concepts/azure-storage.md b/docs/content/en/docs/Concepts/azure-storage.md new file mode 100644 index 0000000..e7b1757 --- /dev/null +++ b/docs/content/en/docs/Concepts/azure-storage.md @@ -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 \ No newline at end of file diff --git a/docs/content/en/docs/Concepts/semantic-kernel.md b/docs/content/en/docs/Concepts/semantic-kernel.md new file mode 100644 index 0000000..bf7a3a7 --- /dev/null +++ b/docs/content/en/docs/Concepts/semantic-kernel.md @@ -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 \ No newline at end of file diff --git a/docs/content/en/docs/Contribution guidelines/_index.md b/docs/content/en/docs/Contribution guidelines/_index.md new file mode 100644 index 0000000..2db8089 --- /dev/null +++ b/docs/content/en/docs/Contribution guidelines/_index.md @@ -0,0 +1,20 @@ +--- +title: Contribution Guidelines +weight: 10 +description: How to contribute to the project +--- + +## 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 [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. \ No newline at end of file diff --git a/docs/content/en/docs/Deploy the Architecture/_index.md b/docs/content/en/docs/Deploy the Architecture/_index.md new file mode 100644 index 0000000..fcf6221 --- /dev/null +++ b/docs/content/en/docs/Deploy the Architecture/_index.md @@ -0,0 +1,12 @@ +--- +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. +--- + +Run the following command to deploy the **Activate GenAI with Azure** Accelerator: + +```bash +cd infra +terraform apply +``` \ No newline at end of file diff --git a/docs/content/en/docs/Overview/_index.md b/docs/content/en/docs/Overview/_index.md new file mode 100644 index 0000000..301d558 --- /dev/null +++ b/docs/content/en/docs/Overview/_index.md @@ -0,0 +1,50 @@ +--- +title: Overview +description: Activate GenAI with Azure — A smart and scalable document retrieval solution" +weight: 1 +--- + +## Description +**Activate GenAI with Azure** is a new delivery that leverages the power of artificial intelligence and cloud computing to provide a smart and scalable document retrieval solution. The solution uses Azure OpenAI, Cognitive Search, Container Apps, Application Insights, and Azure API Management to create a chat interface that can answer user queries with relevant documents, suggested follow-up questions, and citations. The solution also allows users to upload custom data files and perform vector search using semantic or hybrid methods. Additionally, the solution supports extensibility through plugins, charge back functionality, security features such as authentication and authorization, monitoring capabilities, and scalability options. + +## Pre-requisites +To use this solution, you will need the following: +- An Azure subscription +- A User, Service Principal or Managed Identity with the following permissions: + - Contributor role on the Azure subscription +- Azure CLI v2.253.0 or later +- Terraform v1.6.0 or later + +## Objectives +By the end of this delivery, you will be able to: +- Configure and deploy the **Activate GenAI with Azure** solution +- Use the chat interface to query documents and get relevant results +- Upload custom data files and perform vector search +- Extend the solution with plugins +- Manage the charge back functionality +- Secure and monitor the solution +- Scale and integrate the solution with other services + +## Delivery Guidance +This delivery consists of the following steps: + +### Day 1: +1. Scoping and planning. +1. Prepare the environment. +1. Adapt deployment scripts according to the customer's requirements. + +### Day 2: +1. Deploy the **Activate GenAI with Azure** solution: Create and configure the Azure resources. +1. Test and use the chat interface to query documents. +1. Upload custom data files and perform vector search. + +### Day 3: +1. Customize the solutions look and feel. +1. Extend the solution with prompt engineering and plugins. +1. Show how the solution scales and integrates with other services. +1. Show how the security and monitoring works. +1. Plan the next steps. + +## Closing +By the end of the **Activate GenAI with Azure** delivery, stakeholders will have a powerful and innovative solution that can help them improve their document retrieval efficiency, enhance their user experience, increase their productivity, share their knowledge, gain data insights and analytics, and comply with security standards.ss + diff --git a/docs/content/en/docs/Reference/_index.md b/docs/content/en/docs/Reference/_index.md new file mode 100644 index 0000000..f0fbeb7 --- /dev/null +++ b/docs/content/en/docs/Reference/_index.md @@ -0,0 +1,26 @@ +--- +title: Resources & References +description: Check out other resources and references +weight: 9 +--- + +## Sample Repos: + +* [Chat Copilot Sample Application](https://github.com/microsoft/chat-copilot) +* [ChatGPT + Enterprise data with Azure OpenAI and Cognitive Search](https://github.com/Azure-Samples/azure-search-openai-demo) +* [Azure OpenAI Embeddings QnA](https://github.com/ruoccofabrizio/azure-open-ai-embeddings-qna) + +## Azure APIM & Azure OpenAI + +* [Load Balancing in Azure OpenAI Service](https://journeyofthegeek.com/2023/05/31/load-balancing-in-azure-openai-service/) +* [Granular Chargebacks in Azure OpenAI Service](https://journeyofthegeek.com/2023/05/18/granular-chargebacks-in-azure-openai-service/) +* [Enterprise Azure OpenA](https://github.com/Azure-Samples/openai-python-enterprise-logging) + +## Azure Services + +* [Azure OpenAI](https://azure.microsoft.com/en-us/products/ai-services/openai-service) +* [Azure Cognitive Search](https://learn.microsoft.com/en-us/azure/search/search-what-is-azure-search) +* [Azure Container Apps](https://learn.microsoft.com/en-us/azure/container-apps/overview) +* [Azure API Management](https://learn.microsoft.com/en-us/azure/api-management/api-management-key-concepts) +* [Azure Application Insights](hhttps://learn.microsoft.com/en-us/azure/azure-monitor/app/app-insights-overview?tabs=net) +* [Azure Active Directory](https://learn.microsoft.com/en-us/azure/active-directory/fundamentals/whatis) \ No newline at end of file diff --git a/docs/content/en/docs/Supported Scenarios/_index.md b/docs/content/en/docs/Supported Scenarios/_index.md new file mode 100644 index 0000000..bc00d17 --- /dev/null +++ b/docs/content/en/docs/Supported Scenarios/_index.md @@ -0,0 +1,37 @@ +--- +title: Supported Scenarios +weight: 2 +description: Understand the supported Scenarios. +--- + +## Business Scenarios + +### Document Retrieval + +**Activate GenAI with Azure** is a new delivery that leverages the power of artificial intelligence and cloud computing to provide a smart and scalable document retrieval solution. The solution uses Azure OpenAI, Cognitive Search, Container Apps, Application Insights, and Azure API Management to create a chat interface that can answer user queries with relevant documents, suggested follow-up questions, and citations. The solution also allows users to upload custom data files and perform vector search using semantic or hybrid methods. Additionally, the solution supports extensibility through plugins, charge back functionality, security features such as authentication and authorization, monitoring capabilities, and scalability options. + +## Technical Scenarios + +### Azure OpenAI enhanced Monitoring + +TODO + +**References:** + +* [Enterprise Azure OpenA](https://github.com/Azure-Samples/openai-python-enterprise-logging) + +### Load Balance Azure OpenAI instances + +TODO + +**References:** + +[Load Balancing in Azure OpenAI Service](https://journeyofthegeek.com/2023/05/31/load-balancing-in-azure-openai-service/) + +### Serverless Document Batch Processing + +TODO + +**References:** + +[Azure OpenAI Embeddings QnA](https://github.com/ruoccofabrizio/azure-open-ai-embeddings-qna) \ No newline at end of file diff --git a/docs/content/en/docs/_index.md b/docs/content/en/docs/_index.md new file mode 100644 index 0000000..a9825f9 --- /dev/null +++ b/docs/content/en/docs/_index.md @@ -0,0 +1,13 @@ +--- +title: Activate GenAI with Azure +linkTitle: Documentation +menu: {main: {weight: 20}} +weight: 20 +--- + +{{% pageinfo %}} +**Activate GenAI with Azure!** — 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. + diff --git a/docs/content/en/search.md b/docs/content/en/search.md new file mode 100644 index 0000000..394feea --- /dev/null +++ b/docs/content/en/search.md @@ -0,0 +1,4 @@ +--- +title: Search Results +layout: search +--- diff --git a/docs/go.mod b/docs/go.mod new file mode 100644 index 0000000..ec0974f --- /dev/null +++ b/docs/go.mod @@ -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 +) diff --git a/docs/go.sum b/docs/go.sum new file mode 100644 index 0000000..e1d4ad4 --- /dev/null +++ b/docs/go.sum @@ -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= diff --git a/docs/hugo.toml b/docs/hugo.toml new file mode 100644 index 0000000..30a347c --- /dev/null +++ b/docs/hugo.toml @@ -0,0 +1,188 @@ +baseURL = "/" +title = "Activate GenAI with Azure" + +# Language settings +contentDir = "content/en" +defaultContentLanguage = "en" +defaultContentLanguageInSubdir = false +# Useful when translating. +enableMissingTranslationPlaceholders = true + +enableRobotsTXT = true + +# Will give values to .Lastmod etc. +enableGitInfo = true + +# Comment out to enable taxonomies in Docsy +# disableKinds = ["taxonomy", "taxonomyTerm"] + +# You can add your own taxonomies +[taxonomies] +tag = "tags" +category = "categories" + +[params.taxonomy] +# set taxonomyCloud = [] to hide taxonomy clouds +taxonomyCloud = ["tags", "categories"] + +# If used, must have same length as taxonomyCloud +taxonomyCloudTitle = ["Tag Cloud", "Categories"] + +# set taxonomyPageHeader = [] to hide taxonomies on the page headers +taxonomyPageHeader = ["tags", "categories"] + +# Highlighting config +pygmentsCodeFences = true +pygmentsUseClasses = false +# Use the new Chroma Go highlighter in Hugo. +pygmentsUseClassic = false +#pygmentsOptions = "linenos=table" +# See https://help.farbox.com/pygments.html +pygmentsStyle = "tango" + +# Configure how URLs look like per section. +[permalinks] +blog = "/:section/:year/:month/:day/:slug/" + +# Image processing configuration. +[imaging] +resampleFilter = "CatmullRom" +quality = 75 +anchor = "smart" + +[services] +[services.googleAnalytics] +# Comment out the next line to disable GA tracking. Also disables the feature described in [params.ui.feedback]. +id = "UA-00000000-0" + +# Language configuration + +[languages] +[languages.en] +languageName ="English" +# Weight used for sorting. +weight = 1 +[languages.en.params] +title = "Activate GenAI with Azure" +description = "Activate GenAI with Azure" + +[markup] + [markup.goldmark] + [markup.goldmark.parser.attribute] + block = true + [markup.goldmark.renderer] + unsafe = true + [markup.highlight] + # See a complete list of available styles at https://xyproto.github.io/splash/docs/all.html + style = "tango" + # Uncomment if you want your chosen highlight style used for code blocks without a specified language + # guessSyntax = "true" + +# Everything below this are Site Params + +# Comment out if you don't want the "print entire section" link enabled. +[outputs] +section = ["HTML", "print", "RSS"] + +[params] +copyright = "The Activate GenAI with Azure" +# privacy_policy = "https://github.com/azure/activate-genai/SECURITY.md" + +# First one is picked as the Twitter card image if not set on page. +# images = ["images/project-illustration.png"] + +# Menu title if your navbar has a versions selector to access old versions of your site. +# This menu appears only if you have at least one [params.versions] set. +version_menu = "Releases" + +# Flag used in the "version-banner" partial to decide whether to display a +# banner on every page indicating that this is an archived version of the docs. +# Set this flag to "true" if you want to display the banner. +archived_version = false + +# The version number for the version of the docs represented in this doc set. +# Used in the "version-banner" partial to display a version number for the +# current doc set. +version = "0.0" + +# A link to latest version of the docs. Used in the "version-banner" partial to +# point people to the main doc site. +url_latest_version = "https://azure.github.io/activate-genai" + +# Repository configuration (URLs for in-page links to opening issues and suggesting changes) +github_repo = "https://github.com/azure/activate-genai" +# An optional link to a related project repo. For example, the sibling repository where your product code lives. +github_project_repo = "https://github.com/azure/activate-genai" + +# Specify a value here if your content directory is not in your repo's root directory +# github_subdir = "" + +# Uncomment this if your GitHub repo does not have "main" as the default branch, +# or specify a new value if you want to reference another branch in your GitHub links +github_branch= "main" + +# Google Custom Search Engine ID. Remove or comment out to disable search. +# gcs_engine_id = "d72aa9b2712488cc3" + +# Enable Algolia DocSearch +algolia_docsearch = false + +# Enable Lunr.js offline search +offlineSearch = true + +# Enable syntax highlighting and copy buttons on code blocks with Prism +prism_syntax_highlighting = false + +# User interface configuration +[params.ui] +# Set to true to disable breadcrumb navigation. +breadcrumb_disable = false +# Set to true to disable the About link in the site footer +footer_about_disable = false +# Set to false if you don't want to display a logo (/assets/icons/logo.svg) in the top navbar +navbar_logo = true +# Set to true if you don't want the top navbar to be translucent when over a `block/cover`, like on the homepage. +navbar_translucent_over_cover_disable = false +# Enable to show the side bar menu in its compact state. +sidebar_menu_compact = false +# Set to true to hide the sidebar search box (the top nav search box will still be displayed if search is enabled) +sidebar_search_disable = false + +# Adds a H2 section titled "Feedback" to the bottom of each doc. The responses are sent to Google Analytics as events. +# This feature depends on [services.googleAnalytics] and will be disabled if "services.googleAnalytics.id" is not set. +# If you want this feature, but occasionally need to remove the "Feedback" section from a single page, +# add "hide_feedback: true" to the page's front matter. +[params.ui.feedback] +enable = true +# The responses that the user sees after clicking "yes" (the page was helpful) or "no" (the page was not helpful). +yes = 'Glad to hear it! Please tell us how we can improve.' +no = 'Sorry to hear that. Please tell us how we can improve.' + +# Adds a reading time to the top of each doc. +# If you want this feature, but occasionally need to remove the Reading time from a single page, +# add "hide_readingtime: true" to the page's front matter +[params.ui.readingtime] +enable = false + +[params.links] +# Developer relevant links. These will show up on right side of footer and in the community page if you have one. +[[params.links.developer]] + name = "GitHub" + url = "https://github.com/azure/activate-genai" + icon = "fab fa-github" + desc = "Development takes place here!" + +# hugo module configuration + +[module] + # uncomment line below for temporary local development of module + # replacements = "github.com/google/docsy -> ../../docsy" + [module.hugoVersion] + extended = true + min = "0.110.0" + [[module.imports]] + path = "github.com/google/docsy" + disable = false + [[module.imports]] + path = "github.com/google/docsy/dependencies" + disable = false diff --git a/docs/layouts/404.html b/docs/layouts/404.html new file mode 100644 index 0000000..1a9bd70 --- /dev/null +++ b/docs/layouts/404.html @@ -0,0 +1,7 @@ +{{ define "main" -}} +
+

Not found

+

Oops! This page doesn't exist. Try going back to the home page.

+

You can learn how to make a 404 page like this in Custom 404 Pages.

+
+{{- end }} diff --git a/docs/package.json b/docs/package.json new file mode 100644 index 0000000..49c9e38 --- /dev/null +++ b/docs/package.json @@ -0,0 +1,38 @@ +{ + "name": "activate-genai", + "version": "0.7.1", + "description": "Activate GenAI with Azure technical documentation.", + "repository": "github:azure/activate-genai", + "homepage": "https://azure.github.io/activate-genai/", + "author": "Docsy Authors", + "license": "Apache-2.0", + "bugs": "https://github.com/azure/activate-genai/issues", + "spelling": "cSpell:ignore HTMLTEST precheck postbuild -", + "scripts": { + "_build": "npm run _hugo-dev", + "_check:links": "echo IMPLEMENTATION PENDING for check-links; echo", + "_hugo": "hugo --cleanDestinationDir", + "_hugo-dev": "npm run _hugo -- -e dev -DFE", + "_serve": "npm run _hugo-dev -- --minify serve", + "build:preview": "npm run _hugo-dev -- --minify --baseURL \"${DEPLOY_PRIME_URL:-/}\"", + "build:production": "npm run _hugo -- --minify", + "build": "npm run _build", + "check:links:all": "HTMLTEST_ARGS= npm run _check:links", + "check:links": "npm run _check:links", + "clean": "rm -Rf public/* resources", + "make:public": "git init -b main public", + "precheck:links:all": "npm run build", + "precheck:links": "npm run build", + "postbuild:preview": "npm run _check:links", + "postbuild:production": "npm run _check:links", + "serve": "npm run _serve", + "test": "npm run check:links", + "update:pkg:dep": "npm install --save-dev autoprefixer@latest postcss-cli@latest", + "update:pkg:hugo": "npm install --save-dev --save-exact hugo-extended@latest" + }, + "devDependencies": { + "autoprefixer": "^10.4.14", + "hugo-extended": "0.119.0", + "postcss-cli": "^10.1.0" + } +} \ No newline at end of file diff --git a/docs/scss/_variables_project.scss b/docs/scss/_variables_project.scss new file mode 100644 index 0000000..2569027 --- /dev/null +++ b/docs/scss/_variables_project.scss @@ -0,0 +1,6 @@ +/* + +Add styles or override variables from the theme here. + +*/ + diff --git a/infra/README.md b/infra/README.md new file mode 100644 index 0000000..e69de29 diff --git a/infra/main.tf b/infra/main.tf new file mode 100644 index 0000000..e69de29 diff --git a/infra/providers.tf b/infra/providers.tf new file mode 100644 index 0000000..e69de29 diff --git a/infra/variables.tf b/infra/variables.tf new file mode 100644 index 0000000..e69de29