From 7ece4d9e48959dad616d19387629bf06787fa762 Mon Sep 17 00:00:00 2001 From: Markus Bechter Date: Thu, 12 Dec 2024 18:07:31 +0100 Subject: [PATCH] docs: Add MVP features Issue-ref: see #56 --- docs/features/analysis-infra/index.rst | 19 +++++++++++++++++ .../logging/console-output/index.rst | 16 ++++++++++++++ .../features/analysis-infra/logging/index.rst | 20 ++++++++++++++++++ .../logging/mw-log-api/index.rst | 16 ++++++++++++++ docs/features/communication/index.rst | 20 ++++++++++++++++++ docs/features/communication/ipc/index.rst | 16 ++++++++++++++ .../fixed-order-execution/index.rst | 16 ++++++++++++++ docs/features/frameworks/index.rst | 21 +++++++++++++++++++ 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, 201 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 0000000..5df68e8 --- /dev/null +++ b/docs/features/analysis-infra/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 + # ******************************************************************************* + +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 0000000..1ef9f5e --- /dev/null +++ b/docs/features/analysis-infra/logging/console-output/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 + # ******************************************************************************* + +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 0000000..c727b73 --- /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 0000000..04e6ec3 --- /dev/null +++ b/docs/features/analysis-infra/logging/mw-log-api/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 + # ******************************************************************************* + +Logging API +########### diff --git a/docs/features/communication/index.rst b/docs/features/communication/index.rst new file mode 100644 index 0000000..204425b --- /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 0000000..ce7b68d --- /dev/null +++ b/docs/features/communication/ipc/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 + # ******************************************************************************* + +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 0000000..2727669 --- /dev/null +++ b/docs/features/frameworks/fixed-order-execution/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 + # ******************************************************************************* + +Fixed order execution Framework +############################### diff --git a/docs/features/frameworks/index.rst b/docs/features/frameworks/index.rst new file mode 100644 index 0000000..7a8bd6c --- /dev/null +++ b/docs/features/frameworks/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 + # ******************************************************************************* + + +Frameworks +########## + +.. toctree:: + + fixed-order-execution/index.rst diff --git a/docs/features/index.rst b/docs/features/index.rst index 17c01be..16a5c80 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 0000000..ebfd99f --- /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 0000000..e177869 --- /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 0000000..fe92882 --- /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 +#################