diff --git a/.changes/unreleased/fixed-20240920-141301.yaml b/.changes/unreleased/fixed-20240920-141301.yaml new file mode 100644 index 00000000..5600637c --- /dev/null +++ b/.changes/unreleased/fixed-20240920-141301.yaml @@ -0,0 +1,5 @@ +kind: fixed +body: Docs rendering and links +time: 2024-09-20T14:13:01.0353796-07:00 +custom: + Issue: "7" diff --git a/.changes/unreleased/fixed-20240920-141400.yaml b/.changes/unreleased/fixed-20240920-141400.yaml new file mode 100644 index 00000000..1542d8cb --- /dev/null +++ b/.changes/unreleased/fixed-20240920-141400.yaml @@ -0,0 +1,5 @@ +kind: fixed +body: Unnecessary sbom json in the release assets +time: 2024-09-20T14:14:00.4673888-07:00 +custom: + Issue: "7" diff --git a/.goreleaser.yml b/.goreleaser.yml index 8220d4d5..1141b930 100644 --- a/.goreleaser.yml +++ b/.goreleaser.yml @@ -42,9 +42,6 @@ checksum: name_template: "{{ .ProjectName }}_{{ .Version }}_manifest.json" name_template: "{{ .ProjectName }}_{{ .Version }}_SHA256SUMS" -sboms: - - artifacts: archive - signs: - artifacts: checksum args: diff --git a/docs/.pages b/docs/.pages index 4d411075..2d5b740b 100644 --- a/docs/.pages +++ b/docs/.pages @@ -2,7 +2,6 @@ nav: - fabric provider: index.md - Guides: guides - - Authentication: auth - Functions: functions - Resources: resources - Data Sources: data-sources diff --git a/docs/auth/auth_app_reg_spn.md b/docs/guides/auth_app_reg_spn.md similarity index 100% rename from docs/auth/auth_app_reg_spn.md rename to docs/guides/auth_app_reg_spn.md diff --git a/docs/auth/auth_app_reg_user.md b/docs/guides/auth_app_reg_user.md similarity index 100% rename from docs/auth/auth_app_reg_user.md rename to docs/guides/auth_app_reg_user.md diff --git a/docs/auth/auth_msi.md b/docs/guides/auth_msi.md similarity index 100% rename from docs/auth/auth_msi.md rename to docs/guides/auth_msi.md diff --git a/docs/auth/auth_spn_cert.md b/docs/guides/auth_spn_cert.md similarity index 100% rename from docs/auth/auth_spn_cert.md rename to docs/guides/auth_spn_cert.md diff --git a/docs/auth/auth_spn_oidc.md b/docs/guides/auth_spn_oidc.md similarity index 100% rename from docs/auth/auth_spn_oidc.md rename to docs/guides/auth_spn_oidc.md diff --git a/docs/auth/auth_spn_secret.md b/docs/guides/auth_spn_secret.md similarity index 100% rename from docs/auth/auth_spn_secret.md rename to docs/guides/auth_spn_secret.md diff --git a/docs/index.md b/docs/index.md index 5152a69f..c7fc282c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -61,16 +61,16 @@ The provider allows authentication via service principal or user credentials. Al The Fabric provider can use the Azure CLI to authenticate. If you have the Azure CLI installed, you can use it to log in to your Azure account and the Fabric provider will use the credentials from the Azure CLI. 1. [Install the Azure CLI](https://learn.microsoft.com/cli/azure/install-azure-cli) -1. Follow the [Creating an App Registration for the User context to use with Azure CLI](./auth/auth_app_reg_user.md) guide. +1. Follow the [Creating an App Registration for the User context to use with Azure CLI](./guides/auth_app_reg_user.md) guide. ### Using a Service Principal You can find more information on how to do this in the following guides: -- [Authenticating using Managed Identity (MSI)](./auth/auth_msi.md) -- [Authenticating using a Service Principal and OpenID Connect (OIDC)](./auth/auth_spn_oidc.md) -- [Authenticating using a Service Principal and Client Certificate](./auth/auth_spn_cert.md) -- [Authenticating using a Service Principal and Client Secret](./auth/auth_spn_secret.md) +- [Authenticating using Managed Identity (MSI)](./guides/auth_msi.md) +- [Authenticating using a Service Principal and OpenID Connect (OIDC)](./guides/auth_spn_oidc.md) +- [Authenticating using a Service Principal and Client Certificate](./guides/auth_spn_cert.md) +- [Authenticating using a Service Principal and Client Secret](./guides/auth_spn_secret.md) ## Schema @@ -106,8 +106,8 @@ You can find more information on how to do this in the following guides: ## Know limitations - **Capacity**: [Microsoft Fabric trial capacity](https://learn.microsoft.com/fabric/get-started/fabric-trial) is not supported. Only self-provisioned [Fabric Capacity](https://learn.microsoft.com/fabric/enterprise/plan-capacity) on Azure is supported. You can setup your capacity in the [Azure Portal](https://portal.azure.com/#browse/Microsoft.Fabric%2Fcapacities). -- **Service Principal**: Not all Fabric resources support Service Principals yet. For Provider evaluation, we recommend using the [Azure CLI for authentication with User context](./auth/auth_app_reg_user.md). +- **Service Principal**: Not all Fabric resources support Service Principals yet. For Provider evaluation, we recommend using the [Azure CLI for authentication with User context](./guides/auth_app_reg_user.md). ## Contributing -Contributions to this provider are always welcome! Please see the [Contribution Guidelines](https://github.com/microsoft/terraform-provider-fabric/) +This project welcomes feedback and suggestions only via GitHub Issues. Pull Request (PR) contributions will **NOT** be accepted at this time. Please see the [Contribution Guidelines](https://github.com/microsoft/terraform-provider-fabric/) diff --git a/templates/auth/auth_app_reg_spn.md.tmpl b/templates/guides/auth_app_reg_spn.md.tmpl similarity index 100% rename from templates/auth/auth_app_reg_spn.md.tmpl rename to templates/guides/auth_app_reg_spn.md.tmpl diff --git a/templates/auth/auth_app_reg_user.md.tmpl b/templates/guides/auth_app_reg_user.md.tmpl similarity index 100% rename from templates/auth/auth_app_reg_user.md.tmpl rename to templates/guides/auth_app_reg_user.md.tmpl diff --git a/templates/auth/auth_msi.md.tmpl b/templates/guides/auth_msi.md.tmpl similarity index 100% rename from templates/auth/auth_msi.md.tmpl rename to templates/guides/auth_msi.md.tmpl diff --git a/templates/auth/auth_spn_cert.md.tmpl b/templates/guides/auth_spn_cert.md.tmpl similarity index 100% rename from templates/auth/auth_spn_cert.md.tmpl rename to templates/guides/auth_spn_cert.md.tmpl diff --git a/templates/auth/auth_spn_oidc.md.tmpl b/templates/guides/auth_spn_oidc.md.tmpl similarity index 100% rename from templates/auth/auth_spn_oidc.md.tmpl rename to templates/guides/auth_spn_oidc.md.tmpl diff --git a/templates/auth/auth_spn_secret.md.tmpl b/templates/guides/auth_spn_secret.md.tmpl similarity index 100% rename from templates/auth/auth_spn_secret.md.tmpl rename to templates/guides/auth_spn_secret.md.tmpl diff --git a/templates/index.md.tmpl b/templates/index.md.tmpl index 07034284..2ead4d38 100644 --- a/templates/index.md.tmpl +++ b/templates/index.md.tmpl @@ -37,24 +37,24 @@ The provider allows authentication via service principal or user credentials. Al The {{ title .ProviderShortName }} provider can use the Azure CLI to authenticate. If you have the Azure CLI installed, you can use it to log in to your Azure account and the {{ title .ProviderShortName }} provider will use the credentials from the Azure CLI. 1. [Install the Azure CLI](https://learn.microsoft.com/cli/azure/install-azure-cli) -1. Follow the [Creating an App Registration for the User context to use with Azure CLI](./auth/auth_app_reg_user.md) guide. +1. Follow the [Creating an App Registration for the User context to use with Azure CLI](./guides/auth_app_reg_user.md) guide. ### Using a Service Principal You can find more information on how to do this in the following guides: -- [Authenticating using Managed Identity (MSI)](./auth/auth_msi.md) -- [Authenticating using a Service Principal and OpenID Connect (OIDC)](./auth/auth_spn_oidc.md) -- [Authenticating using a Service Principal and Client Certificate](./auth/auth_spn_cert.md) -- [Authenticating using a Service Principal and Client Secret](./auth/auth_spn_secret.md) +- [Authenticating using Managed Identity (MSI)](./guides/auth_msi.md) +- [Authenticating using a Service Principal and OpenID Connect (OIDC)](./guides/auth_spn_oidc.md) +- [Authenticating using a Service Principal and Client Certificate](./guides/auth_spn_cert.md) +- [Authenticating using a Service Principal and Client Secret](./guides/auth_spn_secret.md) {{ .SchemaMarkdown | trimspace }} ## Know limitations - **Capacity**: [Microsoft Fabric trial capacity](https://learn.microsoft.com/fabric/get-started/fabric-trial) is not supported. Only self-provisioned [Fabric Capacity](https://learn.microsoft.com/fabric/enterprise/plan-capacity) on Azure is supported. You can setup your capacity in the [Azure Portal](https://portal.azure.com/#browse/Microsoft.Fabric%2Fcapacities). -- **Service Principal**: Not all Fabric resources support Service Principals yet. For Provider evaluation, we recommend using the [Azure CLI for authentication with User context](./auth/auth_app_reg_user.md). +- **Service Principal**: Not all Fabric resources support Service Principals yet. For Provider evaluation, we recommend using the [Azure CLI for authentication with User context](./guides/auth_app_reg_user.md). ## Contributing -Contributions to this provider are always welcome! Please see the [Contribution Guidelines](https://github.com/microsoft/{{ .ProviderName }}/) +This project welcomes feedback and suggestions only via GitHub Issues. Pull Request (PR) contributions will **NOT** be accepted at this time. Please see the [Contribution Guidelines](https://github.com/microsoft/{{ .ProviderName }}/)