diff --git a/Drv/BlockDriver/docs/sdd.md b/Drv/BlockDriver/docs/sdd.md index fe95e43891..afc0ac2109 100644 --- a/Drv/BlockDriver/docs/sdd.md +++ b/Drv/BlockDriver/docs/sdd.md @@ -1,4 +1,3 @@ -Drv::BlockDriver # Drv::BlockDriver Component ## 1. Introduction diff --git a/Fw/Buffer/docs/sdd.md b/Fw/Buffer/docs/sdd.md index 983c5a7ec2..fb85b6c849 100644 --- a/Fw/Buffer/docs/sdd.md +++ b/Fw/Buffer/docs/sdd.md @@ -1,4 +1,3 @@ -Fw/Buffer # Fw/Buffer diff --git a/Fw/Cmd/docs/sdd.md b/Fw/Cmd/docs/sdd.md index 7d2ddd62ca..acab2ea4f7 100644 --- a/Fw/Cmd/docs/sdd.md +++ b/Fw/Cmd/docs/sdd.md @@ -1,4 +1,3 @@ -Fw::Cmd/Fw::CmdResponse/Fw::CmdReg Port SDD # Fw::Cmd/Fw::CmdResponse/Fw::CmdReg diff --git a/Fw/Com/docs/sdd.md b/Fw/Com/docs/sdd.md index 907c06e4c2..f305500db5 100644 --- a/Fw/Com/docs/sdd.md +++ b/Fw/Com/docs/sdd.md @@ -1,4 +1,3 @@ -Fw::Com Port SDD # Fw::Com Port ## 1. Introduction diff --git a/Fw/FilePacket/docs/sdd.md b/Fw/FilePacket/docs/sdd.md index 35b2684045..85af3be7db 100644 --- a/Fw/FilePacket/docs/sdd.md +++ b/Fw/FilePacket/docs/sdd.md @@ -1,4 +1,3 @@ -Fw/FilePacket # Fw/FilePacket diff --git a/Fw/Log/docs/sdd.md b/Fw/Log/docs/sdd.md index e270cfbee1..58b1233799 100644 --- a/Fw/Log/docs/sdd.md +++ b/Fw/Log/docs/sdd.md @@ -1,4 +1,3 @@ -Fw::Log/Fw::LogText Port SDD # Fw::Log/LogText Ports diff --git a/Fw/Obj/docs/sdd.md b/Fw/Obj/docs/sdd.md index 57c9a9a33d..58699f82e6 100644 --- a/Fw/Obj/docs/sdd.md +++ b/Fw/Obj/docs/sdd.md @@ -1,4 +1,3 @@ -Fw::Obj SDD # Fw::Obj Descriptions ## 1. Introduction diff --git a/Fw/Port/docs/sdd.md b/Fw/Port/docs/sdd.md index 51719a9afd..b8222af5d3 100644 --- a/Fw/Port/docs/sdd.md +++ b/Fw/Port/docs/sdd.md @@ -1,4 +1,3 @@ -Fw::Port SDD # Fw::Port Descriptions ## 1. Introduction diff --git a/Fw/Prm/docs/sdd.md b/Fw/Prm/docs/sdd.md index 36926f026e..d6f1e1063f 100644 --- a/Fw/Prm/docs/sdd.md +++ b/Fw/Prm/docs/sdd.md @@ -1,4 +1,3 @@ -Fw::PrmGet/Fw::PrmSet Port SDD # Fw::PrmGet/PrmSet Ports diff --git a/Fw/Time/docs/sdd.md b/Fw/Time/docs/sdd.md index 9d7a75a346..8b2fd0ad40 100644 --- a/Fw/Time/docs/sdd.md +++ b/Fw/Time/docs/sdd.md @@ -1,4 +1,3 @@ -Fw::Time Port SDD # Fw::Time Port ## 1. Introduction diff --git a/Fw/Tlm/docs/sdd.md b/Fw/Tlm/docs/sdd.md index cce796629e..97005ae03d 100644 --- a/Fw/Tlm/docs/sdd.md +++ b/Fw/Tlm/docs/sdd.md @@ -1,4 +1,3 @@ -Fw::Tlm Port SDD # Fw::Tlm Port ## 1. Introduction diff --git a/Fw/Types/docs/sdd.md b/Fw/Types/docs/sdd.md index 32291f9f62..ae26548954 100644 --- a/Fw/Types/docs/sdd.md +++ b/Fw/Types/docs/sdd.md @@ -1,4 +1,3 @@ -Fw::Types SDD # Fw::Type Descriptions ## 1. Introduction diff --git a/Gds/README.md b/Gds/README.md index 8aa1f2940f..8bdd717241 100644 --- a/Gds/README.md +++ b/Gds/README.md @@ -26,7 +26,7 @@ a data object and turn it into binary data that can be sent to the fprime deployment. The binary data is then passed to the TCP client which is registered to the encoder. Finally, the TCP client send the data back to the TCP server and the F' deployment. -![The layout of the GDS](docs/gds_layout.jpg) +![The layout of the GDS](../docs/UsersGuide/media/gds_layout.jpg) All of these objects are created and registered to other objects when the Gds is initialized. Thus, all of the structure of the Gds is created in one place, @@ -39,7 +39,7 @@ The Gds was designed to have flexible configurations of consumers for its variou The standard pipeline can be thought of as a Python helper-layer to instantiate the GDS and connect to an FPrime deployment. The pipeline provides event, telemetry and command histories, sending commands and registering consumers to the GDS decoders. The Standard Pipeline can be found [here](src/fprime_gds/common/pipeline/standard.py). ### GDS Integration Test API -The Integration Test API is a tool that provides the ability to write integration-level tests for an FPrime deployment using the GDS. The tool provides history searches/asserts, command sending, a detailed test log, sub-histories and convenient access to GDS data objects. The test API comes with separate [documentation](docs/testAPI/markdown/contents.md) and its own [user guide](docs/testAPI/user_guide.md) and is built on top of the Standard Pipeline. +The Integration Test API is a tool that provides the ability to write integration-level tests for an FPrime deployment using the GDS. The tool provides history searches/asserts, command sending, a detailed test log, sub-histories and convenient access to GDS data objects. The test API comes with separate [documentation](../docs/UsersGuide/dev/testAPI/markdown/contents.md) and its own [user guide](../docs/UsersGuide/dev/testAPI/user_guide.md) and is built on top of the Standard Pipeline. ### GDS WX GUI The WX GUI is a user interface developed with the WX-Python. It uses the GDS to support a simple UI with command, event, and telemetry interfaces. diff --git a/Os/Pthreads/docs/sdd.md b/Os/Pthreads/docs/sdd.md index bacea51d98..fa01a86c5d 100644 --- a/Os/Pthreads/docs/sdd.md +++ b/Os/Pthreads/docs/sdd.md @@ -1,4 +1,3 @@ -Os::Queue (Pthreads implementation) # Os::Queue (Pthreads implemenation) diff --git a/Ref/PingReceiver/docs/sdd.md b/Ref/PingReceiver/docs/sdd.md index 7b94411d78..d3e5806059 100644 --- a/Ref/PingReceiver/docs/sdd.md +++ b/Ref/PingReceiver/docs/sdd.md @@ -1,4 +1,3 @@ -Ref::PingReceiver # Ref::PingReceiver Component ## 1. Introduction diff --git a/Ref/RecvBuffApp/docs/sdd.md b/Ref/RecvBuffApp/docs/sdd.md index ad3b30e980..e5b3b1a428 100644 --- a/Ref/RecvBuffApp/docs/sdd.md +++ b/Ref/RecvBuffApp/docs/sdd.md @@ -1,4 +1,3 @@ -Ref::RecvBuffApp # Ref::RecvBuffApp Component ## 1. Introduction diff --git a/Ref/SendBuffApp/docs/sdd.md b/Ref/SendBuffApp/docs/sdd.md index 4c69051f7a..5d94d0d00f 100644 --- a/Ref/SendBuffApp/docs/sdd.md +++ b/Ref/SendBuffApp/docs/sdd.md @@ -1,4 +1,3 @@ -Ref::SendBuffApp # Ref::SendBuffApp Component ## 1. Introduction diff --git a/Ref/SignalGen/docs/sdd.md b/Ref/SignalGen/docs/sdd.md index 79b261d5d3..fa7f287557 100644 --- a/Ref/SignalGen/docs/sdd.md +++ b/Ref/SignalGen/docs/sdd.md @@ -1,4 +1,3 @@ -Ref::SignalGen # Ref::SignalGen Component ## 1. Introduction diff --git a/Ref/docs/sdd.md b/Ref/docs/sdd.md index c81ebf9970..83aa99a462 100644 --- a/Ref/docs/sdd.md +++ b/Ref/docs/sdd.md @@ -1,4 +1,3 @@ -Reference Application SDD # Reference Deployment ## 1. Description diff --git a/Svc/ActiveLogger/docs/sdd.md b/Svc/ActiveLogger/docs/sdd.md index 9f8d68bebc..059747ddca 100644 --- a/Svc/ActiveLogger/docs/sdd.md +++ b/Svc/ActiveLogger/docs/sdd.md @@ -1,4 +1,3 @@ -Svc::ActiveLogger Component SDD # Svc::ActiveLogger Component ## 1. Introduction diff --git a/Svc/ActiveRateGroup/docs/sdd.md b/Svc/ActiveRateGroup/docs/sdd.md index 2fa89cd631..51b5c276ce 100644 --- a/Svc/ActiveRateGroup/docs/sdd.md +++ b/Svc/ActiveRateGroup/docs/sdd.md @@ -1,4 +1,3 @@ -ActiveRateGroup Component SDD # RateGroupDriver Component ## 1. Introduction diff --git a/Svc/ActiveTextLogger/docs/sdd.md b/Svc/ActiveTextLogger/docs/sdd.md index 236006309d..48e279ce72 100644 --- a/Svc/ActiveTextLogger/docs/sdd.md +++ b/Svc/ActiveTextLogger/docs/sdd.md @@ -1,4 +1,3 @@ -Svc::ActiveTextLogger Component SDD # Svc::ActiveTextLogger Component ## 1. Introduction diff --git a/Svc/AssertFatalAdapter/docs/sdd.md b/Svc/AssertFatalAdapter/docs/sdd.md index 209ea66d7d..11dc3c55ac 100644 --- a/Svc/AssertFatalAdapter/docs/sdd.md +++ b/Svc/AssertFatalAdapter/docs/sdd.md @@ -1,4 +1,3 @@ -AssertFatalAdapter Component SDD # AssertFatalAdapter Component ## 1. Introduction diff --git a/Svc/BufferManager/docs/sdd.md b/Svc/BufferManager/docs/sdd.md index 63ab23a460..01eacaa206 100644 --- a/Svc/BufferManager/docs/sdd.md +++ b/Svc/BufferManager/docs/sdd.md @@ -1,4 +1,3 @@ -Svc::BufferManager # Svc::BufferManager diff --git a/Svc/CmdDispatcher/docs/sdd.md b/Svc/CmdDispatcher/docs/sdd.md index 28762fa4a6..32acb1f1a6 100644 --- a/Svc/CmdDispatcher/docs/sdd.md +++ b/Svc/CmdDispatcher/docs/sdd.md @@ -1,4 +1,3 @@ -Svc::CmdDispatcher Component SDD # Svc::CmdDispatcher Component ## 1. Introduction diff --git a/Svc/CmdSequencer/docs/sdd.md b/Svc/CmdSequencer/docs/sdd.md index 1e9ecf58b4..76a373a7b3 100644 --- a/Svc/CmdSequencer/docs/sdd.md +++ b/Svc/CmdSequencer/docs/sdd.md @@ -1,4 +1,3 @@ -Svc::CmdSequencer Component SDD # Svc::CmdSequencer Component ## 1 Introduction diff --git a/Svc/Fatal/docs/sdd.md b/Svc/Fatal/docs/sdd.md index 769031444a..ef4465264a 100644 --- a/Svc/Fatal/docs/sdd.md +++ b/Svc/Fatal/docs/sdd.md @@ -1,4 +1,3 @@ -Svc::Fatal Port SDD # Svc::Fatal Port ## 1. Introduction diff --git a/Svc/FatalHandler/docs/sdd.md b/Svc/FatalHandler/docs/sdd.md index 8cc54233cf..b95752b7a3 100644 --- a/Svc/FatalHandler/docs/sdd.md +++ b/Svc/FatalHandler/docs/sdd.md @@ -1,4 +1,3 @@ -Svc::FatalHandler Component SDD # Svc::FatalHandler Component ## 1. Introduction diff --git a/Svc/FileDownlink/docs/sdd.md b/Svc/FileDownlink/docs/sdd.md index f6acacca83..182fa7f0c1 100644 --- a/Svc/FileDownlink/docs/sdd.md +++ b/Svc/FileDownlink/docs/sdd.md @@ -1,4 +1,3 @@ -Svc::FileDownlink # Svc::FileDownlink diff --git a/Svc/FileManager/docs/sdd.md b/Svc/FileManager/docs/sdd.md index b96b035a06..e573bf6871 100644 --- a/Svc/FileManager/docs/sdd.md +++ b/Svc/FileManager/docs/sdd.md @@ -1,4 +1,3 @@ -Svc::FileManager # Svc::FileManager Component ## 1. Introduction diff --git a/Svc/FileUplink/docs/sdd.md b/Svc/FileUplink/docs/sdd.md index e879273296..ec504107c4 100644 --- a/Svc/FileUplink/docs/sdd.md +++ b/Svc/FileUplink/docs/sdd.md @@ -1,4 +1,3 @@ -Svc::FileUplink # Svc::FileUplink diff --git a/Svc/Health/docs/sdd.md b/Svc/Health/docs/sdd.md index 2bd6a7bd91..93f3f90114 100644 --- a/Svc/Health/docs/sdd.md +++ b/Svc/Health/docs/sdd.md @@ -1,4 +1,3 @@ -Svc::Health Component SDD # Svc::Health Component ## 1. Introduction diff --git a/Svc/LinuxTime/docs/sdd.md b/Svc/LinuxTime/docs/sdd.md index 4eb0fd4e79..079d75cfc4 100644 --- a/Svc/LinuxTime/docs/sdd.md +++ b/Svc/LinuxTime/docs/sdd.md @@ -1,4 +1,3 @@ -Svc::LinuxTime # Svc::LinuxTime Component ## 1. Introduction diff --git a/Svc/PassiveConsoleTextLogger/docs/sdd.md b/Svc/PassiveConsoleTextLogger/docs/sdd.md index 86969eacc9..4cf5a2129f 100644 --- a/Svc/PassiveConsoleTextLogger/docs/sdd.md +++ b/Svc/PassiveConsoleTextLogger/docs/sdd.md @@ -1,4 +1,3 @@ -Svc::PassiveConsoleTextLogger # Svc::PassiveConsoleTextLogger Component ## 1. Introduction diff --git a/Svc/Ping/docs/sdd.md b/Svc/Ping/docs/sdd.md index c71557466b..e8dd010b4a 100644 --- a/Svc/Ping/docs/sdd.md +++ b/Svc/Ping/docs/sdd.md @@ -1,4 +1,3 @@ -Svc::Ping Port SDD # Svc::Ping Port diff --git a/Svc/PolyDb/docs/sdd.md b/Svc/PolyDb/docs/sdd.md index d81804fb6c..1cec89a007 100644 --- a/Svc/PolyDb/docs/sdd.md +++ b/Svc/PolyDb/docs/sdd.md @@ -1,4 +1,3 @@ -Svc::PolyDb Component SDD # Svc::PolyDb Component ## 1. Introduction diff --git a/Svc/PolyIf/docs/sdd.md b/Svc/PolyIf/docs/sdd.md index 5a8e1ca1a0..1c133a92b1 100644 --- a/Svc/PolyIf/docs/sdd.md +++ b/Svc/PolyIf/docs/sdd.md @@ -1,4 +1,3 @@ -Svc::Poly Port SDD # Svc::Poly Port ## 1. Introduction diff --git a/Svc/PrmDb/docs/sdd.md b/Svc/PrmDb/docs/sdd.md index 41ac81100e..0dc8cb80dd 100644 --- a/Svc/PrmDb/docs/sdd.md +++ b/Svc/PrmDb/docs/sdd.md @@ -1,4 +1,3 @@ -PrmDb Component SDD # `Svc::PrmDb` Component ## 1. Introduction diff --git a/Svc/RateGroupDriver/docs/sdd.md b/Svc/RateGroupDriver/docs/sdd.md index ba374d0c52..4e7cf2af35 100644 --- a/Svc/RateGroupDriver/docs/sdd.md +++ b/Svc/RateGroupDriver/docs/sdd.md @@ -1,4 +1,3 @@ -RateGroupDriver Component SDD # RateGroupDriver Component ## 1. Introduction diff --git a/Svc/Sched/docs/sdd.md b/Svc/Sched/docs/sdd.md index 34dd11490f..6553fee28e 100644 --- a/Svc/Sched/docs/sdd.md +++ b/Svc/Sched/docs/sdd.md @@ -1,4 +1,3 @@ -Svc::Sched Port SDD # Svc::Sched Port ## 1. Introduction diff --git a/Svc/TlmChan/docs/sdd.md b/Svc/TlmChan/docs/sdd.md index 7fb4c25c73..59ca1aeb87 100644 --- a/Svc/TlmChan/docs/sdd.md +++ b/Svc/TlmChan/docs/sdd.md @@ -1,4 +1,3 @@ -TlmChan Component SDD # TlmChan Component ## 1. Introduction diff --git a/Svc/WatchDog/docs/sdd.md b/Svc/WatchDog/docs/sdd.md index 5aa97c866e..b2280c33c8 100644 --- a/Svc/WatchDog/docs/sdd.md +++ b/Svc/WatchDog/docs/sdd.md @@ -1,5 +1,3 @@ -Svc::WatchDog Port SDD - # Svc::WatchDog Port ## 1. Introduction diff --git a/Gds/docs/GDS_CLI_DEV_GUIDE.md b/docs/UsersGuide/dev/gds-cli-dev.md similarity index 98% rename from Gds/docs/GDS_CLI_DEV_GUIDE.md rename to docs/UsersGuide/dev/gds-cli-dev.md index 2574db4914..4af5ff5c3d 100644 --- a/Gds/docs/GDS_CLI_DEV_GUIDE.md +++ b/docs/UsersGuide/dev/gds-cli-dev.md @@ -42,7 +42,7 @@ This guide is for programmers who intend to maintain and develop code for the Gr ### Intended -![](proposed_architecture.png) +![](../media/proposed_architecture.png) The intended architecture for the CLI is: @@ -56,7 +56,7 @@ The CLI will interact with the GDS through an appropriate API, which the CLI mod Not including imports used only for type hints, or dependencies for modules not part of the GDS CLI source code (generated using [pydeps](https://pydeps.readthedocs.io/en/latest/): -![](overall_dependencies_edited.png) +![](../media/overall_dependencies_edited.png) *Note that the above graph has arrows pointing **to** the module that does the importing and away from the dependency, and does not include Python standard library imports* @@ -66,7 +66,7 @@ Not including imports used only for type hints, or dependencies for modules not ### Dataflow -![](cli_data_flow.svg) +![](../media/cli_data_flow.svg) ### Dependencies diff --git a/Gds/docs/testAPI/assets/APISearchLayering.png b/docs/UsersGuide/dev/testAPI/assets/APISearchLayering.png similarity index 100% rename from Gds/docs/testAPI/assets/APISearchLayering.png rename to docs/UsersGuide/dev/testAPI/assets/APISearchLayering.png diff --git a/Gds/docs/testAPI/assets/APISearchScope.png b/docs/UsersGuide/dev/testAPI/assets/APISearchScope.png similarity index 100% rename from Gds/docs/testAPI/assets/APISearchScope.png rename to docs/UsersGuide/dev/testAPI/assets/APISearchScope.png diff --git a/Gds/docs/testAPI/assets/TestFwComponentView.png b/docs/UsersGuide/dev/testAPI/assets/TestFwComponentView.png similarity index 100% rename from Gds/docs/testAPI/assets/TestFwComponentView.png rename to docs/UsersGuide/dev/testAPI/assets/TestFwComponentView.png diff --git a/Gds/docs/testAPI/assets/TestLogExample.png b/docs/UsersGuide/dev/testAPI/assets/TestLogExample.png similarity index 100% rename from Gds/docs/testAPI/assets/TestLogExample.png rename to docs/UsersGuide/dev/testAPI/assets/TestLogExample.png diff --git a/Gds/docs/testAPI/markdown/contents.md b/docs/UsersGuide/dev/testAPI/markdown/contents.md similarity index 93% rename from Gds/docs/testAPI/markdown/contents.md rename to docs/UsersGuide/dev/testAPI/markdown/contents.md index 3badf8df35..ba59dda980 100644 --- a/Gds/docs/testAPI/markdown/contents.md +++ b/docs/UsersGuide/dev/testAPI/markdown/contents.md @@ -22,4 +22,4 @@ contain the root `toctree` directive. --> * [Integration Test API User Guide](../user_guide.md) -* [GDS Overview](../../../README.md) +* [GDS Overview](../../../../../Gds/README.md) diff --git a/Gds/docs/testAPI/markdown/histories.md b/docs/UsersGuide/dev/testAPI/markdown/histories.md similarity index 100% rename from Gds/docs/testAPI/markdown/histories.md rename to docs/UsersGuide/dev/testAPI/markdown/histories.md diff --git a/Gds/docs/testAPI/markdown/integration_test_api.md b/docs/UsersGuide/dev/testAPI/markdown/integration_test_api.md similarity index 99% rename from Gds/docs/testAPI/markdown/integration_test_api.md rename to docs/UsersGuide/dev/testAPI/markdown/integration_test_api.md index 6d142c14b1..b2475b50c4 100644 --- a/Gds/docs/testAPI/markdown/integration_test_api.md +++ b/docs/UsersGuide/dev/testAPI/markdown/integration_test_api.md @@ -673,7 +673,7 @@ Args: |Quick Links| |:----------| |[Integration Test API User Guide](../user_guide.md)| -|[GDS Overview](../../../README.md)| +|[GDS Overview](../../../../../Gds/README.md)| |[Integration Test API](integration_test_api.md)| |[Histories](histories.md)| |[Predicates](predicates.md)| diff --git a/Gds/docs/testAPI/markdown/predicates.md b/docs/UsersGuide/dev/testAPI/markdown/predicates.md similarity index 96% rename from Gds/docs/testAPI/markdown/predicates.md rename to docs/UsersGuide/dev/testAPI/markdown/predicates.md index af489511b5..179a2921a1 100644 --- a/Gds/docs/testAPI/markdown/predicates.md +++ b/docs/UsersGuide/dev/testAPI/markdown/predicates.md @@ -36,7 +36,7 @@ Args: |Quick Links| |:----------| |[Integration Test API User Guide](../user_guide.md)| -|[GDS Overview](../../../README.md)| +|[GDS Overview](../../../../../Gds/README.md)| |[Integration Test API](integration_test_api.md)| |[Histories](histories.md)| |[Predicates](predicates.md)| diff --git a/Gds/docs/testAPI/markdown/standard_pipeline.md b/docs/UsersGuide/dev/testAPI/markdown/standard_pipeline.md similarity index 99% rename from Gds/docs/testAPI/markdown/standard_pipeline.md rename to docs/UsersGuide/dev/testAPI/markdown/standard_pipeline.md index 3b6c6add79..f057a0423b 100644 --- a/Gds/docs/testAPI/markdown/standard_pipeline.md +++ b/docs/UsersGuide/dev/testAPI/markdown/standard_pipeline.md @@ -166,7 +166,7 @@ Returns: |Quick Links| |:----------| |[Integration Test API User Guide](../user_guide.md)| -|[GDS Overview](../../../README.md)| +|[GDS Overview](../../../../../Gds/README.md)| |[Integration Test API](integration_test_api.md)| |[Histories](histories.md)| |[Predicates](predicates.md)| diff --git a/Gds/docs/testAPI/markdown/test_logger.md b/docs/UsersGuide/dev/testAPI/markdown/test_logger.md similarity index 98% rename from Gds/docs/testAPI/markdown/test_logger.md rename to docs/UsersGuide/dev/testAPI/markdown/test_logger.md index 3e0aa6a8cf..59c2f6c8fe 100644 --- a/Gds/docs/testAPI/markdown/test_logger.md +++ b/docs/UsersGuide/dev/testAPI/markdown/test_logger.md @@ -70,7 +70,7 @@ Saves the write-only workbook. Should be called only once when the log is comple |Quick Links| |:----------| |[Integration Test API User Guide](../user_guide.md)| -|[GDS Overview](../../../README.md)| +|[GDS Overview](../../../../../Gds/README.md)| |[Integration Test API](integration_test_api.md)| |[Histories](histories.md)| |[Predicates](predicates.md)| diff --git a/Gds/docs/testAPI/markdown/time_type.md b/docs/UsersGuide/dev/testAPI/markdown/time_type.md similarity index 99% rename from Gds/docs/testAPI/markdown/time_type.md rename to docs/UsersGuide/dev/testAPI/markdown/time_type.md index 0aae1a152c..ecc65fac74 100644 --- a/Gds/docs/testAPI/markdown/time_type.md +++ b/docs/UsersGuide/dev/testAPI/markdown/time_type.md @@ -227,7 +227,7 @@ Returns: |Quick Links| |:----------| |[Integration Test API User Guide](../user_guide.md)| -|[GDS Overview](../../../README.md)| +|[GDS Overview](../../../../../Gds/README.md)| |[Integration Test API](integration_test_api.md)| |[Histories](histories.md)| |[Predicates](predicates.md)| diff --git a/Gds/docs/testAPI/presentations/CodeReview.pdf b/docs/UsersGuide/dev/testAPI/presentations/CodeReview.pdf similarity index 100% rename from Gds/docs/testAPI/presentations/CodeReview.pdf rename to docs/UsersGuide/dev/testAPI/presentations/CodeReview.pdf diff --git a/Gds/docs/testAPI/presentations/DesignDiscussion.pdf b/docs/UsersGuide/dev/testAPI/presentations/DesignDiscussion.pdf similarity index 100% rename from Gds/docs/testAPI/presentations/DesignDiscussion.pdf rename to docs/UsersGuide/dev/testAPI/presentations/DesignDiscussion.pdf diff --git a/Gds/docs/testAPI/presentations/ProjectNotes.pdf b/docs/UsersGuide/dev/testAPI/presentations/ProjectNotes.pdf similarity index 100% rename from Gds/docs/testAPI/presentations/ProjectNotes.pdf rename to docs/UsersGuide/dev/testAPI/presentations/ProjectNotes.pdf diff --git a/Gds/docs/testAPI/sphinx/.gitignore b/docs/UsersGuide/dev/testAPI/sphinx/.gitignore similarity index 100% rename from Gds/docs/testAPI/sphinx/.gitignore rename to docs/UsersGuide/dev/testAPI/sphinx/.gitignore diff --git a/Gds/docs/testAPI/sphinx/Makefile b/docs/UsersGuide/dev/testAPI/sphinx/Makefile similarity index 100% rename from Gds/docs/testAPI/sphinx/Makefile rename to docs/UsersGuide/dev/testAPI/sphinx/Makefile diff --git a/Gds/docs/testAPI/sphinx/make.bat b/docs/UsersGuide/dev/testAPI/sphinx/make.bat similarity index 100% rename from Gds/docs/testAPI/sphinx/make.bat rename to docs/UsersGuide/dev/testAPI/sphinx/make.bat diff --git a/Gds/docs/testAPI/sphinx/source/conf.py b/docs/UsersGuide/dev/testAPI/sphinx/source/conf.py similarity index 100% rename from Gds/docs/testAPI/sphinx/source/conf.py rename to docs/UsersGuide/dev/testAPI/sphinx/source/conf.py diff --git a/Gds/docs/testAPI/sphinx/source/histories.rst b/docs/UsersGuide/dev/testAPI/sphinx/source/histories.rst similarity index 100% rename from Gds/docs/testAPI/sphinx/source/histories.rst rename to docs/UsersGuide/dev/testAPI/sphinx/source/histories.rst diff --git a/Gds/docs/testAPI/sphinx/source/index.rst b/docs/UsersGuide/dev/testAPI/sphinx/source/index.rst similarity index 100% rename from Gds/docs/testAPI/sphinx/source/index.rst rename to docs/UsersGuide/dev/testAPI/sphinx/source/index.rst diff --git a/Gds/docs/testAPI/sphinx/source/integration_test_api.rst b/docs/UsersGuide/dev/testAPI/sphinx/source/integration_test_api.rst similarity index 100% rename from Gds/docs/testAPI/sphinx/source/integration_test_api.rst rename to docs/UsersGuide/dev/testAPI/sphinx/source/integration_test_api.rst diff --git a/Gds/docs/testAPI/sphinx/source/predicates.rst b/docs/UsersGuide/dev/testAPI/sphinx/source/predicates.rst similarity index 100% rename from Gds/docs/testAPI/sphinx/source/predicates.rst rename to docs/UsersGuide/dev/testAPI/sphinx/source/predicates.rst diff --git a/Gds/docs/testAPI/sphinx/source/standard_pipeline.rst b/docs/UsersGuide/dev/testAPI/sphinx/source/standard_pipeline.rst similarity index 100% rename from Gds/docs/testAPI/sphinx/source/standard_pipeline.rst rename to docs/UsersGuide/dev/testAPI/sphinx/source/standard_pipeline.rst diff --git a/Gds/docs/testAPI/sphinx/source/test_logger.rst b/docs/UsersGuide/dev/testAPI/sphinx/source/test_logger.rst similarity index 100% rename from Gds/docs/testAPI/sphinx/source/test_logger.rst rename to docs/UsersGuide/dev/testAPI/sphinx/source/test_logger.rst diff --git a/Gds/docs/testAPI/sphinx/source/time_type.rst b/docs/UsersGuide/dev/testAPI/sphinx/source/time_type.rst similarity index 100% rename from Gds/docs/testAPI/sphinx/source/time_type.rst rename to docs/UsersGuide/dev/testAPI/sphinx/source/time_type.rst diff --git a/Gds/docs/testAPI/user_guide.md b/docs/UsersGuide/dev/testAPI/user_guide.md similarity index 97% rename from Gds/docs/testAPI/user_guide.md rename to docs/UsersGuide/dev/testAPI/user_guide.md index f63534600c..83d4e6ec6f 100644 --- a/Gds/docs/testAPI/user_guide.md +++ b/docs/UsersGuide/dev/testAPI/user_guide.md @@ -8,7 +8,7 @@ This integration test API was developed by Kevin Oran in the summer of 2019. *** -To work with the integration test API, the user must first create an instance of the StandardPipeline and then instantiate the API. This is boiler plate code that should be [moved inside the TestAPI](#moving-standardpipeline-to-api-constructor). The following code snippet accomplishes directing the GDS to a deployment dictionary, connecting to a running deployment, and finally instantiating the test API. This snippet **DOES NOT** run the GDS TCP Server or run an F Prime deployment. An example script to run the Ref App deployment without a GDS Tool can be found [here](../../../Ref/scripts/run_ref_for_int_test.sh). +To work with the integration test API, the user must first create an instance of the StandardPipeline and then instantiate the API. This is boiler plate code that should be [moved inside the TestAPI](#moving-standardpipeline-to-api-constructor). The following code snippet accomplishes directing the GDS to a deployment dictionary, connecting to a running deployment, and finally instantiating the test API. This snippet **DOES NOT** run the GDS TCP Server or run an F Prime deployment. An example script to run the Ref App deployment without a GDS Tool can be found [here](../../../../Ref/scripts/run_ref_for_int_test.sh). ~~~~{.python} from fprime_gds.common.pipeline.standard import StandardPipeline @@ -39,7 +39,7 @@ To use the test API with a testing framework like unittest or pytest there are f 3. Third, the framework should call any number of associated test cases. 4. Finally, the test framework should call a **one-time** teardown method to save the API at. -Below is an example of these steps using unittest. For an example of this using pytest, see the Ref App [integration tests](../../../Ref/test/int/ref_integration_test.py). +Below is an example of these steps using unittest. For an example of this using pytest, see the Ref App [integration tests](../../../../Ref/test/int/ref_integration_test.py). ~~~~{.python} import unittest @@ -90,12 +90,12 @@ if __name__ == "__main__": *** -All usage patterns are written such that they would be compatible with the test framework example described above: each test case assumes that the histories were recently emptied and that the `self.api` field is a connected instance of the integration test API. For simplicity, usage examples will rely on mock flight software dictionaries that were used in the integration test API unit tests. This dictionary can be found [here](../../test/fprime_gds/common/testing_fw/UnitTestDictionary.xml). +All usage patterns are written such that they would be compatible with the test framework example described above: each test case assumes that the histories were recently emptied and that the `self.api` field is a connected instance of the integration test API. For simplicity, usage examples will rely on mock flight software dictionaries that were used in the integration test API unit tests. This dictionary can be found [here](../../../../Gds/test/fprime_gds/common/testing_fw/UnitTestDictionary.xml). -If a user would like to play with the test API in a unit testing environment they could append their own test cases to the unit tests [here](../../test/fprime_gds/common/testing_fw/api_unit_test.py). +If a user would like to play with the test API in a unit testing environment they could append their own test cases to the unit tests [here](../../../../Gds/test/fprime_gds/common/testing_fw/api_unit_test.py). **NOTE**: there is no F Prime deployment in these unit tests so data objects need to be added manually. -If a user would like to experiment with integration tests on an actual F Prime application, they could modify the Ref app [integration tests](../../../Ref/test/int/ref_integration_test.py). +If a user would like to experiment with integration tests on an actual F Prime application, they could modify the Ref app [integration tests](../../../../Ref/test/int/ref_integration_test.py). **NOTE**: running integration tests requires building and running the Ref app. ### Sending Commands @@ -564,7 +564,7 @@ gt_pred("string") # evaluates False: String is not a value that is greater than *** -The following libraries were added to the [GDS pip requirements file](../../../mk/python/pip_required_gds.txt). +The following libraries were added to the [GDS pip requirements file](../../../../mk/python/pip_required_gds.txt). | Library| Provides| | :--| :--| @@ -694,7 +694,7 @@ The following table summarizes the color meanings from API-generated messages. ### Predicates -The integration test API uses predicates for filtering, searching and asserting. A predicate is a callable class that evaluates if an object/value satisfies a certain property. Predicates used by the API are defined [here](../../src/fprime_gds/common/testing_fw/predicates.py). The API uses Duck Typing to determine what can and cannot be used as a predicate; therefore, a user of the API can very easily create their own. Below is a table of how predicates are organized with a brief summary of each section: +The integration test API uses predicates for filtering, searching and asserting. A predicate is a callable class that evaluates if an object/value satisfies a certain property. Predicates used by the API are defined [here](../../../../Gds/src/fprime_gds/common/testing_fw/predicates.py). The API uses Duck Typing to determine what can and cannot be used as a predicate; therefore, a user of the API can very easily create their own. Below is a table of how predicates are organized with a brief summary of each section: | Predicate Section| Section Description| Functions/predicates| | :----| :----| :----| @@ -719,7 +719,7 @@ I see two options to address this: ### The openpyxl library has thrown WorkbookAlreadySaved error -While running unit tests on the API, there was an error thrown by openpyxl that caused the log to close early. The behavior wasn't able to be recreated, but the [Test Logger](../../src/fprime_gds/common/logger/test_logger.py) was updated to [catch the exception](https://github.jpl.nasa.gov/FPRIME/fprime-sw/blob/717bc6fab85c53680108fc961cad6338e779816f/Gds/src/fprime_gds/common/logger/test_logger.py#L124) to prevent tests from failing due to the logger. +While running unit tests on the API, there was an error thrown by openpyxl that caused the log to close early. The behavior wasn't able to be recreated, but the [Test Logger](../../../../Gds/src/fprime_gds/common/logger/test_logger.py) was updated to [catch the exception](https://github.jpl.nasa.gov/FPRIME/fprime-sw/blob/717bc6fab85c53680108fc961cad6338e779816f/Gds/src/fprime_gds/common/logger/test_logger.py#L124) to prevent tests from failing due to the logger. ~~~~ ___________________________________ APITestCases.test_find_history_item _________________________________ diff --git a/docs/UsersGuide/gds/gds-cli.md b/docs/UsersGuide/gds/gds-cli.md index a0cfb56c4b..0fde862ed2 100644 --- a/docs/UsersGuide/gds/gds-cli.md +++ b/docs/UsersGuide/gds/gds-cli.md @@ -5,7 +5,7 @@ how it can be used, and a detailed reference for interested users. `fprime-cli` features without the need for a graphical environment. This enables projects easier access to F´ testing and operations in more environments. -**Note:** Developer documentation is available in the [developer's CLI guide](../../../Gds/docs/GDS_CLI_DEV_GUIDE.md). +**Note:** Developer documentation is available in the [developer's CLI guide](../dev/gds-cli-dev.md). - [What is `fprime-cli`?](#what-is-fprime-cli) - [Getting Started](#getting-started) diff --git a/docs/UsersGuide/guide.md b/docs/UsersGuide/guide.md index 0f690fdf95..c45b5e5eb0 100644 --- a/docs/UsersGuide/guide.md +++ b/docs/UsersGuide/guide.md @@ -55,6 +55,7 @@ The API documentation section contains the automatically generated documentation - [Constructing the F´ Topology](./dev/building-topology.md) - [Asserts in F´](./dev/assert.md) - [GDS Dashboard Reference](./dev/gds-dashboard-reference.md) + - [Integration Test API](./dev/testAPI/user_guide.md) - Advanced F´ Topics: - [F´ Python Guidelines](./dev/py-dev.md) - [Porting F´ To a New Platform](./dev/porting-guide.md) @@ -62,6 +63,8 @@ The API documentation section contains the automatically generated documentation - [Configuring an IDE for Use With F´](./dev/configure-ide.md) - [OS Layer Description](./dev/os-docs.md) - API Documentation + - [GDS CLI Design](./dev/gds-cli-dev.md) + ## F´ Source Tree F´ Out of the Box Items diff --git a/Gds/docs/cli_data_flow.svg b/docs/UsersGuide/media/cli_data_flow.svg similarity index 100% rename from Gds/docs/cli_data_flow.svg rename to docs/UsersGuide/media/cli_data_flow.svg diff --git a/Gds/docs/gds_example_extension.jpg b/docs/UsersGuide/media/gds_example_extension.jpg similarity index 100% rename from Gds/docs/gds_example_extension.jpg rename to docs/UsersGuide/media/gds_example_extension.jpg diff --git a/Gds/docs/gds_layout.jpg b/docs/UsersGuide/media/gds_layout.jpg similarity index 100% rename from Gds/docs/gds_layout.jpg rename to docs/UsersGuide/media/gds_layout.jpg diff --git a/Gds/docs/gds_loaders.jpg b/docs/UsersGuide/media/gds_loaders.jpg similarity index 100% rename from Gds/docs/gds_loaders.jpg rename to docs/UsersGuide/media/gds_loaders.jpg diff --git a/Gds/docs/overall_dependencies.svg b/docs/UsersGuide/media/overall_dependencies.svg similarity index 100% rename from Gds/docs/overall_dependencies.svg rename to docs/UsersGuide/media/overall_dependencies.svg diff --git a/Gds/docs/overall_dependencies_edited.png b/docs/UsersGuide/media/overall_dependencies_edited.png similarity index 100% rename from Gds/docs/overall_dependencies_edited.png rename to docs/UsersGuide/media/overall_dependencies_edited.png diff --git a/Gds/docs/proposed_architecture.png b/docs/UsersGuide/media/proposed_architecture.png similarity index 100% rename from Gds/docs/proposed_architecture.png rename to docs/UsersGuide/media/proposed_architecture.png