Skip to content

Commit 0291ac6

Browse files
author
Mike Swantek
committed
updates to documentation, aligning all folders and files to lower case naming
1 parent cd1948f commit 0291ac6

14 files changed

Lines changed: 171 additions & 260 deletions

CHANGELOG.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -47,28 +47,28 @@ All notable changes to this project will be documented in this file.
4747
- OneLake indexing pipeline connecting Fabric lakehouses to AI Search
4848
- Comprehensive post-provision automation (22 hooks for Fabric/Purview/Search setup)
4949
- New documentation: `deploy_app_from_foundry.md` for publishing apps from Microsoft Foundry
50-
- New documentation: `TRANSPARENCY_FAQ.md` for responsible AI transparency
50+
- New documentation: `transparency_faq.md` for responsible AI transparency
5151
- New documentation: `NewUserGuide.md` for first-time users
5252
- Header icons matching GSA standard format
5353
- Fabric private networking documentation
5454

5555
### Changed
5656
- README.md restructured to match Microsoft GSA (Global Solution Accelerator) format
57-
- DeploymentGuide.md consolidated with all deployment options in one place
57+
- deploymentguide.md consolidated with all deployment options in one place
5858
- Updated Azure Fabric CLI commands (`az fabric capacity` replaces deprecated `az powerbi embedded-capacity`)
5959
- Post-provision scripts now validate Fabric capacity state before execution
6060
- Navigation links use pipe separators matching other GSA repos
6161

6262
### Removed
6363
- `github_actions_steps.md` (stub placeholder)
64-
- `github_code_spaces_steps.md` (consolidated into DeploymentGuide.md)
65-
- `local_environment_steps.md` (consolidated into DeploymentGuide.md)
66-
- `Dev_ContainerSteps.md` (consolidated into DeploymentGuide.md)
64+
- `github_code_spaces_steps.md` (consolidated into deploymentguide.md)
65+
- `local_environment_steps.md` (consolidated into deploymentguide.md)
66+
- `Dev_ContainerSteps.md` (consolidated into deploymentguide.md)
6767
- `transfer_project_connections.md` (feature deprecated)
6868
- `sample_app_setup.md` (replaced with `deploy_app_from_foundry.md`)
6969
- `Verify_Services_On_Network.md` (referenced non-existent script)
70-
- `add_additional_services.md` (outdated, redundant with PARAMETER_GUIDE.md)
71-
- `modify_deployed_models.md` (outdated, redundant with PARAMETER_GUIDE.md)
70+
- `add_additional_services.md` (outdated, redundant with parameter_guide.md)
71+
- `modify_deployed_models.md` (outdated, redundant with parameter_guide.md)
7272

7373
## [1.2] - 2025-05-13
7474
### Added

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ For the first attempt, the lowest-risk path is to keep Fabric and Purview disabl
7171
|------|------------------|
7272
| Fastest realistic validation | Local `azd up` workflow |
7373
| Clean environment with fewer local setup issues | GitHub Codespaces |
74-
| Deep customization before deploy | Read [docs/PARAMETER_GUIDE.md](./docs/PARAMETER_GUIDE.md) first |
74+
| Deep customization before deploy | Read [docs/parameter_guide.md](./docs/parameter_guide.md) first |
7575
| Lowest-risk first run | Disable Fabric and Purview, then re-enable later |
7676

7777
### How to Install or Deploy
@@ -80,7 +80,7 @@ Follow the deployment guide to deploy this solution to your own Azure subscripti
8080

8181
> **Note:** This solution accelerator requires **Azure Developer CLI (azd) version 1.15.0 or higher**. [Download azd here](https://learn.microsoft.com/en-us/azure/developer/azure-developer-cli/install-azd).
8282
83-
[**📘 Click here to launch the Deployment Guide**](./docs/DeploymentGuide.md)
83+
[**📘 Click here to launch the Deployment Guide**](./docs/deploymentguide.md)
8484

8585
<br/>
8686

@@ -270,20 +270,20 @@ Supporting documentation
270270
271271
| Document | Description |
272272
|----------|-------------|
273-
| [Deployment Guide](./docs/DeploymentGuide.md) | Complete deployment instructions |
273+
| [Deployment Guide](./docs/deploymentguide.md) | Complete deployment instructions |
274274
| [Post Deployment Steps](./docs/post_deployment_steps.md) | Verify your deployment |
275275
| [PostgreSQL Mirroring](./docs/postgresql_mirroring.md) | Automate or troubleshoot the Fabric connection and PostgreSQL mirror flow |
276-
| [Parameter Guide](./docs/PARAMETER_GUIDE.md) | Configure deployment parameters |
276+
| [Parameter Guide](./docs/parameter_guide.md) | Configure deployment parameters |
277277
| [Quota Check Guide](./docs/quota_check.md) | Check Azure OpenAI quota availability |
278278
279279
### Customization & Operations
280280
281281
| Document | Description |
282282
|----------|-------------|
283-
| [Required Roles & Scopes](./docs/Required_roles_scopes_resources.md) | IAM requirements for deployment |
284-
| [Parameter Guide](./docs/PARAMETER_GUIDE.md) | All deployment parameters, toggles & model configs |
283+
| [Required Roles & Scopes](./docs/required_roles_scopes_resources.md) | IAM requirements for deployment |
284+
| [Parameter Guide](./docs/parameter_guide.md) | All deployment parameters, toggles & model configs |
285285
| [Deploy App from Foundry](./docs/deploy_app_from_foundry.md) | Publish playground to App Service |
286-
| [Accessing Private Resources](./docs/ACCESSING_PRIVATE_RESOURCES.md) | Connect via Jump VM |
286+
| [Accessing Private Resources](./docs/accessing_private_resources.md) | Connect via Jump VM |
287287
288288
### Security Guidelines
289289
@@ -314,7 +314,7 @@ Have questions, found a bug, or want to request a feature? [Submit a new issue](
314314
315315
## Responsible AI Transparency FAQ
316316
317-
Please refer to [Transparency FAQ](./docs/TRANSPARENCY_FAQ.md) for responsible AI transparency details of this solution accelerator.
317+
Please refer to [Transparency FAQ](./docs/transparency_faq.md) for responsible AI transparency details of this solution accelerator.
318318
319319
<br/>
320320

docs/Required_roles_scopes_resources.md

Lines changed: 0 additions & 26 deletions
This file was deleted.

0 commit comments

Comments
 (0)