From c559cbaf521ce2b3f0d6657de9687ac8fdb24e2a Mon Sep 17 00:00:00 2001 From: Markus Bechter Date: Thu, 12 Dec 2024 18:07:31 +0100 Subject: [PATCH] Add MVP features Issue-ref: see #56 --- docs/features/analysis-infra/index.rst | 5 +++++ .../logging/console-output/index.rst | 2 ++ .../features/analysis-infra/logging/index.rst | 20 ++++++++++++++++++ .../logging/mw-log-api/index.rst | 2 ++ docs/features/communication/index.rst | 20 ++++++++++++++++++ docs/features/communication/ipc/index.rst | 2 ++ .../fixed-order-execution/index.rst | 2 ++ docs/features/frameworks/index.rst | 19 +++++++++++++++++ docs/features/index.rst | 4 ++++ .../persistency/file-access/index.rst | 16 ++++++++++++++ docs/features/persistency/index.rst | 21 +++++++++++++++++++ .../persistency/key-value-storage/index.rst | 16 ++++++++++++++ 12 files changed, 129 insertions(+) create mode 100644 docs/features/analysis-infra/index.rst create mode 100644 docs/features/analysis-infra/logging/console-output/index.rst create mode 100644 docs/features/analysis-infra/logging/index.rst create mode 100644 docs/features/analysis-infra/logging/mw-log-api/index.rst create mode 100644 docs/features/communication/index.rst create mode 100644 docs/features/communication/ipc/index.rst create mode 100644 docs/features/frameworks/fixed-order-execution/index.rst create mode 100644 docs/features/frameworks/index.rst create mode 100644 docs/features/persistency/file-access/index.rst create mode 100644 docs/features/persistency/index.rst create mode 100644 docs/features/persistency/key-value-storage/index.rst diff --git a/docs/features/analysis-infra/index.rst b/docs/features/analysis-infra/index.rst new file mode 100644 index 00000000..b9ce1d72 --- /dev/null +++ b/docs/features/analysis-infra/index.rst @@ -0,0 +1,5 @@ +Analysis Infrastructure +####################### + +.. toctree:: + logging/index.rst diff --git a/docs/features/analysis-infra/logging/console-output/index.rst b/docs/features/analysis-infra/logging/console-output/index.rst new file mode 100644 index 00000000..b960767e --- /dev/null +++ b/docs/features/analysis-infra/logging/console-output/index.rst @@ -0,0 +1,2 @@ +Console Output +############## diff --git a/docs/features/analysis-infra/logging/index.rst b/docs/features/analysis-infra/logging/index.rst new file mode 100644 index 00000000..c727b73c --- /dev/null +++ b/docs/features/analysis-infra/logging/index.rst @@ -0,0 +1,20 @@ +.. + # ******************************************************************************* + # Copyright (c) 2024 Contributors to the Eclipse Foundation + # + # See the NOTICE file(s) distributed with this work for additional + # information regarding copyright ownership. + # + # This program and the accompanying materials are made available under the + # terms of the Apache License Version 2.0 which is available at + # https://www.apache.org/licenses/LICENSE-2.0 + # + # SPDX-License-Identifier: Apache-2.0 + # ******************************************************************************* + +Logging +####### + +.. toctree:: + console-output/index.rst + mw-log-api/index.rst diff --git a/docs/features/analysis-infra/logging/mw-log-api/index.rst b/docs/features/analysis-infra/logging/mw-log-api/index.rst new file mode 100644 index 00000000..efc60f23 --- /dev/null +++ b/docs/features/analysis-infra/logging/mw-log-api/index.rst @@ -0,0 +1,2 @@ +Logging API +########### diff --git a/docs/features/communication/index.rst b/docs/features/communication/index.rst new file mode 100644 index 00000000..204425b3 --- /dev/null +++ b/docs/features/communication/index.rst @@ -0,0 +1,20 @@ +.. + # ******************************************************************************* + # Copyright (c) 2024 Contributors to the Eclipse Foundation + # + # See the NOTICE file(s) distributed with this work for additional + # information regarding copyright ownership. + # + # This program and the accompanying materials are made available under the + # terms of the Apache License Version 2.0 which is available at + # https://www.apache.org/licenses/LICENSE-2.0 + # + # SPDX-License-Identifier: Apache-2.0 + # ******************************************************************************* + +Communication +############# + +.. toctree:: + + ipc/index.rst diff --git a/docs/features/communication/ipc/index.rst b/docs/features/communication/ipc/index.rst new file mode 100644 index 00000000..040253b5 --- /dev/null +++ b/docs/features/communication/ipc/index.rst @@ -0,0 +1,2 @@ +Inter-process Communication +########################### diff --git a/docs/features/frameworks/fixed-order-execution/index.rst b/docs/features/frameworks/fixed-order-execution/index.rst new file mode 100644 index 00000000..591713a9 --- /dev/null +++ b/docs/features/frameworks/fixed-order-execution/index.rst @@ -0,0 +1,2 @@ +Fixed order execution Framework +############################### diff --git a/docs/features/frameworks/index.rst b/docs/features/frameworks/index.rst new file mode 100644 index 00000000..326a52fa --- /dev/null +++ b/docs/features/frameworks/index.rst @@ -0,0 +1,19 @@ +.. + # ******************************************************************************* + # Copyright (c) 2024 Contributors to the Eclipse Foundation + # + # See the NOTICE file(s) distributed with this work for additional + # information regarding copyright ownership. + # + # This program and the accompanying materials are made available under the + # terms of the Apache License Version 2.0 which is available at + # https://www.apache.org/licenses/LICENSE-2.0 + # + # SPDX-License-Identifier: Apache-2.0 + # ******************************************************************************* + +Frameworks +########## + +.. toctree:: + fixed-order-execution/index.rst diff --git a/docs/features/index.rst b/docs/features/index.rst index 17c01bec..16a5c809 100644 --- a/docs/features/index.rst +++ b/docs/features/index.rst @@ -23,3 +23,7 @@ Features infrastructure/index.rst integration/index.rst + analysis-infra/index.rst + communication/index.rst + frameworks/index.rst + persistency/index.rst diff --git a/docs/features/persistency/file-access/index.rst b/docs/features/persistency/file-access/index.rst new file mode 100644 index 00000000..ebfd99f1 --- /dev/null +++ b/docs/features/persistency/file-access/index.rst @@ -0,0 +1,16 @@ +.. + # ******************************************************************************* + # Copyright (c) 2024 Contributors to the Eclipse Foundation + # + # See the NOTICE file(s) distributed with this work for additional + # information regarding copyright ownership. + # + # This program and the accompanying materials are made available under the + # terms of the Apache License Version 2.0 which is available at + # https://www.apache.org/licenses/LICENSE-2.0 + # + # SPDX-License-Identifier: Apache-2.0 + # ******************************************************************************* + +File Access +########### diff --git a/docs/features/persistency/index.rst b/docs/features/persistency/index.rst new file mode 100644 index 00000000..e177869c --- /dev/null +++ b/docs/features/persistency/index.rst @@ -0,0 +1,21 @@ +.. + # ******************************************************************************* + # Copyright (c) 2024 Contributors to the Eclipse Foundation + # + # See the NOTICE file(s) distributed with this work for additional + # information regarding copyright ownership. + # + # This program and the accompanying materials are made available under the + # terms of the Apache License Version 2.0 which is available at + # https://www.apache.org/licenses/LICENSE-2.0 + # + # SPDX-License-Identifier: Apache-2.0 + # ******************************************************************************* + +Persistency +########### + +.. toctree:: + + file-access/index.rst + key-value-storage/index.rst diff --git a/docs/features/persistency/key-value-storage/index.rst b/docs/features/persistency/key-value-storage/index.rst new file mode 100644 index 00000000..fe928829 --- /dev/null +++ b/docs/features/persistency/key-value-storage/index.rst @@ -0,0 +1,16 @@ +.. + # ******************************************************************************* + # Copyright (c) 2024 Contributors to the Eclipse Foundation + # + # See the NOTICE file(s) distributed with this work for additional + # information regarding copyright ownership. + # + # This program and the accompanying materials are made available under the + # terms of the Apache License Version 2.0 which is available at + # https://www.apache.org/licenses/LICENSE-2.0 + # + # SPDX-License-Identifier: Apache-2.0 + # ******************************************************************************* + +Key-value Storage +#################