Azure / Azure-Functions

1.11k stars 195 forks source link

Solve the duplicate reference issue #80

Closed ggailey777 closed 5 years ago

ggailey777 commented 7 years ago

As @cephalin pointed out previously, having embedded reference produces a sync issue with reference on docs.Microsoft.com. We need to try to get this to a single source for the reference, as we don't have the resources to keep the two sources in sync. I've attached the entire email thread for reference:

This is the same thing I discussed in the attached thread. There wasn’t a lot of traction then. It’s regarding the dup sources on ACOM and in the link that you pointed to. Please take a look at that and comment.

The reorg I made to the ACOM docs is with the hope that we can easily merge the two sources into one sometime in the future. Any reformatting I made to the ACOM binding docs is with https://github.com/Azure/azure-webjobs-sdk-templates/tree/dev/Documentation in mind.

Review the new format at:

From: Yochay Kiriaty Sent: October 31, 2016 4:48 PM To: Glenn Gailey Glenn.Gailey@microsoft.com; Donna Malayeri donnam@microsoft.com; Erik Reitan Erik.Reitan@microsoft.com; Cephas Lin Cephas.Lin@microsoft.com; Wesley McSwain wesmc@microsoft.com; Rachel Appel Rachel.Appel@microsoft.com Cc: Azure Functions content tactics azfundocs@microsoft.com Subject: RE: Embedded portal documentation

The binding data requires scrub, ideally for GA, to make sure they match the actual code generated, expected when adding a binding.

For example, binding Q item (trigger) the binding UI show one binding input parameter, the doc show a different one, and the code shows a 3rd one. We need to assume the code is the ultimate source of truth and just update them all.

I have not review all bindings

Donna, can you create a worktime for the PM team to review all binding/ docs/ templates and logs bugs accordingly?

Thanks, Yochay

From: Glenn Gailey Sent: Friday, October 28, 2016 4:09 PM To: Donna Malayeri donnam@microsoft.com; Erik Reitan Erik.Reitan@microsoft.com; Cephas Lin Cephas.Lin@microsoft.com; Wesley McSwain wesmc@microsoft.com; Rachel Appel Rachel.Appel@microsoft.com Cc: Azure Functions content tactics azfundocs@microsoft.com Subject: RE: Embedded portal documentation

Sure, but then we are injecting metadata 

From: Donna Malayeri Sent: Friday, October 28, 2016 3:56 PM To: Glenn Gailey Glenn.Gailey@microsoft.com; Erik Reitan Erik.Reitan@microsoft.com; Cephas Lin Cephas.Lin@microsoft.com; Wesley McSwain wesmc@microsoft.com; Rachel Appel Rachel.Appel@microsoft.com Cc: Azure Functions content tactics azfundocs@microsoft.com Subject: RE: Embedded portal documentation

The devs help write some of these docs, so they may want the automation to go the other way, but yes, this is a great idea.

From: Glenn Gailey Sent: Friday, October 28, 2016 3:48 PM To: Erik Reitan Erik.Reitan@microsoft.com; Donna Malayeri donnam@microsoft.com; Cephas Lin Cephas.Lin@microsoft.com; Wesley McSwain wesmc@microsoft.com; Rachel Appel Rachel.Appel@microsoft.com Cc: Azure Functions content tactics azfundocs@microsoft.com Subject: RE: Embedded portal documentation

Perhaps after GA we should investigate some automation for keeping these reference docs in a Docs repo, stripping out the metadata and dropping them in the product repo?

From: Erik Reitan Sent: Friday, October 28, 2016 3:23 PM To: Donna Malayeri donnam@microsoft.com; Cephas Lin Cephas.Lin@microsoft.com; Glenn Gailey Glenn.Gailey@microsoft.com; Wesley McSwain wesmc@microsoft.com; Rachel Appel Rachel.Appel@microsoft.com Cc: Azure Functions content tactics azfundocs@microsoft.com Subject: RE: Embedded portal documentation

Seems we could add a review of these docs to the waffle board. Of course, I’d like to see the P0 content completed first.

From: Donna Malayeri Sent: Friday, October 28, 2016 2:59 PM To: Cephas Lin Cephas.Lin@microsoft.com; Glenn Gailey Glenn.Gailey@microsoft.com; Wesley McSwain wesmc@microsoft.com; Rachel Appel Rachel.Appel@microsoft.com Cc: Erik Reitan Erik.Reitan@microsoft.com; Azure Functions content tactics azfundocs@microsoft.com Subject: Embedded portal documentation

I realized that not everyone knows where the embedded binding and trigger documentation is sourced from. It lives here: https://github.com/Azure/azure-webjobs-sdk-templates/tree/dev/Documentation

These docs could also benefit from review from the writers; I have an item on my plate to go through them as well.

Thanks, Donna

ggailey777 commented 7 years ago

I am investigating putting copies of the ref docs into azure-docs-pr in the includes folder, then including these into the existing How To topics (with some modification). This would enable us to hook-up automation between repos when the sources are updated in the product repo.

ggailey777 commented 7 years ago

@ggailey777 needs to meet with @SyntaxC4 to discuss how to best share content between two repos, especially when we have little control over the azure-docs-pr repo.