Skip to content

Commit 9005034

Browse files
committed
Add usage guide images and update documentation
Added light and dark mode images for login, domain, target URL, and vanity URL to the assets folder. Updated the Usage Guide to include visual references and expanded instructions for logging in, domain association, target and vanity URLs, and QR code actions. Improved Getting Started instructions with a code block for resource group creation.
1 parent 5d76a27 commit 9005034

File tree

10 files changed

+28
-2
lines changed

10 files changed

+28
-2
lines changed

docs/URL-Shortener/Getting-Started.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,14 @@ If you want to set this up on-prem or in a different environment, please refer t
1313
1. Navigate to `./infrastructureTemplates` folder in the terminal.
1414
2. Issue the bicep template build command: `bicep build .\urlShortener.bicep`
1515

16-
Note: Whenever you issue the bicep build command against the bicep template it will compile it into an ARM template which is the language that Azure speaks. Azure does not support bicep natively
16+
Note: Whenever you issue the bicep build command against the bicep template it will compile it into an ARM template which is the language that Azure speaks. Azure does not support bicep natively.
1717

1818
3. Ensure that you are logged into your Azure tenant and select your subscription.
19-
4. Make a new Azure resource group with the naming and location convention through the CLI: `New-AzResourceGroup -Name Host -Location EastUs2`
19+
4. Make a new Azure resource group with the naming and location convention through the CLI:
20+
21+
```powershell
22+
New-AzResourceGroup -Name Host -Location EastUs2
23+
```
2024
2125
Note: Resource group has to be created before deployment.
2226

docs/URL-Shortener/Usage-Guide.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,25 @@
11
# Usage Guide
22

33
This guide explains how to operate SUS once it's been deployed. It covers core infrastructure deployment, device and user lifecycle management, and links to detailed task-level workflows.
4+
5+
Log into your associated Azure Account on the top right corner.
6+
7+
![LogIn](../assets/Login-Light.png#only-light){ loading=lazy }
8+
![LogIn](../assets/Login-Dark.png#only-dark){ loading=lazy }
9+
10+
In the dropdown, the domain name will be associated with the domain that was created on the server. For the purpose of this guide, the domain name is pointing to url.shilab.com.
11+
12+
![Domain](../assets/DomainUrl-Light.png#only-light){ loading=lazy }
13+
![Domain](../assets/DomainUrl-Dark.png#only-dark){ loading=lazy }
14+
15+
The target URL is the the full destination address that the vanity URL redirects to. It represents the actual location of the content or resource, such as a website, document, or application.
16+
17+
![Target](../assets/TargetUrl-Light.png#only-light){ loading=lazy }
18+
![Target](../assets/TargetUrl-Dark.png#only-dark){ loading=lazy }
19+
20+
The vanity URL is the customizable, human-readable identifier used to create a short, memorable link that redirects to a longer or more complex destination URL.
21+
22+
![Vanity](../assets/VanityUrl-Light.png#only-light){ loading=lazy }
23+
![Vanity](../assets/VanityUrl-Dark.png#only-dark){ loading=lazy }
24+
25+
You can see the list of Vanity Names and the associated Destination. Under Action, you have the ability to view and track the QR code that was generated. It is a scannable code that encodes the vanity URL, allowing users to quickly access the target URL using a mobile device. It enhances accessibility and ease of sharing, especially in printed materials or presentations.
1.04 KB
Loading
1001 Bytes
Loading
3.11 KB
Loading
2.76 KB
Loading
837 Bytes
Loading
826 Bytes
Loading
814 Bytes
Loading
809 Bytes
Loading

0 commit comments

Comments
 (0)