From 006773443f449884fb26dcda05d8000f2b24dd56 Mon Sep 17 00:00:00 2001 From: Miha Zupan Date: Wed, 18 Jan 2023 17:05:17 +0100 Subject: [PATCH] Link to 1.1 docs from 2.0 docs (#2002) * Link to 1.1 docs from 2.0 docs * Change 'About YARP' to 'About YARP 2.0' in the menu --- docs/docfx/api/index.md | 4 +++- docs/docfx/articles/index.md | 4 ++++ docs/docfx/index.md | 3 +++ docs/docfx/toc.yml | 2 +- 4 files changed, 11 insertions(+), 2 deletions(-) diff --git a/docs/docfx/api/index.md b/docs/docfx/api/index.md index d551c64bb..82475095a 100644 --- a/docs/docfx/api/index.md +++ b/docs/docfx/api/index.md @@ -1,3 +1,5 @@ # API Documentation for YARP -This is the API reference documentation for YARP. \ No newline at end of file +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. \ No newline at end of file diff --git a/docs/docfx/articles/index.md b/docs/docfx/articles/index.md index 53539534a..458dc47a0 100644 --- a/docs/docfx/articles/index.md +++ b/docs/docfx/articles/index.md @@ -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. \ No newline at end of file diff --git a/docs/docfx/index.md b/docs/docfx/index.md index c878efcf3..1de1e6b59 100644 --- a/docs/docfx/index.md +++ b/docs/docfx/index.md @@ -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. diff --git a/docs/docfx/toc.yml b/docs/docfx/toc.yml index cc50e12d9..f7354d57b 100644 --- a/docs/docfx/toc.yml +++ b/docs/docfx/toc.yml @@ -1,4 +1,4 @@ -- name: About YARP +- name: About YARP 2.0 href: index.md - name: Articles href: articles/