[Core] Documentation for pipeline and policies#20418
[Core] Documentation for pipeline and policies#20418joheredi merged 18 commits intoAzure:mainfrom joheredi:pipeline-docs
Conversation
joheredi
requested review from
deyaaeldeen,
jeremymeng and
xirzec
as code owners
ghost
added
the
joheredi
changed the title
xirzec
left a comment
xirzec
left a comment
There was a problem hiding this comment.
Thank you for writing this up! 👍
This is a fantastic starting point and I am glad we will soon have this checked into the repo for folks to reference.
I left some pretty high-level feedback, since I figured we can debate periods and grammar once the content has settled more. 😄
ramya-rao-a
left a comment
ramya-rao-a
left a comment
There was a problem hiding this comment.
General thought: Should this be combined with the readme for core-rest-pipeline instead of a separate document?
xirzec
left a comment
xirzec
left a comment
There was a problem hiding this comment.
This looks great! 👍
Left some small grammar nits / typo suggestions as well as a couple expanded details where I thought it would be helpful.
This is a good idea, or if we think it is too meaty of a topic, we should certainly modify the core-rest-pipeline readme to emphatically link to here. |
jeremymeng
left a comment
jeremymeng
left a comment
There was a problem hiding this comment.
Thanks for adding the docs! I only have nit comments.
| @@ -0,0 +1,251 @@ | |||
| # Policies | |||
There was a problem hiding this comment.
Do you think it is better to start with some general sentence about us using a list of request policy (pipeline) in our sdk, then followed by sections in details?
|
|
||
| # Pipelines | ||
|
|
||
| A `Pipeline` composes several policies and provides the ability to make a request that will flow through the policies in a specific order determined by their requirements. Which allows manipulating each request before it is sent to the server and to work on the response after receiving it. |
There was a problem hiding this comment.
"composes" => "is composed of"?
Co-authored-by: Ramya Rao <ramya.rao.a@outlook.com>
Co-authored-by: Ramya Rao <ramya.rao.a@outlook.com>
Co-authored-by: Ramya Rao <ramya.rao.a@outlook.com>
Co-authored-by: Jeff Fisher <xirzec@xirzec.com>
Co-authored-by: Jeff Fisher <xirzec@xirzec.com>
Co-authored-by: Jeff Fisher <xirzec@xirzec.com>
Co-authored-by: Jeff Fisher <xirzec@xirzec.com>
Co-authored-by: Jeff Fisher <xirzec@xirzec.com>
Co-authored-by: Jeff Fisher <xirzec@xirzec.com>
Co-authored-by: Jeff Fisher <xirzec@xirzec.com>
Co-authored-by: Jeff Fisher <xirzec@xirzec.com>
Co-authored-by: Jeff Fisher <xirzec@xirzec.com>
4 participants
Packages impacted by this PR
None. This PR adds documentation for Pipeline and PipelinePolicy
Issues associated with this PR
#13561
Describe the problem that is addressed by this PR
Add documentation for the Pipeline and Policies and how to customize them.