chore: Add provisional docs for auth usage #109

sgrove · 2021-08-05T21:56:21Z

Adds documentation to the README on how to use Netlify Integration Auth in functions.

I have read the contribution guidelines.
The status checks are successful (continuous integration). Those can be seen below.
Add a note that this functionality is available under beta

Adds documentation to the README on how to use Netlify Integration Auth in functions.

rstavchansky

Added some minor feedback from the docs team
If this gets added to docs.netlify.com, it would be useful to add a link to the docs there for additional info.

README.md

rstavchansky · 2021-08-09T19:04:08Z

README.md

+
+## Netlify Integration Auth Management
+
+To make building on and interacting with third-party APIs as simple and powerful as possible, Netlify provides API secret provisioning and management, powered by OneGraph. It’s enabled on a per-site basis under the [Netlify labs](https://app.netlify.com/user/labs) tab, where you can visually select which services you want to make available for your functions or site builds, and which scopes you need access to.


Sounds like this location may shift (enable in Netlify Labs, configure elsewhere in the UI)

I believe the plan is to get it live while the UI lives inside of the Labs UI, so the readme should be updated to reflect this and then updated again later once we undertake the review

README.md

rstavchansky · 2021-08-09T19:08:53Z

README.md

+
+### Updating or removing auth from your site
+
+At any time you can revisit the Netlify Integration Auth Management tab for your site to see the installed auth. From there, you can select new scopes for already-installed auth and then run through the browser-based auth flow again, and the new scopes will be available to all your existing, deployed functions instantly. 


This would benefit from being more specific about where the user can update items in the UI. (The location may change, however.)

Included a link and instructions for the current location

README.md

Co-authored-by: Rachael Stavchansky <rachael@netlify.com>

sgrove · 2021-08-10T05:32:17Z

@rstavchansky thank you for the suggestions, I've committed all of them.

Re: the location, I agree that it'd be better to be specific - we'll have to figure out what the final form it take is though.

It might also be nice to have a cli command netlify auth:manage that would open the auth UI for the site automatically.

sgrove · 2021-08-11T17:35:33Z

Incorporated feedback from the blog post here as well for any overlapping content.

chore: Add provisional docs for auth usage

79e897c

Adds documentation to the README on how to use Netlify Integration Auth in functions.

rstavchansky reviewed Aug 9, 2021

View reviewed changes

sgrove and others added 3 commits August 9, 2021 22:30

Update README.md

525eb26

Co-authored-by: Rachael Stavchansky <rachael@netlify.com>

Update README.md

a2ee2f9

Co-authored-by: Rachael Stavchansky <rachael@netlify.com>

Update README.md

ac2c884

Co-authored-by: Rachael Stavchansky <rachael@netlify.com>

Incorporate copy feedback

bfd0973

Update README.md

da37759

tiffafoo merged commit 7573d23 into netlify:feat/secrets-handling Sep 9, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: Add provisional docs for auth usage #109

chore: Add provisional docs for auth usage #109

sgrove commented Aug 5, 2021 •

edited

Loading

rstavchansky left a comment

rstavchansky Aug 9, 2021

lukeocodes Aug 11, 2021

rstavchansky Aug 9, 2021

sgrove Aug 11, 2021

sgrove commented Aug 10, 2021

sgrove commented Aug 11, 2021


		## Netlify Integration Auth Management

		To make building on and interacting with third-party APIs as simple and powerful as possible, Netlify provides API secret provisioning and management, powered by OneGraph. It’s enabled on a per-site basis under the [Netlify labs](https://app.netlify.com/user/labs) tab, where you can visually select which services you want to make available for your functions or site builds, and which scopes you need access to.


		### Updating or removing auth from your site

		At any time you can revisit the Netlify Integration Auth Management tab for your site to see the installed auth. From there, you can select new scopes for already-installed auth and then run through the browser-based auth flow again, and the new scopes will be available to all your existing, deployed functions instantly.

chore: Add provisional docs for auth usage #109

chore: Add provisional docs for auth usage #109

Conversation

sgrove commented Aug 5, 2021 • edited Loading

rstavchansky left a comment

Choose a reason for hiding this comment

rstavchansky Aug 9, 2021

Choose a reason for hiding this comment

lukeocodes Aug 11, 2021

Choose a reason for hiding this comment

rstavchansky Aug 9, 2021

Choose a reason for hiding this comment

sgrove Aug 11, 2021

Choose a reason for hiding this comment

sgrove commented Aug 10, 2021

sgrove commented Aug 11, 2021

sgrove commented Aug 5, 2021 •

edited

Loading