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

Cleanup docs #159

Merged
merged 2 commits into from
Nov 11, 2021
Merged

Cleanup docs #159

merged 2 commits into from
Nov 11, 2021

Conversation

Charles-Gagnon
Copy link
Contributor

@Charles-Gagnon Charles-Gagnon commented Nov 11, 2021

Re-organizing and clarifying some parts. Also moved away from having Azure SQL be the only choice to reduce friction for new devs so they can get started ASAP using something like docker.

Lots more work to do I'm sure but this at least fixes the majority of the things that I had noted could use with some polishing 😄

Link to the README so you can check out what it actually looks like https://github.com/Azure/azure-functions-sql-extension/blob/chgagnon/cleanupDocs/README.md

README.md Outdated
### Input Binding Tutorial

Note: This tutorial requires that the Azure SQL database is setup as shown in [Create Azure SQL Database](#Create-Azure-SQL-Database).
Note: This tutorial requires that the SQL database is setup as shown in [Create Azure SQL Database](#Create-a-SQL-Server).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this be [Create a SQL Database]?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we also want to update the note in Output Binding Tutorial (line 213)?

README.md Outdated
### Input Binding Tutorial

Note: This tutorial requires that the Azure SQL database is setup as shown in [Create Azure SQL Database](#Create-Azure-SQL-Database).
Note: This tutorial requires that the SQL database is setup as shown in [Create Azure SQL Database](#Create-a-SQL-Server).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we also want to update the note in Output Binding Tutorial (line 213)?

@Charles-Gagnon
Copy link
Contributor Author

@dzsquared Merging this in now so people can get the updates, if you get a chance to look it over just leave any comments here and I'll fix them up later

@Charles-Gagnon Charles-Gagnon merged commit c31a007 into main Nov 11, 2021
@Charles-Gagnon Charles-Gagnon deleted the chgagnon/cleanupDocs branch November 11, 2021 19:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants