Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve main README.md #894

Open
6 tasks
promisinganuj opened this issue Nov 27, 2024 · 0 comments
Open
6 tasks

Improve main README.md #894

promisinganuj opened this issue Nov 27, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation e2e: fabric Related with E2E Fabric Sample P2 Normal Priority

Comments

@promisinganuj
Copy link
Contributor

This issue consolidates the feedback from the team around the documentation for this sample, especially the main README.md.

DoD

Update main README.md to:

  • Explain that for SP, FABRIC_CAPACITY_ADMINS requires the "Object ID" of the enterprise application associated with the app, not the "Object ID" of the app itself.

Image

Image

  • Fix the image alignment

Image

  • Make it clear that the "devcontainer" can be used for the deployment, and also that it's the recommended way. Perhaps, add instruction on how to use "devcontainer" like it's explained in Databricks parking sensors sample.

  • Improve the prerequisites section:

Image

Once that was mentioned in the pre requisites it would not need to be mentioned in the authentication, it could just be referred with a link to pre- requisites.

  • Add details about provider registrations for the subscriptions.

│ Error: MissingSubscriptionRegistration: The subscription is not registered to use namespace 'Microsoft.OperationalInsights'. See [https://aka.ms/rps-not-found](https://nam06.safelinks.protection.outlook.com/?url=https%3A%2F%2Faka.ms%2Frps-not-found&data=05%7C02%7Canujparashar%40microsoft.com%7C29f53c076ee742e0e39c08dd0e340fc9%7C72f988bf86f141af91ab2d7cd011db47%7C1%7C0%7C638682339021888003%7CUnknown%7CTWFpbGZsb3d8eyJFbXB0eU1hcGkiOnRydWUsIlYiOiIwLjAuMDAwMCIsIlAiOiJXaW4zMiIsIkFOIjoiTWFpbCIsIldUIjoyfQ%3D%3D%7C0%7C%7C%7C&sdata=FoKwH5UBGxHczDaH8UaWm7P8ygjSfxo5Lth%2FLUiKlgI%3D&reserved=0) for how to register subscriptions.”

  • Add more details to the variables, like a practical example and a screenshot:

```GIT_REPOSITORY_NAME, GIT_BRANCH_NAME, GIT_DIRECTORY_NAME ...`

@promisinganuj promisinganuj added e2e: fabric Related with E2E Fabric Sample P2 Normal Priority labels Nov 27, 2024
@promisinganuj promisinganuj added the documentation Improvements or additions to documentation label Nov 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation e2e: fabric Related with E2E Fabric Sample P2 Normal Priority
Projects
None yet
Development

No branches or pull requests

1 participant