Skip to content

Commit

Permalink
Add markdown link check (Azure-Samples#187)
Browse files Browse the repository at this point in the history
* Add markdown link check

* update link

* Fix links

* fix links

* fix link

* fix links

* fix links and typos

* fix

* fix
  • Loading branch information
dingmeng-xue authored Nov 21, 2023
1 parent 677faae commit 6d6afe5
Show file tree
Hide file tree
Showing 14 changed files with 66 additions and 26 deletions.
14 changes: 14 additions & 0 deletions .github/workflows/markdown-link-check.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
name: Markdown Links Check

on: [pull_request]

jobs:
markdown-link-check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- uses: gaurav-nelson/[email protected]
with:
use-quiet-mode: 'yes'
use-verbose-mode: 'yes'
config-file: '.github/workflows/mlc_config.json'
29 changes: 29 additions & 0 deletions .github/workflows/mlc_config.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
{
"ignorePatterns": [
{
"pattern": "^http://127.0.0.1"
},
{
"pattern": "^https://127.0.0.1"
},
{
"pattern": "^http://localhost"
},
{
"pattern": "^https://localhost"
},
{
"pattern": "^http://proxyserver"
},
{
"pattern": "^http://example.com"
},
{
"pattern": "^https://example.com"
},
{
"pattern": "^https://github.com/Azure-Samples/acme-fitness-store/invitations"
}
],
"aliveStatusCodes": [200]
}
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ description: "Deploy Microservice Apps to Azure"
urlFragment: "acme-fitness-store"
---
# ACME Fitness Store
![Check Markdown Links](https://github.com/Azure-Samples/acme-fitness-store/actions/workflows/markdown-link-check.yml/badge.svg)

ACME Fitness store is a fictional online retailer selling sporting goods. This repo contains the source code and deployment scripts for the ACME Fitness store application.

Expand Down Expand Up @@ -41,7 +42,7 @@ The sample can be deployed to Azure Spring Apps Enterprise or Tanzu Application
| Directory | Purpose |
| ---------------------------------------------------------------- | ------------- |
| [apps/](./apps) | source code for the services |
| [azure-spring-apps-enterprise/](./azure-spring-apps-enterprise) | documentaion and scripts for deploying to Azure Spring Apps Enterprise |
| [azure-spring-apps-enterprise/](./azure-spring-apps-enterprise) | documentation and scripts for deploying to Azure Spring Apps Enterprise |
| [tanzu-application-platform/](./tanzu-application-platform) | documentation and scripts for deploying to Tanzu Application Platform|

## Deploy Apps to Azure Spring Apps Enterprise (ASA-E)
Expand All @@ -52,7 +53,7 @@ polyglot applications on Azure. The quickstart guide in
shows you how to deploy the ACME Fitness store application to Azure Spring Apps
Enterprise.

* [Deploy Applications to Azure Spring Apps](./azure-spring-apps-enterprise/README.md#deploy-spring-boot-apps-to-azure)
* [Deploy Applications to Azure Spring Apps](./azure-spring-apps-enterprise/README.md#deploy-spring-boot-apps-to-azure-spring-apps-enterprise)
* [What will you experience](./azure-spring-apps-enterprise/#what-will-you-experience)
* [What you will need](./azure-spring-apps-enterprise/#what-you-will-need)
* [Install the Azure CLI extension](./azure-spring-apps-enterprise/#install-the-azure-cli-extension)
Expand Down
10 changes: 3 additions & 7 deletions apps/acme-cart/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

> A cart service, because what is a shop without a cart to put stuff in?
The Cart service is part of the [ACME Fitness Shop](https://github.com/vmwarecloudadvocacy/acme_fitness_demo). The goal of this specific service is to keep track of carts and items in the different carts.
The Cart service is part of the [ACME Fitness Shop](https://github.com/Azure-Samples/acme-fitness-store). The goal of this specific service is to keep track of carts and items in the different carts.

## Prerequisites

Expand Down Expand Up @@ -270,10 +270,6 @@ curl --request GET \

## Contributing

[Pull requests](https://github.com/vmwarecloudadvocacy/order/pulls) are welcome. For major changes, please open [an issue](https://github.com/vmwarecloudadvocacy/order/issues) first to discuss what you would like to change.
[Pull requests](https://github.com/Azure-Samples/acme-fitness-store/pulls) are welcome. For major changes, please open [an issue](https://github.com/Azure-Samples/acme-fitness-store/issues) first to discuss what you would like to change.

Please make sure to update tests as appropriate.

## License

See the [LICENSE](./LICENSE) file in the repository
Please make sure to update tests as appropriate.
8 changes: 4 additions & 4 deletions azure-spring-apps-enterprise/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Azure Spring Apps Enterprise enables you to easily run Spring Boot and polyglot
This quickstart shows you how to deploy existing applications written in Java, Python, and C# to Azure. When you're
finished, you can continue to manage the application via the Azure CLI or switch to using the Azure Portal.

* [Deploy Applications to Azure Spring Apps](#deploy-spring-boot-apps-to-azure)
* [Deploy Applications to Azure Spring Apps](#deploy-spring-boot-apps-to-azure-spring-apps-enterprise)
* [What will you experience](#what-will-you-experience)
* [What you will need](#what-you-will-need)
* [Install the Azure CLI extension](#install-the-azure-cli-extension)
Expand Down Expand Up @@ -64,7 +64,7 @@ an Azure subscription. If you do not already have an Azure
subscription, you can activate your
[MSDN subscriber benefits](https://azure.microsoft.com/pricing/member-offers/msdn-benefits-details/)
or sign up for a
[free Azure account]((https://azure.microsoft.com/free/)).
[free Azure account](https://azure.microsoft.com/free/).

In addition, you will need the following:

Expand Down Expand Up @@ -1911,7 +1911,7 @@ cd apps/acme-assist
1. Observe the output that was generated by the Assist application, e.g.
![A screenshot of the ACME Fitness Store with FitAssist](./media/fitassist.png)
![A screenshot of the ACME Fitness Store with FitAssist](./media/homepage-fitassist.png)
## Next Steps
Expand All @@ -1925,7 +1925,7 @@ Azure Spring Apps or VMware Tanzu components, go to:
* [Deploy Spring Apps from scratch](https://github.com/microsoft/azure-spring-cloud-training)
* [Deploy existing Spring Apps](https://github.com/Azure-Samples/azure-spring-cloud)
* [Azure for Java Cloud Developers](https://docs.microsoft.com/en-us/azure/java/)
* [Spring Cloud Azure](https://cloud.spring.io/spring-cloud-azure/)
* [Spring Cloud Azure](https://spring.io/projects/spring-cloud-azure)
* [Spring Cloud](https://spring.io/projects/spring-cloud)
* [Spring Cloud Gateway](https://docs.vmware.com/en/VMware-Spring-Cloud-Gateway-for-Kubernetes/index.html)
* [API Portal](https://docs.vmware.com/en/API-portal-for-VMware-Tanzu/index.html)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@ There are 3 workshops that are available here:

- [full](./full/README.md) : Deploys a mock e-commerce application called acme-fitness. This application is a polyglot micro-services application. Goal of this workshop is to introduce users all the different components of ASA-E and how they are leveraged to implement best practices in a cloud-native architecture.

- [ai](./ui/README.md) : Deploys an AI assist service component to an existing mock e-commerce polyglot application called acme-fitness. Goal of this workshop is to introduce users to Spring AI and how to work with Azure OpenAI resources.
- [ai](./ai/README.md) : Deploys an AI assist service component to an existing mock e-commerce polyglot application called acme-fitness. Goal of this workshop is to introduce users to Spring AI and how to work with Azure OpenAI resources.

Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ Azure Spring Apps or VMware Tanzu components, go to:
* [Deploy Spring Apps from scratch](https://github.com/microsoft/azure-spring-cloud-training)
* [Deploy existing Spring Apps](https://github.com/Azure-Samples/azure-spring-cloud)
* [Azure for Java Cloud Developers](https://docs.microsoft.com/en-us/azure/java/)
* [Spring Cloud Azure](https://cloud.spring.io/spring-cloud-azure/)
* [Spring Cloud Azure](https://spring.io/projects/spring-cloud-azure)
* [Spring Cloud](https://spring.io/projects/spring-cloud)
* [Spring Cloud Gateway](https://docs.vmware.com/en/VMware-Spring-Cloud-Gateway-for-Kubernetes/index.html)
* [API Portal](https://docs.vmware.com/en/API-portal-for-VMware-Tanzu/index.html)
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ There are two things that will be taken care of in this section.

## Create Azure Resources using ARM template

As we had already noted in the prior sections and also as we go to next sections, there are quite a few number of resources that need to be in place to execute this workshop. As the goal of this workshop is to focus more on the app/service related tasks and less on the underlying infrastructre tasks, we are providing an Azure ARM template that will provision the required reources.
As we had already noted in the prior sections and also as we go to next sections, there are quite a few number of resources that need to be in place to execute this workshop. As the goal of this workshop is to focus more on the app/service related tasks and less on the underlying infrastructure tasks, we are providing an Azure ARM template that will provision the required resources.

- Resource Group
- Azure Cache for Redis
Expand All @@ -18,7 +18,7 @@ Please right click on the below button and choose the Open in new tab option. Th

[![Deploy to Azure](images/deploybutton.svg)](https://portal.azure.com/#create/Microsoft.Template/uri/https%3a%2f%2fraw.githubusercontent.com%2fAzure-Samples%2facme-fitness-store%2fAzure%2fazure-spring-apps-enterprise%2fworkshops%2fazure-spring-apps-enterprise%2ffull%2f03-workshop-environment-setup%2facmedeploy.json)

To know about the description of the fields, click on the little info icon next to every field. For the fields where default value is populated, the recommendation is to use the default for the first time use. The only field that needs to be popluated in here is the ``ObjectId``. To get the value for this field, perform the below steps
To know about the description of the fields, click on the little info icon next to every field. For the fields where default value is populated, the recommendation is to use the default for the first time use. The only field that needs to be populated in here is the ``ObjectId``. To get the value for this field, perform the below steps

- In Services tab, search for Azure Active Directory
- On the left side, find ``Users`` link and click on that.
Expand All @@ -42,7 +42,7 @@ This workshop leverages Github Codespaces to provide a development environment f

2. Upon getting the confirmation that you are added to the Org, navigate to https://github.com/Azure-Samples/acme-fitness-store/tree/Azure, click "Code" button. You should be able to "Codespaces" as an option listed. If you do not see that option listed, most probably you are not added to [Azure-Samples](https://github.com/Azure-Samples/) org or your github id is still not active in this org. Please discuss this issue with your workshop co-ordinator.

3. Assuming the above steps are succesful, you should be able to open a terminal inside VS Code that opens up in Codespaces. Refer to this link to understand more about [Codespaces](https://github.com/CodeSpaces). This Codespace comes installed with the following software:
3. Assuming the above steps are successful, you should be able to open a terminal inside VS Code that opens up in Codespaces. Refer to this link to understand more about [Codespaces](https://docs.github.com/codespaces). This Codespace comes installed with the following software:
1. * [JDK 17](https://docs.microsoft.com/java/openjdk/download?WT.mc_id=azurespringcloud-github-judubois#openjdk-17)
2. * The environment variable `JAVA_HOME` should be set to the path of the JDK installation. The directory specified by this path should have `bin`, `jre`, and `lib` among its subdirectories. Further, ensure your `PATH` variable contains the directory `${JAVA_HOME}/bin`. To test, type `which javac` into bash shell ensure the resulting path points to a file inside `${JAVA_HOME}/bin`.
3. * [Azure CLI version 2.31.0 or higher](https://docs.microsoft.com/cli/azure/install-azure-cli?view=azure-cli-latest) version 2.31.0 or later. You can check the version of your current Azure CLI installation by running:
Expand All @@ -53,7 +53,7 @@ This workshop leverages Github Codespaces to provide a development environment f

### Prepare your environment for deployments

This step should be completed only after the successful completion of the above step 1. However as step 1 takes 25-30 minutes to fully complete, but some resources like resrouce-group and within that key-vault, log-analytics and opertational-insights should be completed within 4-5 mins. You can use these completed resources as a reference to complete the steps below.
This step should be completed only after the successful completion of the above step 1. However as step 1 takes 25-30 minutes to fully complete, but some resources like resource-group and within that key-vault, log-analytics and operational-insights should be completed within 4-5 mins. You can use these completed resources as a reference to complete the steps below.

This and following steps should be completed from within the terminal of your VS Code in Github Codespaces.

Expand All @@ -68,7 +68,7 @@ export LOG_ANALYTICS_WORKSPACE=acme-fitness-la-CHANGE-ME # By replacing CHANGE

- To get the Subscription ID, go to Azure portal, in search bar type subscriptions. The results should display your subscription and its id.

This env file comes with default values that were provided as part of arm template. It is recommended to leave the values as-is for the purpose of this workshop. If for any reason you updated these default values in the arm template, those values need to be entereted in here.
This env file comes with default values that were provided as part of arm template. It is recommended to leave the values as-is for the purpose of this workshop. If for any reason you updated these default values in the arm template, those values need to be entered in here.

Now, set the environment:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ wait

## 2. Bind apps to Service Registry

Applications need to communicate with each other. As we learnt in [section before](../07-asa-e-components-overview/service-registry/README.md) ASA-E internally uses Tanzu Service Registry for dynamic service discovery. To achieve this, required services/apps need to be bound to the service registry using the commands below:
Applications need to communicate with each other. ASA-E internally uses Tanzu Service Registry for dynamic service discovery. For details, please reference [Use Tanzu Service Registry](https://learn.microsoft.com/azure/spring-apps/how-to-enterprise-service-registry). To achieve this, required services/apps need to be bound to the service registry using the commands below:

```shell
az spring service-registry bind --app ${PAYMENT_SERVICE_APP}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ az keyvault set-policy --name ${KEY_VAULT} \
--object-id ${IDENTITY_SERVICE_APP_IDENTITY} --secret-permissions get list
```

> Note: Identity Service will not exist if you haven't completed [Section 10](../10-hol-4-configure-single-signon/README.md). Skip configuring an identity or policy for this service if not configuring Single Sign-On at this point.
> Note: Identity Service will not exist if you haven't completed [Section 10](../12-hol-3.4-configure-single-signon/README.md). Skip configuring an identity or policy for this service if not configuring Single Sign-On at this point.
## 7. Activate applications to load secrets from Azure Key Vault

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Goal of this workshop is to introduce users all the different components of ASA-

[03 - Environment Setup](./03-workshop-environment-setup/README.md)

[04 - Create ASA-E Instance](./04-create-asa-e-instance/README.md)
[04 - Configure Log Analytics workspace](./04-log-analytics-setup/README.md)

[05 - HOL-1 - Deploy Hello World App](./05-hol-1-hello-world-app/README.md)

Expand All @@ -25,7 +25,7 @@ Goal of this workshop is to introduce users all the different components of ASA-

[09 - HOL-3.1 - Deploy Acme Fitness Backend Apps](./09-hol-3.1-deploy-backend-apps/README.md)

[10 - HOL-3.2 - Configure Applicatio Configuration Service and Service Registry](./10-hol-3.2-bind-apps-to-acs-service-reg/README.md)
[10 - HOL-3.2 - Configure Application Configuration Service and Service Registry](./10-hol-3.2-bind-apps-to-acs-service-reg/README.md)

[11 - HOL-3.3 - Configure Database and Cache](./11-hol-3.3-configure-database-cache/README.md)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Github Codespaces can be leveraged to provide a development environment for runn

2. Upon getting the confirmation that you are added to the Org, navigate to https://github.com/Azure-Samples/acme-fitness-store/tree/Azure, click "Code" button. You should be able to "Codespaces" as an option listed. If you do not see that option listed, most probably you are not added to [Azure-Samples](https://github.com/Azure-Samples/) org or your github id is still not active in this org. Please discuss this issue with your workshop coordinator. If invitation was sent but it is not in your mailbox, you can visit https://github.com/Azure-Samples/acme-fitness-store/invitations to accept it directly.

3. Assuming the above steps are successful, you should be able to open a terminal inside VS Code that opens up in Codespaces. Refer to this link to understand more about [Codespaces](https://github.com/CodeSpaces). This Codespace comes installed with the following software:
3. Assuming the above steps are successful, you should be able to open a terminal inside VS Code that opens up in Codespaces. Refer to this link to understand more about [Codespaces](https://docs.github.com/codespaces). This Codespaces comes installed with the following software:
1. * [JDK 17](https://docs.microsoft.com/java/openjdk/download?WT.mc_id=azurespringcloud-github-judubois#openjdk-17)
2. * The environment variable `JAVA_HOME` should be set to the path of the JDK installation. The directory specified by this path should have `bin`, `jre`, and `lib` among its subdirectories. Further, ensure your `PATH` variable contains the directory `${JAVA_HOME}/bin`. To test, type `which javac` into bash shell ensure the resulting path points to a file inside `${JAVA_HOME}/bin`.
3. * [Azure CLI version 2.31.0 or higher](https://docs.microsoft.com/cli/azure/install-azure-cli?view=azure-cli-latest) version 2.31.0 or later. You can check the version of your current Azure CLI installation by running:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ wait

## 4. Bind apps to Service Registry

Applications need to communicate with each other. As we learnt in [section before](../07-asa-e-components-overview/service-registry/README.md) ASA-E internally uses Tanzu Service Registry for dynamic service discovery. To achieve this, required services/apps need to be bound to the service registry using the commands below:
Applications need to communicate with each other. ASA-E internally uses Tanzu Service Registry for dynamic service discovery. For details, please reference [Use Tanzu Service Registry](https://learn.microsoft.com/azure/spring-apps/how-to-enterprise-service-registry). To achieve this, required services/apps need to be bound to the service registry using the commands below:

```shell
az spring service-registry bind --app ${PAYMENT_SERVICE_APP}
Expand Down

0 comments on commit 6d6afe5

Please sign in to comment.