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>
41 lines
834 B
ReStructuredText
41 lines
834 B
ReStructuredText
===================================
|
|
StarlingX Test Repository Structure
|
|
===================================
|
|
|
|
Below is an overview of the `starlingx/test` directory structure.
|
|
This highlights key directories but does not list every file.
|
|
|
|
.. code-block:: bash
|
|
|
|
starlingx/test/
|
|
├── config
|
|
├── doc
|
|
├── framework
|
|
├── keywords
|
|
├── portal
|
|
├── pre-commit
|
|
├── releasenotes
|
|
├── resources
|
|
├── scripts
|
|
├── testcases
|
|
├── unit_tests
|
|
└── web_pages
|
|
|
|
-----------
|
|
Directories
|
|
-----------
|
|
|
|
For detailed information on specific directories, see the pages below.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
testcases/index
|
|
resources/index
|
|
framework/index
|
|
keywords/index
|
|
config/index
|
|
scripts/index
|
|
unit_tests/index
|
|
web_pages/index
|