feat(103-fabric-sql-database): add new example

[yadongyaly]

📥 Pull Request

❓ What are you trying to address

Add an example of fabric-sql-database

✨ Description of new changes

• Write a detailed description of all changes and, if appropriate, why they are needed.

☑️ PR Checklist

• Link to the issue you are addressing is included above
• Ensure the PR description clearly describes the feature you're adding and any known limitations

[yadongyaly]

Hi @DariuszPorowski , I am from sql database in Farbic team. May I ask the procedures of getting this PR merged?

[DariuszPorowski]

Hi @yadongyaly

Overall, the code looks good. I do not only understand what you want to highlight in this quick-start?

The core concept of the quick starts is to provide code examples/samples for unobvious cases - which do not necessarily work independently or require additional involvement (i.e. integration with Azure of 3rd parties, etc.)

Additionally, examples should be as simple as possible without forcing users to use one or another auth method, unless the sample is about authentication method itself.

@OrBaubergMicrosoft @badeamarjieh @PabloZaiden thoughts?

[DariuszPorowski]

Hi @yadongyaly

Make sure the PR workflow is green, before I jump to the deeper review, thanks!

[yadongyaly]

Hi @yadongyaly

Make sure the PR workflow is green, before I jump to the deeper review, thanks!

Hi @DariuszPorowski

I have tried many times, and I have even created a new readme file by copying from other examples. The check always failed here :

I cannot find any helpful solution online, can you please advise?

[DariuszPorowski]

Hi @yadongyaly

README.md is an auto-generated file. Just run task docs and commit. The PR workflow highlights what to do :)

All developer tools are part of Dev Container attached to this repo. If you do not use Dev Container / Code spaces pls make sure you have task cli on your computer: https://taskfile.dev/installation/

Then the flow will be:

• run task tools to make sure all required tools are present
• run task docs to generate, lint and validate auto-generated code
• commit

[DariuszPorowski]

missing description

[yadongyaly]

Hi @yadongyaly

README.md is an auto-generated file. Just run task docs and commit. The PR workflow highlights what to do :)

All developer tools are part of Dev Container attached to this repo. If you do not use Dev Container / Code spaces pls make sure you have task cli on your computer: https://taskfile.dev/installation/

Then the flow will be:

• run task tools to make sure all required tools are present
• run task docs to generate, lint and validate auto-generated code
• commit

Right, I tried "task" command but my local does not have this command. I searched it online, did not get much information about it either. You mentioned PR flow, where I can get the "contribution instructions" or "developer instructions" in this repo? It really troubles me a lot to understand how to solve the PR build failed. First time to know the readme file is auto-generated by command. What files decide the readme file? task tools and task docs will only auto-generate the readme file, or there are others?

[DariuszPorowski]

@yadongyaly

"contribution instructions" or "developer instructions" do not exist yet, it will be added soon.

taskfile its just runner like makefile, but cross-platform

I suggest you use dev container which has all the necessary tools in it.

task docs runs terraform-docs tool (https://terraform-docs.io) with predefined config, etc on each module in this repo to make sure documentation is up-to-date and consistent.

fabric-terraform-quickstart/.taskfiles/terraform.yml

Line 97 in 59842e4

cmd: terraform-docs -c ./.terraform-docs.yml "{{clean .ITEM}}"

[yadongyaly]

@yadongyaly

"contribution instructions" or "developer instructions" do not exist yet, it will be added soon.

taskfile its just runner like makefile, but cross-platform

I suggest you use dev container which has all the necessary tools in it.

task docs runs terraform-docs tool (https://terraform-docs.io) with predefined config, etc on each module in this repo to make sure documentation is up-to-date and consistent.

fabric-terraform-quickstart/.taskfiles/terraform.yml

Line 97 in 59842e4

cmd: terraform-docs -c ./.terraform-docs.yml "{{clean .ITEM}}"

Hi @DariuszPorowski
thanks for providing instructions on "task" commands. Finally I got all checks passed, please review

[DariuszPorowski]

LGTM

[DariuszPorowski]

@OrBaubergMicrosoft @badeamarjieh PTAL and sync with Eva/Chen about idea/purpose of single resource example

[DariuszPorowski]

@yadongyaly actually this is not 200 level, may you change to 100, in this case it will be 103-fabric-sql-database

[yadongyaly]

@yadongyaly actually this is not 200 level, may you change to 100, in this case it will be 103-fabric-sql-database

Hi @DariuszPorowski
After I chanaged the folder name to be 103, the "task docs" keeps giving me weird results. It changes all other readMe files.

Anything else required to be changed for 103 renaming?

[DariuszPorowski]

@yadongyaly I believe the issue is with line ending if you run on windows machine. Currently repo is not Windows-friendly. Primary focus is macOS/Linux.

[yadongyaly]

@yadongyaly I believe the issue is with line ending if you run on windows machine. Currently repo is not Windows-friendly. Primary focus is macOS/Linux.
Hi @DariuszPorowski
I was able to make "task docs" command pass finally. It turns out I need to run task tool firslty to update something. Right now the PR checks fails at task lint. This does not seem to be related my changes?

[DariuszPorowski]

@yadongyaly do not worry about it today. The repo is still in the early stage of the setup.