Skip to content

Conversation

@JelaniB-sec
Copy link
Contributor

@JelaniB-sec JelaniB-sec commented Oct 31, 2025

Server and user getting started guides.

Updated the Overview link in docs/index.md to include the .md extension, ensuring correct navigation to the documentation page.
Expanded the Getting Started guide with comprehensive steps for deploying the URL Shortener using Bicep templates on Azure. Instructions now cover resource group creation, template compilation, app registration, permissions, production build, packaging, web app deployment, database setup, environment variables, migration, and initial API usage. This update provides a complete walkthrough for new deployments.
Cleaned up leftover merge conflict markers and redundant lines in the URL Shortener Getting-Started documentation for clarity.
Copilot AI review requested due to automatic review settings October 31, 2025 00:05
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This pull request updates the URL Shortener documentation to include comprehensive deployment instructions and fixes a documentation link. The changes transform the Getting Started guide from a placeholder to a complete step-by-step deployment guide for the SUS (URL Shortener) application using Azure Bicep templates.

  • Added detailed 24-step deployment process covering Azure infrastructure setup, application configuration, and initial usage
  • Fixed documentation link to include .md extension for proper navigation
  • Expanded from minimal placeholder content to comprehensive deployment documentation

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.

File Description
docs/index.md Fixed link to include .md extension for proper documentation navigation
docs/URL-Shortener/Getting-Started.md Added comprehensive deployment instructions with 24 detailed steps covering Azure setup, configuration, and usage

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

JelaniB-sec and others added 6 commits October 31, 2025 13:54
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.
Replaces the existing DomainUrl-Dark.png image in the URL-Shortener documentation assets with a new version.
@socket-security
Copy link

socket-security bot commented Nov 1, 2025

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff Package Supply Chain
Security
Vulnerability Quality Maintenance License
Updatedmkdocs-glightbox@​0.5.1 ⏵ 0.5.2100100100100100
Updatedmkdocs-material@​9.6.22 ⏵ 9.6.23100 +9100100100100

View full report

@socket-security
Copy link

socket-security bot commented Nov 1, 2025

Warning

Review the following alerts detected in dependencies.

According to your organization's Security Policy, it is recommended to resolve "Warn" alerts. Learn more about Socket for GitHub.

Action Severity Alert  (click "▶" to expand/collapse)
Warn High
License policy violation: pypi mkdocs-glightbox under MIT

Location: Package overview

From: requirements.txtpypi/[email protected]

ℹ Read more on: This package | This alert | What is a license policy violation?

Next steps: Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at [email protected].

Suggestion: Find a package that does not violate your license policy or adjust your policy to allow this package's license.

Mark the package as acceptable risk. To ignore this alert only in this pull request, reply with the comment @SocketSecurity ignore pypi/[email protected]. You can also ignore all packages with @SocketSecurity ignore-all. To ignore an alert for all future pull requests, use Socket's Dashboard to change the triage state of this alert.

Warn High
License policy violation: pypi mkdocs-glightbox under MIT

Location: Package overview

From: ?pypi/[email protected]

ℹ Read more on: This package | This alert | What is a license policy violation?

Next steps: Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at [email protected].

Suggestion: Find a package that does not violate your license policy or adjust your policy to allow this package's license.

Mark the package as acceptable risk. To ignore this alert only in this pull request, reply with the comment @SocketSecurity ignore pypi/[email protected]. You can also ignore all packages with @SocketSecurity ignore-all. To ignore an alert for all future pull requests, use Socket's Dashboard to change the triage state of this alert.

View full report

Move the screenshots into an image folder.
Update the links to the images to use the correct folder path.
Fix file capitalization.
@elliot-huffman elliot-huffman changed the title Susdocs URL - Shortener - Guides Nov 1, 2025
Optimize size for web viewing.
Update wording to match setup process.
Copy link
Contributor

@elliot-huffman elliot-huffman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me!

@elliot-huffman elliot-huffman merged commit 5dab1bb into main Nov 2, 2025
5 checks passed
@elliot-huffman elliot-huffman deleted the susdocs branch November 2, 2025 02:02
@elliot-huffman
Copy link
Contributor

This was merged via squash commit because of the multiple copies of picture files, which are in binary format and would have bloated the repo size.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants