[DOCS] Add scarf to readme and docs for website analytics

[cmarteepants]

This adds a privacy notice and website analytics to the Cosmos readme and auto-generated docs.

Note that while you cannot explicitly opt out of website analytics for the publicly hosted readme (and docs), Scarf respects browser DND. If that is set via the browser, telemetry for that user will not be sent to Scarf.

Scarf privacy policy: https://about.scarf.sh/privacy-policy
Astronomer privacy policy: https://www.astronomer.io/privacy/

[netlify]

✅ Deploy Preview for sunny-pastelito-5ecb04 ready!

Name	Link
🔨 Latest commit	edeea98
🔍 Latest deploy log	https://app.netlify.com/sites/sunny-pastelito-5ecb04/deploys/66f43d4a363c80000885669d
😎 Deploy Preview	https://deploy-preview-1221--sunny-pastelito-5ecb04.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[cmarteepants]

@pankajkoti or @tatiana - I'm going to need some help. I'm not sure why no changes were detected for the docs, and why it didn't successfully build. When I ran hatch run docs:serve locally, they compiled properly

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.72%. Comparing base (3414513) to head (edeea98).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #1221   +/-   ##
=======================================
  Coverage   95.72%   95.72%           
=======================================
  Files          64       64           
  Lines        3672     3672           
=======================================
  Hits         3515     3515           
  Misses        157      157           

Flag	Coverage Δ
	95.72% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[tatiana]

@pankajkoti or @tatiana - I'm going to need some help. I'm not sure why no changes were detected for the docs, and why it didn't successfully build. When I ran hatch run docs:serve locally, they compiled properly

I believe the change worked and when we render the Restructured Text in Github, it also works:
https://github.com/astronomer/astronomer-cosmos/pull/1221/files?short_path=7b3ed02#diff-7b3ed02bc73dc06b7db906cf97aa91dec2b2eb21f2d92bc5caa761df5bbc168f

The warning you're receiving is probably due to the Netlify configuration:
https://docs.netlify.com/configure-builds/file-based-configuration/#ignore-builds

They are only used for validating the docs and do not affect our current docs deployment. Either we can do something about the Netlify config ^ or we can merge this without viewing changes in Netlify. I'm happy either way.

Waiting for others thoughts before merging.

[pankajkoti]

I'm not sure why no changes were detected for the docs, and why it didn't successfully build. When I ran hatch run docs:serve locally, they compiled properly

@tatiana I am guessing Constance is referring to add that to our public Cosmos docs, too? Just a guess :).

And if the above guess is correct, @cmarteepants, although the current change in the PR suffices for our GitHub README.rst, if we would also like to introduce that to our public Cosmos docs, you would need to introduce the same changes in docs folder which is what the hatch run docs:serve refers to (and hence also Netlify). Probably, you could add the same in https://github.com/astronomer/astronomer-cosmos/blob/main/docs/index.rst for hatch/Netlify to detect changes & also reflect on our Cosmos public docs.

[tatiana]

Very true, @pankajkoti ! It would be great if we removed this redundancy between README.md and index.rst - but this may be part of the general improve the docs ticket. I remember Constance mentioning she wanted us to improve the overall docs, so I just logged a ticket so we don't lose track of these: #1225

[cmarteepants]

Thanks for the information, I'll add it there and submit the commit