Skip to content

Commit

Permalink
Link to 1.1 docs from 2.0 docs (#2002)
Browse files Browse the repository at this point in the history
* Link to 1.1 docs from 2.0 docs

* Change 'About YARP' to 'About YARP 2.0' in the menu
  • Loading branch information
MihaZupan authored Jan 18, 2023
1 parent 1be98d8 commit 0067734
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 2 deletions.
4 changes: 3 additions & 1 deletion docs/docfx/api/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# API Documentation for YARP

This is the API reference documentation for YARP.
This is the API reference documentation for YARP 2.0.

For documentation of YARP 1.1.1, see https://github.com/microsoft/reverse-proxy/tree/release/1.1/docs/docfx/articles.
4 changes: 4 additions & 0 deletions docs/docfx/articles/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,7 @@ title: Welcome to the YARP documentation!
---

# Welcome to the docs

This is the documentation for YARP 2.0.

For documentation of YARP 1.1.1, see https://github.com/microsoft/reverse-proxy/tree/release/1.1/docs/docfx/articles.
3 changes: 3 additions & 0 deletions docs/docfx/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ title: YARP Documentation

Welcome to the documentation for YARP! YARP is a library to help create reverse proxy servers that are high-performance, production-ready, and highly customizable. Please provide us your feedback by going to [the GitHub repository](https://github.com/microsoft/reverse-proxy).

This is the documentation for YARP 2.0.
For documentation of YARP 1.1.1, see https://github.com/microsoft/reverse-proxy/tree/release/1.1/docs/docfx/articles.

## Why YARP

We found a bunch of internal teams at Microsoft who were either building a reverse proxy for their service or had been asking about APIs and tech for building one, so we decided to get them all together to work on a common solution, this project. Each of these projects was doing something slightly off the beaten path which meant they were not well served by existing proxies, and customization of those proxies had a high cost and ongoing maintenance considerations.
Expand Down
2 changes: 1 addition & 1 deletion docs/docfx/toc.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
- name: About YARP
- name: About YARP 2.0
href: index.md
- name: Articles
href: articles/
Expand Down

0 comments on commit 0067734

Please sign in to comment.