Skip to content

Commit

Permalink
Fix markdown lint issues
Browse files Browse the repository at this point in the history
  • Loading branch information
1yefuwang1 committed Sep 3, 2024
1 parent fbb4b05 commit 950018b
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 5 deletions.
10 changes: 8 additions & 2 deletions aca-host/README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,20 @@
# Deploying on Azure Container Apps

Due to [a limitation](https://github.com/Azure/azure-dev/issues/2736) of azd, the azure.yaml file for deploying to Azure Container Apps lives here along with symbolic links to `app`,`data` and `scripts` folder.

## For Linux/MacOS users

If you are on Linux/MacOS, it should work without any extra settings to deploy to Azure Container Apps. Please use:

```bash
cd aca-host
azd up
```

## For Windows users

Check failure on line 14 in aca-host/README.md

View workflow job for this annotation

GitHub Actions / Check for Markdown linting errors

Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "## For Windows users"]
Because Windows [doesn't enable symbolic links by default](https://stackoverflow.com/questions/5917249/git-symbolic-links-in-windows), you may need to enable [Developer Mode](https://learn.microsoft.com/en-us/windows/apps/get-started/enable-your-device-for-development),
and symlinks for git before cloning this repo.
Because Windows [doesn't enable symbolic links by default](https://stackoverflow.com/questions/5917249/git-symbolic-links-in-windows), you may need to enable [Developer Mode](https://learn.microsoft.com/en-us/windows/apps/get-started/enable-your-device-for-development) and symlinks for git before cloning this repo.

Check failure on line 15 in aca-host/README.md

View workflow job for this annotation

GitHub Actions / Check for Markdown linting errors

Trailing spaces [Expected: 0 or 2; Actual: 1]

Check failure on line 15 in aca-host/README.md

View workflow job for this annotation

GitHub Actions / Check URLs Don't Have Locale

File aca-host/README.md, line 15, Link https://learn.microsoft.com/en-us/windows/apps/get-started/enable-your-device-for-development has locale.
To enable symlinks for git, please use

```bash
# local setting
git config core.symlinks true
Expand All @@ -18,6 +23,7 @@ git config --global core.symlinks true
```

Please ensure that the symlinks work correctly and then run:

```bash
cd aca-host
azd up
Expand Down
13 changes: 10 additions & 3 deletions docs/azure_container_apps.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,21 @@
# Deploying on Azure Container Apps

Due to [a limitation](https://github.com/Azure/azure-dev/issues/2736) of azd, the azure.yaml file for deploying to Azure Container Apps lives in folder `aca-host` along with symbolic links to `app`,`data` and `scripts` folder.

## For Linux/MacOS users

If you are on Linux/MacOS, it should work without any extra settings to deploy on Azure Container Apps. Please use:

```bash
cd aca-host
azd up
```

## For Windows users
Because Windows [doesn't enable symbolic links by default](https://stackoverflow.com/questions/5917249/git-symbolic-links-in-windows), you may need to enable [Developer Mode](https://learn.microsoft.com/en-us/windows/apps/get-started/enable-your-device-for-development),
and symlinks for git before cloning this repo.

Because Windows [doesn't enable symbolic links by default](https://stackoverflow.com/questions/5917249/git-symbolic-links-in-windows), you may need to enable [Developer Mode](https://learn.microsoft.com/en-us/windows/apps/get-started/enable-your-device-for-development) and symlinks for git before cloning this repo.

Check failure on line 16 in docs/azure_container_apps.md

View workflow job for this annotation

GitHub Actions / Check for Markdown linting errors

Trailing spaces [Expected: 0 or 2; Actual: 1]

Check failure on line 16 in docs/azure_container_apps.md

View workflow job for this annotation

GitHub Actions / Check URLs Don't Have Locale

File docs/azure_container_apps.md, line 16, Link https://learn.microsoft.com/en-us/windows/apps/get-started/enable-your-device-for-development has locale.
To enable symlinks for git, please use

```bash
# local setting
git config core.symlinks true
Expand All @@ -18,7 +24,8 @@ git config --global core.symlinks true
```

Please check whether the symlink works correctly and then run:

```bash
cd aca-host
azd up
```
```

0 comments on commit 950018b

Please sign in to comment.