From ce3d2cf312fc378a4ab539037b103fab8dd0cc63 Mon Sep 17 00:00:00 2001 From: zhangbailin Date: Sat, 14 Aug 2021 18:50:23 +0800 Subject: [PATCH] Add the microversion history docs We have added the microversion support, but lost the microversion histroy docs, This patch provides the history of all those changes. Consider it a "what's new" in the Cyborg API. Change-Id: I885c456594184d949c929e1e87716e8a43f98818 --- doc/source/contributor/rest_api_version_history.rst | 1 + doc/source/index.rst | 8 ++++---- 2 files changed, 5 insertions(+), 4 deletions(-) create mode 120000 doc/source/contributor/rest_api_version_history.rst diff --git a/doc/source/contributor/rest_api_version_history.rst b/doc/source/contributor/rest_api_version_history.rst new file mode 120000 index 00000000..6963e5bc --- /dev/null +++ b/doc/source/contributor/rest_api_version_history.rst @@ -0,0 +1 @@ +../../../cyborg/api/rest_api_version_history.rst \ No newline at end of file diff --git a/doc/source/index.rst b/doc/source/index.rst index ef7792cb..b5a94e3f 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -76,10 +76,9 @@ guide. The complete reference for the accelerator API, including all methods and request / response parameters and their meaning. -.. # TODO(brinzhang): After completing the - `Cyborg API v2 `_ - API, the "Cyborg API Microversion History "" management - document will be added, and it will also be added here. +* :doc:`/contributor/rest_api_version_history`: The Cyborg API evolves over + time through Microversions. This provides the history of all those changes. + Consider it a "what's new" in the Cyborg API. Documentation for Developers ---------------------------- @@ -88,6 +87,7 @@ Documentation for Developers :maxdepth: 1 contributor/index + contributor/rest_api_version_history Indices and tables ==================