Skip to content

Commit 8ba92c0

Browse files
authored
docs: modified links in the readme files. (#487)
* docs: modified links in the readme file. Links redirecting to "login", "init", "start", "deploy" from Readme are not working * Update swa-build.md * Update swa-config.md * Update swa-deploy.md * Update swa-login.md * Update swa-start.md * Update swa.md * Update 1-install.md * Update 2-emulator.md * Update intro.md
1 parent 1b8bac8 commit 8ba92c0

File tree

10 files changed

+43
-43
lines changed

10 files changed

+43
-43
lines changed

docs/www/docs/cli/swa-build.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,6 @@ swa build myApp
6262

6363
## See Also
6464

65-
- [swa](docs/cli/swa) - The Static Web Apps CLI
66-
- [swa start](swa-start)
67-
- [swa deploy](swa-deploy)
65+
- [swa](https://azure.github.io/static-web-apps-cli/docs/cli/swa) - The Static Web Apps CLI
66+
- [swa start](https://azure.github.io/static-web-apps-cli/docs/cli/swa-start)
67+
- [swa deploy](https://azure.github.io/static-web-apps-cli/docs/cli/swa-deploy)

docs/www/docs/cli/swa-config.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -105,9 +105,9 @@ The `swa-cli.config.json` file can be validated against the following schema: ht
105105

106106
## See Also
107107

108-
- [swa](docs/cli/swa) - The Static Web Apps CLI
109-
- [swa-init](docs/cli/swa-init)
110-
- [swa-start](docs/cli/swa-start)
108+
- [swa](https://azure.github.io/static-web-apps-cli/docs/cli/swa) - The Static Web Apps CLI
109+
- [swa-init](https://azure.github.io/static-web-apps-cli/docs/cli/swa-init)
110+
- [swa-start](https://azure.github.io/static-web-apps-cli/docs/cli/swa-start)
111111

112112
<!--
113113
## Configuration File

docs/www/docs/cli/swa-deploy.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Don't store the deployment token in a public repository. It should be kept secre
4545

4646
You can deploy a front-end application (without an API) to Azure Static Web Apps by running the following steps:
4747

48-
1. If your front-end application requires a build step, run [`swa build`](swa-build) or refer to your application build instructions.
48+
1. If your front-end application requires a build step, run [`swa build`](https://azure.github.io/static-web-apps-cli/docs/cli/swa-build) or refer to your application build instructions.
4949

5050
**Option 1:** From build folder you would like to deploy, run the deploy command:
5151

@@ -58,7 +58,7 @@ swa deploy
5858
5959
**Option 2:** You can also deploy a specific folder:
6060

61-
1. If your front-end application requires a build step, run [`swa build`](swa-build) or refer to your application build instructions.
61+
1. If your front-end application requires a build step, run [`swa build`](https://azure.github.io/static-web-apps-cli/docs/cli/swa-build) or refer to your application build instructions.
6262

6363
2. Deploy your app:
6464

@@ -70,7 +70,7 @@ swa deploy ./my-dist
7070

7171
To deploy both the front-end app and an API to Azure Static Web Apps, use the following steps:
7272

73-
1. If your front-end application requires a build step, run [`swa build`](swa-build) or refer to your application build instructions.
73+
1. If your front-end application requires a build step, run [`swa build`](https://azure.github.io/static-web-apps-cli/docs/cli/swa-build) or refer to your application build instructions.
7474

7575
2. Make sure the[ API language runtime version](https://docs.microsoft.com/en-us/azure/static-web-apps/configuration#platform) in the `staticwebapp.config.json` file is set correctly, for example:
7676

@@ -132,7 +132,7 @@ If you are using a [`swa-cli.config.json`](#swa-cli.config.json) configuration f
132132

133133
Then you can deploy your application by running the following steps:
134134

135-
1. If your front-end application requires a build step, run [`swa build`](swa-build) or refer to your application build instructions.
135+
1. If your front-end application requires a build step, run [`swa build`](https://azure.github.io/static-web-apps-cli/docs/cli/swa-build) or refer to your application build instructions.
136136

137137
2. Deploy your app:
138138

@@ -204,6 +204,6 @@ swa deploy --env production
204204

205205
## See Also
206206

207-
- [swa](docs/cli/swa)
208-
- [swa login](swa-login)
209-
- [Environment Variables](env-vars)
207+
- [swa](https://azure.github.io/static-web-apps-cli/docs/cli/swa)
208+
- [swa login](https://azure.github.io/static-web-apps-cli/docs/cli/swa-login)
209+
- [Environment Variables](https://azure.github.io/static-web-apps-cli/docs/cli/env-vars)

docs/www/docs/cli/swa-login.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ swa login [options]
1313

1414
Used to login to Azure.
1515

16-
This command is used to authenticate with Azure and get a deployment token that can be used to deploy to Azure Static Web Apps, using the [`swa deploy`](swa-deploy) command.
16+
This command is used to authenticate with Azure and get a deployment token that can be used to deploy to Azure Static Web Apps, using the [`swa deploy`](https://azure.github.io/static-web-apps-cli/docs/cli/swa-deploy) command.
1717

1818
## Options
1919

@@ -68,5 +68,5 @@ swa login --tenant-id 00000000-0000-0000-0000-000000000000 \
6868

6969
## See Also
7070

71-
- [swa deploy](docs/cli/swa-deploy)
72-
- [swa](docs/cli/swa)
71+
- [swa deploy](https://azure.github.io/static-web-apps-cli/docs/cli/swa-deploy)
72+
- [swa](https://azure.github.io/static-web-apps-cli/docs/cli/swa)

docs/www/docs/cli/swa-start.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -162,4 +162,4 @@ swa start http://localhost:3000 --api-location http://localhost:7071
162162

163163
## See Also
164164

165-
- [swa](docs/cli/swa) - The Static Web Apps CLI
165+
- [swa](https://azure.github.io/static-web-apps-cli/docs/cli/swa) - The Static Web Apps CLI

docs/www/docs/cli/swa.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -38,11 +38,11 @@ Here are global options that you can use with any command supported by the `swa`
3838

3939
Here are the currently supported `swa` commands. Use `swa <command> --help` to learn about options and usage for that particular command.
4040

41-
- [`login`](swa-login): login into Azure
42-
- [`init`](swa-init): initialize a new static web app project
43-
- [`start`](swa-start): start the emulator from a directory or bind to a dev server
44-
- [`deploy`](swa-deploy): deploy the current project to Azure Static Web Apps
45-
- [`build`](swa-build): build your project
41+
- [`login`](https://azure.github.io/static-web-apps-cli/docs/cli/swa-login): login into Azure
42+
- [`init`](https://azure.github.io/static-web-apps-cli/docs/cli/swa-init): initialize a new static web app project
43+
- [`start`](https://azure.github.io/static-web-apps-cli/docs/cli/swa-start): start the emulator from a directory or bind to a dev server
44+
- [`deploy`](https://azure.github.io/static-web-apps-cli/docs/cli/swa-deploy): deploy the current project to Azure Static Web Apps
45+
- [`build`](https://azure.github.io/static-web-apps-cli/docs/cli/swa-build): build your project
4646

4747
## Usage
4848

@@ -54,10 +54,10 @@ swa
5454

5555
## See Also
5656

57-
- [swa init](docs/cli/swa-init)
58-
- [swa build](docs/cli/swa-build)
59-
- [swa start](docs/cli/swa-start)
60-
- [swa login](docs/cli/swa-login)
61-
- [swa deploy](docs/cli/swa-deploy)
62-
- [Configuring CLI](docs/cli/swa-config) - file location, defaults
63-
- [Environment Vars](docs/cli/swa-deploy) - supported settings
57+
- [swa init](https://azure.github.io/static-web-apps-cli/docs/cli/swa-init)
58+
- [swa build](https://azure.github.io/static-web-apps-cli/docs/cli/swa-build)
59+
- [swa start](https://azure.github.io/static-web-apps-cli/docs/cli/swa-start)
60+
- [swa login](https://azure.github.io/static-web-apps-cli/docs/cli/swa-login)
61+
- [swa deploy](https://azure.github.io/static-web-apps-cli/docs/cli/swa-deploy)
62+
- [Configuring CLI](https://azure.github.io/static-web-apps-cli/docs/cli/swa-config) - file location, defaults
63+
- [Environment Vars](https://azure.github.io/static-web-apps-cli/docs/cli/swa-deploy) - supported settings

docs/www/docs/intro.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ sidebar_position: 1
77
The **Static Web Apps (SWA) CLI** is an open-source commandline tool that streamlines local development and deployment for Azure Static Web Apps.
88

99
- Find it on npm: [@azure/static-web-apps-cli](https://www.npmjs.com/package/@azure/static-web-apps-cli)
10-
- Get Started: [Install the SWA CLI](docs/use/install)
11-
- Contribute: [Build from Source](docs/contribute/developer)
10+
- Get Started: [Install the SWA CLI](https://azure.github.io/static-web-apps-cli/docs/use/install)
11+
- Contribute: [Build from Source](https://azure.github.io/static-web-apps-cli/docs/contribute/developer)
1212

1313
[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/azure/static-web-apps-cli/issues)
1414

docs/www/docs/use/1-install.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -44,17 +44,17 @@ swa
4444

4545
It will generate a configuration for you, then build your project and ask if you want to deploy it to Azure.
4646

47-
See [swa](../cli/swa) for more details.
47+
See [swa](https://azure.github.io/static-web-apps-cli/docs/cli/swa) for more details.
4848

4949
## Extended usage
5050

5151
Here are the currently supported `swa` commands. Use `swa <command> --help` to learn about options and usage for that particular command.
5252

53-
- [`login`](../cli/swa-login): login into Azure
54-
- [`init`](../cli/swa-init): initialize a new static web app project
55-
- [`start`](../cli/swa-start): start the emulator from a directory or bind to a dev server
56-
- [`deploy`](../cli/swa-deploy): deploy the current project to Azure Static Web Apps
57-
- [`build`](../cli/swa-build): build your project
53+
- [`login`](https://azure.github.io/static-web-apps-cli/docs/cli/swa-login): login into Azure
54+
- [`init`](https://azure.github.io/static-web-apps-cli/docs/cli/swa-init): initialize a new static web app project
55+
- [`start`](https://azure.github.io/static-web-apps-cli/docs/cli/swa-start): start the emulator from a directory or bind to a dev server
56+
- [`deploy`](https://azure.github.io/static-web-apps-cli/docs/cli/swa-deploy): deploy the current project to Azure Static Web Apps
57+
- [`build`](https://azure.github.io/static-web-apps-cli/docs/cli/swa-build): build your project
5858

5959
## Run using npx
6060

docs/www/docs/use/2-emulator.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ sidebar_position: 3
77
The SWA Emulator is run by using the `swa start` command.
88

99
- It runs on `http://localhost:4280` by default.
10-
- Read the [docs](/docs/cli/swa-start) for more command details.
10+
- Read the [docs](https://azure.github.io/static-web-apps-cli/docs/cli/swa-start) for more command details.
1111

1212
## 2.1 Serve from current folder
1313

readme.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -52,11 +52,11 @@ See [swa](https://azure.github.io/static-web-apps-cli/) for more details.
5252

5353
Here are the currently supported `swa` commands. Use `swa <command> --help` to learn about options and usage for that particular command.
5454

55-
- [`login`](https://azure.github.io/static-web-apps-cli//cli/swa-login): login into Azure
56-
- [`init`](https://azure.github.io/static-web-apps-cli//cli/swa-init): initialize a new static web app project
57-
- [`start`](https://azure.github.io/static-web-apps-cli//cli/swa-start): start the emulator from a directory or bind to a dev server
58-
- [`deploy`](https://azure.github.io/static-web-apps-cli//cli/swa-deploy): deploy the current project to Azure Static Web Apps
59-
- [`build`](https://azure.github.io/static-web-apps-cli//cli/swa-build): build your project
55+
- [`login`](https://azure.github.io/static-web-apps-cli/docs/cli/swa-login): login into Azure
56+
- [`init`](https://azure.github.io/static-web-apps-cli/docs/cli/swa-init): initialize a new static web app project
57+
- [`start`](https://azure.github.io/static-web-apps-cli/docs/cli/swa-start): start the emulator from a directory or bind to a dev server
58+
- [`deploy`](https://azure.github.io/static-web-apps-cli/docs/cli/swa-deploy): deploy the current project to Azure Static Web Apps
59+
- [`build`](https://azure.github.io/static-web-apps-cli/docs/cli/swa-build): build your project
6060

6161
### Using `npx`:
6262

0 commit comments

Comments
 (0)