958ff41826
Introduced a basic documentation skeleton that mirrors the flat directory structure of starlingx/test, providing a foundation for future documentation expansion. Structured documentation layout based on starlingx/test directories: - Created placeholder index.rst files for: - config/ - framework/ - keywords/ - resources/ - scripts/ - testcases/ - unit_tests/ - web_pages/ - Ensured modular navigation through toctree references Repository overview & navigation improvements: - Added directory_structure.rst to document the current repository layout - Updated index.rst to provide a central entry point for navigating documentation - Ensured logical linking between sections for future expansion Initial content in resources/: - Unlike other sections, resources/ contains actual documentation beyond a placeholder - Added resources_overview.rst, covering containerized applications, test images, and nightly regression configs Verified with Sphinx live preview (sphinx-autobuild). No API documentation yet, just a basic high-level skeleton for the repository's directories. Change-Id: I5f21199280c4c472cd812021bf0f9c3fa6f5c967 Signed-off-by: Andrew Vaillancourt <andrew.vaillancourt@windriver.com>
33 lines
944 B
ReStructuredText
33 lines
944 B
ReStructuredText
==============================
|
|
StarlingX Test Documentation
|
|
==============================
|
|
|
|
------------
|
|
Introduction
|
|
------------
|
|
|
|
This project contains **Automated Test Cases** that validate the **StarlingX product**.
|
|
The test framework provides tools and structured test cases to ensure the stability and reliability of StarlingX components.
|
|
|
|
For more information about StarlingX, see the official documentation:
|
|
🔗 https://docs.starlingx.io/
|
|
|
|
----------------------
|
|
Repository Structure
|
|
----------------------
|
|
|
|
The **StarlingX Test Repository Structure** provides an overview of key directories and their purpose within the automation framework.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
directory_structure
|
|
|
|
-----
|
|
Links
|
|
-----
|
|
|
|
* **Source Code:** https://opendev.org/starlingx/test
|
|
* **Code Review:** https://review.opendev.org/#/q/project:starlingx/test
|
|
* **Bug Tracking:** https://storyboard.openstack.org/#!/project/starlingx/test
|