starlingx/test
Code Issues Proposed changes
test/doc/source/resources/index.rst
Andrew Vaillancourt 958ff41826 Add basic documentation skeleton 
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>
2025-02-06 18:38:21 -05:00

1.4 KiB
Raw Blame History

resources/ Documentation

The resources/ directory contains various test-related assets used within the StarlingX Test Framework, including containerized applications, custom-built Docker images, nightly regression configurations (deployment files, pod definitions, and Network Attachment Definitions (NADs)), and sanity test pods / configs.

Contents

resources_overview

Directory Structure

Below is an overview of the resources/ directory structure. This highlights key directories and files but does not include every file:

resources/
├── cloud_platform
│   ├── containers
│   │   ├── hello-kitty_armada.tgz
│   │   ├── hello-kitty-min-k8s-version.tgz
│   ├── images
│   │   └── node-hello-alpine
│   │       ├── Dockerfile
│   │       ├── node-hello-alpine.tar.gz
│   │       └── server.js
│   ├── nightly_regression
│   │   ├── calicoctl_crb.yaml
│   │   └── daemon_set_daemonset_ipv4.yaml
│   ├── sanity
│       └── pods
│           ├── client-pod1.yaml
│           └── server_pod.yaml
├── images
    ├── busybox.tar
    └── calico-ctl.tar