Some update on docs (#1450)

* delete favicon

* add badge

* add instructions for updating LISA

* update README

README.rst

@@ -1,7 +1,7 @@
 Linux Integration Services Automation (LISA)
 ============================================
 
-|CI Workflow| |GitHub license|
+|CI Workflow| |GitHub license| |Docs|
 
 **Linux Integration Services Automation (LISA)** is a Linux quality
 validation system, which consists of two parts：
@@ -16,7 +16,7 @@ on any platforms if the proper orchestrator module implemented.
 Why LISA
 --------
 
--  **Scalable**\ ：Benefit from the appropriate abstractions, ``LISA``
+-  **Scalable**：Benefit from the appropriate abstractions, ``LISA``
    can be used to test the quality of numerous Linux distributions
    without duplication of code implementation.
 
@@ -36,21 +36,21 @@ Why LISA
 Documents
 ---------
 
--  `Quick start <https://mslisa.rtfd.io/en/latest/quick_start.html>`__
--  `Run tests <https://mslisa.rtfd.io/en/latest/run_test/run.html>`__
--  `Microsoft tests <https://mslisa.rtfd.io/en/latest/run_test/microsoft_tests.html>`__
--  `Write test cases in LISA <https://mslisa.rtfd.io/en/latest/write_test/write_case.html>`__
--  `Command line reference <https://mslisa.rtfd.io/en/latest/run_test/command_line.html>`__
--  `Runbook reference <https://mslisa.rtfd.io/en/latest/run_test/runbook.html>`__
--  `Extend and customize LISA <https://mslisa.rtfd.io/en/latest/write_test/extension.html>`__
+-  `Quick start <https://mslisa.rtfd.io/en/main/quick_start.html>`__
+-  `Run tests <https://mslisa.rtfd.io/en/main/run_test/run.html>`__
+-  `Microsoft tests <https://mslisa.rtfd.io/en/main/run_test/microsoft_tests.html>`__
+-  `Write test cases in LISA <https://mslisa.rtfd.io/en/main/write_test/write_case.html>`__
+-  `Command line reference <https://mslisa.rtfd.io/en/main/run_test/command_line.html>`__
+-  `Runbook reference <https://mslisa.rtfd.io/en/main/run_test/runbook.html>`__
+-  `Extend and customize LISA <https://mslisa.rtfd.io/en/main/write_test/extension.html>`__
 -  `Run previous version LISA (aka
-   LISAv2) <https://mslisa.rtfd.io/en/latest/run_test/run_legacy.html>`__
+   LISAv2) <https://mslisa.rtfd.io/en/main/run_test/run_legacy.html>`__
 
 Contribute
 ----------
 
 You are very welcome to contribute. Please follow `the contribution
-document <https://mslisa.rtfd.io/en/latest/contributing.html>`__ for details.
+document <https://mslisa.rtfd.io/en/main/contributing.html>`__ for details.
 
 History and road map
 --------------------
@@ -58,7 +58,7 @@ History and road map
 The previous LISA called LISAv2, which is in `master
 branch <https://github.com/microsoft/lisa/tree/master>`__. The previous
 LISA can be used standalone or called from the current LISA. Learn more
-from `how to run LISAv2 test cases <https://mslisa.rtfd.io/en/latest/run_test/run_legacy.html>`__.
+from `how to run LISAv2 test cases <https://mslisa.rtfd.io/en/main/run_test/run_legacy.html>`__.
 
 LISA is in active developing, and a lot of exciting features are
 implementing. We’re listening your
@@ -73,3 +73,6 @@ The entire codebase is under `MIT license <LICENSE>`__.
    :target: https://github.com/microsoft/lisa/actions?query=workflow%3A%22CI+Workflow+for+LISAv3%22+event%3Apush+branch%3Amain
 .. |GitHub license| image:: https://img.shields.io/github/license/microsoft/lisa
    :target: https://github.com/microsoft/lisa/blob/main/LICENSE
+.. |Docs| image:: https://readthedocs.org/projects/mslisa/badge/?version=main
+   :target: https://mslisa.readthedocs.io/en/main/?badge=main
+   :alt: Documentation Status

docs/conf.py

@@ -66,7 +66,3 @@ html_theme_options = {
     "logo_only": True,
     "display_version": False,
 }
-
-html_favicon = "favicon.ico"
-
-html_logo = "LSG_Logo.png"

docs/index.rst

@@ -7,7 +7,7 @@
 Welcome to Linux Integration Services Automation (LISA)!
 ========================================================
 
-|CI Workflow| |GitHub license|
+|CI Workflow| |GitHub license| |Docs|
 
 **Linux Integration Services Automation (LISA)** is a Linux quality
 validation system, which consists of two parts：
@@ -44,7 +44,7 @@ Why LISA
    :hidden:
 
    Introduction <quick_start>
-   Installation <install>
+   Installation & Update <install>
    Run tests <run_test/run>
    Write tests <write_test/write>
    Contributing <contributing>
@@ -72,3 +72,6 @@ The entire codebase is under `MIT license
    :target: https://github.com/microsoft/lisa/actions?query=workflow%3A%22CI+Workflow+for+LISAv3%22+event%3Apush+branch%3Amain
 .. |GitHub license| image:: https://img.shields.io/github/license/microsoft/lisa
    :target: https://github.com/microsoft/lisa/blob/main/LICENSE
+.. |Docs| image:: https://readthedocs.org/projects/mslisa/badge/?version=main
+   :target: https://mslisa.readthedocs.io/en/main/?badge=main
+   :alt: Documentation Status

docs/install.rst

@@ -1,5 +1,5 @@
-Installation
-============
+Installation & Update
+=====================
 
 Currently we support installation on Linux & Windows.
 
@@ -7,4 +7,5 @@ Currently we support installation on Linux & Windows.
     :maxdepth: 2
  
     Installation on Linux <installation_linux>
-    Installation on Windows <installation_windows>
+    Installation on Windows <installation_windows>
+    Updating LISA <update>

docs/update.rst

@@ -0,0 +1,20 @@
+Updating LISA
+=============
+
+Once LISA has been successfully installed on your computer, simply follow below
+steps to update.
+
+In the root foler of LISA ``(...\lisa\)``, run
+
+.. code:: bash
+
+    git pull
+
+to keep your local source code in sync with the latest code in repo, and then
+run
+
+.. code:: bash
+
+    poetry install
+
+to keep all packages up-to-date as well.