From 552aaa9119ce0d9be41163916b7399864cc4724d Mon Sep 17 00:00:00 2001 From: Chi Song Date: Thu, 16 Nov 2023 10:45:51 -0800 Subject: [PATCH] doc: remove LISAv2 docs --- README.rst | 9 +---- docs/extras.rst | 5 +-- docs/index.rst | 7 +--- docs/run_test/microsoft_tests.rst | 6 ---- docs/run_test/run.rst | 1 - docs/run_test/run_legacy.rst | 60 ------------------------------- docs/tools/test_summary_gen.py | 5 --- 7 files changed, 3 insertions(+), 90 deletions(-) delete mode 100644 docs/run_test/run_legacy.rst diff --git a/README.rst b/README.rst index 0314ac653..b7fc78f71 100644 --- a/README.rst +++ b/README.rst @@ -44,8 +44,6 @@ Documents - `Command line reference `__ - `Runbook reference `__ - `Extend and customize LISA `__ -- `Run the previous version of LISA (aka - LISAv2) `__ Contribute ---------- @@ -53,14 +51,9 @@ Contribute You are very welcome to contribute to this repository. Please follow `the contribution document `__ for details. -History and road map +Road map -------------------- -The previous LISA called LISAv2, which is in `the master -branch `__. The previous -LISA can be used standalone or called from the current LISA. Learn more -from `how to run LISAv2 test cases `__. - LISA is in active developing, and a lot of exciting features are being implemented. We're listening to your `feedback `__. diff --git a/docs/extras.rst b/docs/extras.rst index 89a9e0ea2..27150ffb1 100644 --- a/docs/extras.rst +++ b/docs/extras.rst @@ -25,11 +25,8 @@ aws azure Provides dependencies for running LISA on Microsoft Azure -legacy - Provides dependencies for running LISA v2 tests - libvirt Provides dependencies for running LISA on libvirt-managed hypervisors -.. _install extras: https://packaging.python.org/en/latest/tutorials/installing-packages/#installing-extras \ No newline at end of file +.. _install extras: https://packaging.python.org/en/latest/tutorials/installing-packages/#installing-extras diff --git a/docs/index.rst b/docs/index.rst index aad1c2187..805ffbec9 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -50,14 +50,9 @@ Why LISA Contributing Troubleshooting -History and road map +Road map -------------------- -The previous LISA called LISAv2, which is in `master branch -`__. The previous LISA can be -used standalone or called from the current LISA. Learn more from :doc:`how to -run LISAv2 test cases `. - LISA is in active developing, and a lot of exciting features are implementing. We're listening your `feedback `__. diff --git a/docs/run_test/microsoft_tests.rst b/docs/run_test/microsoft_tests.rst index ec450e6d0..42729c47f 100644 --- a/docs/run_test/microsoft_tests.rst +++ b/docs/run_test/microsoft_tests.rst @@ -138,9 +138,3 @@ Test cases specification ------------------------ Refer to :doc:`Test specification `. - -.. seealso:: - - Not migrated `legacy LISAv2 - tests `__ - for more information. diff --git a/docs/run_test/run.rst b/docs/run_test/run.rst index ca153614e..c2847cb80 100644 --- a/docs/run_test/run.rst +++ b/docs/run_test/run.rst @@ -7,7 +7,6 @@ Run LISA Getting started with Azure Run tests in Local VM Learn Microsoft tests - Learn legacy tests Test case summary Test specifications Run tests on different platforms diff --git a/docs/run_test/run_legacy.rst b/docs/run_test/run_legacy.rst deleted file mode 100644 index 5701233cc..000000000 --- a/docs/run_test/run_legacy.rst +++ /dev/null @@ -1,60 +0,0 @@ -How to run Legacy LISAv2 tests -============================== - -`LISAv2 `__ brings incredible value -to Linux quality on Microsoft virtualization platforms. To increase the -value of LISA, we decide to continue to invest and have more innovation -on LISA. So, we started the next version. - -During the transition time, we keep validating Linux kernels and -distributions. We cannot and don't want to stop to wait for the exciting -current LISA. The two versions will be co-existing for a while. So, the -current LISA version supports to invoke previous LISAv2. - -With this document, you will know how to run LISAv2 tests in the current -LISA. The current LISA clones the LISAv2 repo, start LISAv2, and parse -LISAv2 log to generate test results with new format. - - -.. attention:: - - |:construction:| WIP |:construction:| - Currently we are migrating previous LISAv2 test cases to this - LISA framework. Before we complete the test case migration, only T0 test - cases can be launched on LISA. Other test cases can be executed in LISA - with “Compatibility mode”, which will invoke a shim layer to call - LISAv2; so you need to run LISA on a Windows computer and provide the - secret file. - -Preparation ------------ - -LISAv2 should run in the latest Windows 10 client 64 bits, or Windows -Server 2019 editions. - -Follow `LISAv2 -document `__ -to understand prerequisites and prepare secret files. - -Note, you don't need to clone the LISAv2 yourself, the current LISA will -clone it when running. - -Limitations ------------ - -1. The Test in Parallel of LISAv2 doesn't support with the current LISA - together. The current LISA implements test matrix to replace current - test in parallel in LISAv2. There is no plan for compatibility with - LISAv2 on this. -2. The LISAv2 results is possible to be missed in a rare race condition. - There may be accessing conflict of LISAv2 test log. If it happens on - key logs which relates to test result parsing, it may cause the - status of results are not shown correctly. - -Road map --------- - -We're migrating LISAv2 test cases to current LISA by test case priority. -We will keep t0 to tx runbooks update to date. When test cases migrated, -they will be included in current LISA, and remove from LISAv2. It's -transparent when running LISA tests. diff --git a/docs/tools/test_summary_gen.py b/docs/tools/test_summary_gen.py index 9c4bcb0ff..9b9b7d0a5 100644 --- a/docs/tools/test_summary_gen.py +++ b/docs/tools/test_summary_gen.py @@ -54,11 +54,6 @@ def update_summary() -> None: for index, node in enumerate(res, start=1): _update_line(table, node, index) - link = "https://github.com/microsoft/lisa/blob/master/Documents/LISAv2-TestCase-Statistics.md" # noqa: E501 - table.write(".. seealso::\n") - table.write(f" `LISAv2 Tests <{link}>`__\n") - table.write("\n") - def _write_title(file: TextIO) -> None: """