Skip to content

Commit 6285a9b

Browse files
authored
Update readme.md for AI gallery compliance (#181)
## Purpose <!-- Describe the intention of the changes being proposed. What problem does it solve or functionality does it add? --> Added required H2 headers back into the readme.md file as required by the AI Gallery. Broke up existing readme contents to fill these sections, and added list of useful links in the resources section. ## Does this introduce a breaking change? <!-- Mark one with an "x". --> ``` [ ] Yes [x] No ``` ## Pull Request Type What kind of change does this Pull Request introduce? <!-- Please check the one that applies to this PR using "x". --> ``` [ ] Bugfix [ ] Feature [ ] Code style update (formatting, local variables) [ ] Refactoring (no functional changes, no api changes) [x] Documentation content changes [ ] Other... Please describe: ``` ## How to Test Review the Readme.md file in the working branch: https://github.com/Azure-Samples/java-on-aca/tree/Update-Readme.md-for-AI-Gallery-compliance
1 parent 9b8f721 commit 6285a9b

File tree

1 file changed

+33
-3
lines changed

1 file changed

+33
-3
lines changed

README.md

+33-3
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,44 @@
33
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/Azure-Samples/java-on-aca)
44
[![Open in Dev Containers](https://img.shields.io/static/v1?style=for-the-badge&label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/azure-samples/java-on-aca)
55

6-
This repository supports the [Java and AI](https://azure-samples.github.io/java-on-aca/) lab series. In these labs, you'll walk through deploying the sample [Spring Petclinic](https://github.com/Azure-Samples/java-on-aca/tree/main/src) application to an [Azure Container Apps](https://learn.microsoft.com/azure/container-apps/overview) environment while also integrating additional Azure services, such as [Azure OpenAI](https://learn.microsoft.com/en-us/azure/ai-services/openai/overview).
6+
## Features
77

8-
Please visit the [**Java and AI lab series documentation**](https://azure-samples.github.io/java-on-aca/) for information on lab requirements, how to prepare your development environment, and instruction on running these labs.
8+
This repository supports the [Java and AI](https://azure-samples.github.io/java-on-aca/) lab series. In these labs, you'll walk through deploying the sample [Spring Petclinic](https://github.com/Azure-Samples/java-on-aca/tree/main/src) application to an [Azure Container Apps](https://learn.microsoft.com/azure/container-apps/overview) environment while also integrating additional Azure services, such as [Azure OpenAI](https://learn.microsoft.com/azure/ai-services/openai/overview).
99

1010
![main page](./images/api-gateway-main.png)
1111

12+
## Guidance
13+
14+
Please visit the [**Java and AI lab series documentation**](https://azure-samples.github.io/java-on-aca/) for information on lab requirements, how to prepare your development environment, and instruction on running these labs.
15+
16+
## Getting Started
17+
18+
See the [installation guide](https://azure-samples.github.io/java-on-aca/install.html) for instructions on preparing a dev environment and configuring your lab subscription.
19+
1220
## Important Security Notice
1321

1422
The application code and configuration files contained in this repo are for educational purposes, and were built specifically to showcase specific Microsoft Azure services and tools. You should not use this code in your production environments without thoroughly reviewing it and implementing or enabling additional security features.
1523

16-
For a more comprehensive list of best practices and security recommendations for building intelligent applications on Azure, review the [Azure security best practices and patterns](https://learn.microsoft.com/en-us/azure/security/fundamentals/best-practices-and-patterns) and [Azure security baseline for Intelligent Recommendations](https://learn.microsoft.com/en-us/security/benchmark/azure/baselines/intelligent-recommendations-security-baseline) guides.
24+
For a more comprehensive list of best practices and security recommendations for building intelligent applications on Azure, review the [Azure security best practices and patterns](https://learn.microsoft.com/azure/security/fundamentals/best-practices-and-patterns) and [Azure security baseline for Intelligent Recommendations](https://learn.microsoft.com/security/benchmark/azure/baselines/intelligent-recommendations-security-baseline) guides.
25+
26+
## Resources
27+
28+
Learn more about how you can [build and modernize AI apps on Azure](https://azure.microsoft.com/solutions/build-modernize-intelligent-apps).
29+
30+
You can also reference the following guides for more information about best practices and security recommendations for building intelligent applications on Azure:
31+
32+
- [Azure security best practices and patterns](https://learn.microsoft.com/azure/security/fundamentals/best-practices-and-patterns)
33+
- [Azure security baseline for Intelligent Recommendations](https://learn.microsoft.com/security/benchmark/azure/baselines/intelligent-recommendations-security-baseline)
34+
35+
For more information about the specific Microsoft products, services, and technologies we use in these labs, see the following links:
36+
37+
- [Java on Azure](https://azure.microsoft.com/resources/developers/java)
38+
- [Azure Container Apps](https://learn.microsoft.com/azure/container-apps/overview)
39+
- [Azure OpenAI Service](https://learn.microsoft.com/azure/ai-services/openai/)
40+
- [GitHub Copilot](https://github.com/features/copilot)
41+
- [Visual Studio Code](https://code.visualstudio.com/)
42+
- [Azure Database for MySQL - Flexible Server](https://learn.microsoft.com/azure/mysql/flexible-server/overview)
43+
- [Azure Container Registry](https://learn.microsoft.com/azure/container-registry/container-registry-intro)
44+
- [Log Analytics workspace](https://learn.microsoft.com/azure/azure-monitor/logs/log-analytics-workspace-overview)
45+
- [Application Insights](https://learn.microsoft.com/azure/azure-monitor/app/app-insights-overview)
46+
- [Azure Managed Grafana](https://learn.microsoft.com/azure/managed-grafana/)

0 commit comments

Comments
 (0)