You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@celix.apache.org by rl...@apache.org on 2020/07/19 18:08:12 UTC
[celix] 01/01: Add page titles to documentation
This is an automated email from the ASF dual-hosted git repository.
rlenferink pushed a commit to branch add-titles
in repository https://gitbox.apache.org/repos/asf/celix.git
commit 62aad4f89f301781959e0870a75c0da06076934a
Author: Roy Lenferink <le...@gmail.com>
AuthorDate: Sun Jul 19 20:07:51 2020 +0200
Add page titles to documentation
---
CHANGES.md | 4 ++++
bundles/deployment_admin/README.md | 4 ++++
bundles/device_access/README.md | 4 ++++
bundles/device_access/example/base_driver/README.md | 4 ++++
bundles/device_access/example/consuming_driver/README.md | 4 ++++
bundles/device_access/example/refining_driver/README.md | 4 ++++
bundles/http_admin/README.md | 4 ++++
bundles/logging/README.md | 4 ++++
bundles/logging/log_writers/README.md | 4 ++++
bundles/pubsub/README.md | 4 ++++
bundles/pubsub/examples/keys/README.md | 4 ++++
bundles/pubsub/pubsub_admin_udp_mc/README.md | 4 ++++
bundles/remote_services/README.md | 6 ++++--
bundles/remote_services/discovery_etcd/README.md | 4 ++++
bundles/remote_services/remote_service_admin_dfi/README.md | 4 ++++
bundles/remote_services/remote_services_api/README.md | 4 ++++
bundles/remote_services/rsa_spi/README.md | 4 ++++
bundles/remote_services/topology_manager/README.md | 4 ++++
bundles/shell/remote_shell/README.md | 4 ++++
bundles/shell/shell/README.md | 4 ++++
bundles/shell/shell_tui/README.md | 4 ++++
bundles/shell/shell_wui/README.md | 4 ++++
documents/building/README.md | 4 ++++
documents/cmake_commands/README.md | 4 ++++
documents/getting_started/README.md | 4 ++++
documents/getting_started/creating_a_simple_bundle.md | 4 ++++
documents/getting_started/using_services_with_c.md | 4 ++++
documents/getting_started/using_services_with_cxx.md | 4 ++++
documents/intro/README.md | 4 ++++
documents/subprojects/README.md | 4 ++++
examples/celix-examples/README.md | 4 ++++
examples/celix-examples/http_example/README.md | 7 ++++---
examples/celix-examples/services_example_c/README.md | 4 ++++
libs/dependency_manager/README.md | 4 ++++
libs/dependency_manager/TODO.md | 6 +++++-
libs/dependency_manager_cxx/README.md | 4 ++++
libs/dependency_manager_cxx/TODO.md | 6 +++++-
libs/etcdlib/README.md | 4 ++++
libs/launcher/README.md | 4 ++++
libs/utils/README.md | 4 ++++
misc/experimental/README.md | 4 ++++
misc/experimental/bundles/config_admin/README.md | 4 ++++
misc/experimental/promise/README.md | 4 ++++
43 files changed, 174 insertions(+), 7 deletions(-)
diff --git a/CHANGES.md b/CHANGES.md
index 62ce2b5..b112f90 100644
--- a/CHANGES.md
+++ b/CHANGES.md
@@ -1,3 +1,7 @@
+---
+title: Changes
+---
+
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
diff --git a/bundles/deployment_admin/README.md b/bundles/deployment_admin/README.md
index 72fe8e2..d31f0c7 100644
--- a/bundles/deployment_admin/README.md
+++ b/bundles/deployment_admin/README.md
@@ -1,3 +1,7 @@
+---
+title: Deployment Admin
+---
+
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
diff --git a/bundles/device_access/README.md b/bundles/device_access/README.md
index 5b30d88..f93e0e8 100644
--- a/bundles/device_access/README.md
+++ b/bundles/device_access/README.md
@@ -1,3 +1,7 @@
+---
+title: Device Access
+---
+
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
diff --git a/bundles/device_access/example/base_driver/README.md b/bundles/device_access/example/base_driver/README.md
index 6d9b80a..9173a0d 100644
--- a/bundles/device_access/example/base_driver/README.md
+++ b/bundles/device_access/example/base_driver/README.md
@@ -1,3 +1,7 @@
+---
+title: Base driver
+---
+
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
diff --git a/bundles/device_access/example/consuming_driver/README.md b/bundles/device_access/example/consuming_driver/README.md
index 32af292..7b3c3eb 100644
--- a/bundles/device_access/example/consuming_driver/README.md
+++ b/bundles/device_access/example/consuming_driver/README.md
@@ -1,3 +1,7 @@
+---
+title: Consuming driver
+---
+
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
diff --git a/bundles/device_access/example/refining_driver/README.md b/bundles/device_access/example/refining_driver/README.md
index 404d3f5..d5e4485 100644
--- a/bundles/device_access/example/refining_driver/README.md
+++ b/bundles/device_access/example/refining_driver/README.md
@@ -1,3 +1,7 @@
+---
+title: Refining driver
+---
+
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
diff --git a/bundles/http_admin/README.md b/bundles/http_admin/README.md
index b47ee0f..796b0ca 100755
--- a/bundles/http_admin/README.md
+++ b/bundles/http_admin/README.md
@@ -1,3 +1,7 @@
+---
+title: HTTP Admin
+---
+
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
diff --git a/bundles/logging/README.md b/bundles/logging/README.md
index 16ce094..9700384 100644
--- a/bundles/logging/README.md
+++ b/bundles/logging/README.md
@@ -1,3 +1,7 @@
+---
+title: Logging Facilities
+---
+
# Celix Logging Facilities
The Celix Logging facility is service oriented and logging technology agnostic logging solution.
diff --git a/bundles/logging/log_writers/README.md b/bundles/logging/log_writers/README.md
index fa91ee4..715b5f7 100644
--- a/bundles/logging/log_writers/README.md
+++ b/bundles/logging/log_writers/README.md
@@ -1,3 +1,7 @@
+---
+title: Log Writers
+---
+
# Log Writer
The Celix Log Writers are components that sinks log from the Celix log service to different backends.
diff --git a/bundles/pubsub/README.md b/bundles/pubsub/README.md
index 3d1003c..744cfd9 100644
--- a/bundles/pubsub/README.md
+++ b/bundles/pubsub/README.md
@@ -1,3 +1,7 @@
+---
+title: Publisher / subscriber implementation
+---
+
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
diff --git a/bundles/pubsub/examples/keys/README.md b/bundles/pubsub/examples/keys/README.md
index 80a1163..b46438b 100644
--- a/bundles/pubsub/examples/keys/README.md
+++ b/bundles/pubsub/examples/keys/README.md
@@ -1,3 +1,7 @@
+---
+title: Pubsub Keys
+---
+
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
diff --git a/bundles/pubsub/pubsub_admin_udp_mc/README.md b/bundles/pubsub/pubsub_admin_udp_mc/README.md
index ff31fc0..42cbaa4 100644
--- a/bundles/pubsub/pubsub_admin_udp_mc/README.md
+++ b/bundles/pubsub/pubsub_admin_udp_mc/README.md
@@ -1,3 +1,7 @@
+---
+title: PSA UDP Multicast
+---
+
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
diff --git a/bundles/remote_services/README.md b/bundles/remote_services/README.md
index 3c1d962..f09869b 100644
--- a/bundles/remote_services/README.md
+++ b/bundles/remote_services/README.md
@@ -1,3 +1,7 @@
+---
+title: Remote Service Admin Service
+---
+
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
@@ -15,8 +19,6 @@ See the License for the specific language governing permissions and
limitations under the License.
-->
-Title: Apache Celix Remote Service Admin Service
-
## Introduction
The Remote Service Admin Service subproject contains an adapted implementation of the OSGi Enterprise Remote Service Admin Service Specification. The subproject consists of three parts, each described in more detail in the following sections.
diff --git a/bundles/remote_services/discovery_etcd/README.md b/bundles/remote_services/discovery_etcd/README.md
index 9af0fba..58316ed 100644
--- a/bundles/remote_services/discovery_etcd/README.md
+++ b/bundles/remote_services/discovery_etcd/README.md
@@ -1,3 +1,7 @@
+---
+title: Discovery ETCD
+---
+
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
diff --git a/bundles/remote_services/remote_service_admin_dfi/README.md b/bundles/remote_services/remote_service_admin_dfi/README.md
index 47123b7..06082b1 100644
--- a/bundles/remote_services/remote_service_admin_dfi/README.md
+++ b/bundles/remote_services/remote_service_admin_dfi/README.md
@@ -1,3 +1,7 @@
+---
+title: Remote Service Admin DFI
+---
+
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
diff --git a/bundles/remote_services/remote_services_api/README.md b/bundles/remote_services/remote_services_api/README.md
index 38b149f..37d13da 100644
--- a/bundles/remote_services/remote_services_api/README.md
+++ b/bundles/remote_services/remote_services_api/README.md
@@ -1,3 +1,7 @@
+---
+title: Remote Services API
+---
+
# Remote Service Admin
The Remote Service Admin (RSA) provides the mechanisms to import and export services when instructed to do so by the Topology Manager.
diff --git a/bundles/remote_services/rsa_spi/README.md b/bundles/remote_services/rsa_spi/README.md
index 38b149f..102364e 100644
--- a/bundles/remote_services/rsa_spi/README.md
+++ b/bundles/remote_services/rsa_spi/README.md
@@ -1,3 +1,7 @@
+---
+title: Remote Services SPI
+---
+
# Remote Service Admin
The Remote Service Admin (RSA) provides the mechanisms to import and export services when instructed to do so by the Topology Manager.
diff --git a/bundles/remote_services/topology_manager/README.md b/bundles/remote_services/topology_manager/README.md
index 6200cc4..085a911 100644
--- a/bundles/remote_services/topology_manager/README.md
+++ b/bundles/remote_services/topology_manager/README.md
@@ -1,3 +1,7 @@
+---
+title: RSA Topology Manager
+---
+
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
diff --git a/bundles/shell/remote_shell/README.md b/bundles/shell/remote_shell/README.md
index af28421..ede1755 100644
--- a/bundles/shell/remote_shell/README.md
+++ b/bundles/shell/remote_shell/README.md
@@ -1,3 +1,7 @@
+---
+title: Remote Shell
+---
+
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
diff --git a/bundles/shell/shell/README.md b/bundles/shell/shell/README.md
index d9f38af..b8280d6 100644
--- a/bundles/shell/shell/README.md
+++ b/bundles/shell/shell/README.md
@@ -1,3 +1,7 @@
+---
+title: Shell
+---
+
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
diff --git a/bundles/shell/shell_tui/README.md b/bundles/shell/shell_tui/README.md
index 130fb6e..3027c90 100644
--- a/bundles/shell/shell_tui/README.md
+++ b/bundles/shell/shell_tui/README.md
@@ -1,3 +1,7 @@
+---
+title: Shell TUI
+---
+
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
diff --git a/bundles/shell/shell_wui/README.md b/bundles/shell/shell_wui/README.md
index 37c714b..ed374c4 100644
--- a/bundles/shell/shell_wui/README.md
+++ b/bundles/shell/shell_wui/README.md
@@ -1,3 +1,7 @@
+---
+title: Shell WUI
+---
+
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
diff --git a/documents/building/README.md b/documents/building/README.md
index a505ee0..06e26df 100644
--- a/documents/building/README.md
+++ b/documents/building/README.md
@@ -1,3 +1,7 @@
+---
+title: Building and Installing
+---
+
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
diff --git a/documents/cmake_commands/README.md b/documents/cmake_commands/README.md
index 26426dd..92ce35d 100644
--- a/documents/cmake_commands/README.md
+++ b/documents/cmake_commands/README.md
@@ -1,3 +1,7 @@
+---
+title: CMake Commands
+---
+
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
diff --git a/documents/getting_started/README.md b/documents/getting_started/README.md
index 17ea2a6..33a4535 100644
--- a/documents/getting_started/README.md
+++ b/documents/getting_started/README.md
@@ -1,3 +1,7 @@
+---
+title: Getting Started Guide
+---
+
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
diff --git a/documents/getting_started/creating_a_simple_bundle.md b/documents/getting_started/creating_a_simple_bundle.md
index 13f61da..56375b4 100644
--- a/documents/getting_started/creating_a_simple_bundle.md
+++ b/documents/getting_started/creating_a_simple_bundle.md
@@ -1,3 +1,7 @@
+---
+title: Creating a Simple Bundle
+---
+
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
diff --git a/documents/getting_started/using_services_with_c.md b/documents/getting_started/using_services_with_c.md
index 1e5a2c5..c59967a 100644
--- a/documents/getting_started/using_services_with_c.md
+++ b/documents/getting_started/using_services_with_c.md
@@ -1,3 +1,7 @@
+---
+title: Using Services with C
+---
+
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
diff --git a/documents/getting_started/using_services_with_cxx.md b/documents/getting_started/using_services_with_cxx.md
index d4690b6..b797baa 100644
--- a/documents/getting_started/using_services_with_cxx.md
+++ b/documents/getting_started/using_services_with_cxx.md
@@ -1,3 +1,7 @@
+---
+title: Using Services with C++
+---
+
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
diff --git a/documents/intro/README.md b/documents/intro/README.md
index 5f489f8..6fab3d7 100644
--- a/documents/intro/README.md
+++ b/documents/intro/README.md
@@ -1,3 +1,7 @@
+---
+title: Introduction
+---
+
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
diff --git a/documents/subprojects/README.md b/documents/subprojects/README.md
index e5485fb..e9fc3a0 100644
--- a/documents/subprojects/README.md
+++ b/documents/subprojects/README.md
@@ -1,3 +1,7 @@
+---
+title: Subprojects
+---
+
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
diff --git a/examples/celix-examples/README.md b/examples/celix-examples/README.md
index 5bc365c..0c26134 100644
--- a/examples/celix-examples/README.md
+++ b/examples/celix-examples/README.md
@@ -1,3 +1,7 @@
+---
+title: Celix Examples
+---
+
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
diff --git a/examples/celix-examples/http_example/README.md b/examples/celix-examples/http_example/README.md
index 4ff61d2..688cab0 100644
--- a/examples/celix-examples/http_example/README.md
+++ b/examples/celix-examples/http_example/README.md
@@ -1,3 +1,7 @@
+---
+title: HTTP Example
+---
+
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
@@ -25,6 +29,3 @@ bundles to create a `http_example_cnt` Celix container.
The `http_example_cnt` Celix container shows how you can create a use existing http/websocket services.
After running the container browse to localhost:8080.
Under the /shell uri you find the `Celix::shell_wui` functionality and under /hello uri you find the `http_example` functionality
-
-
-
diff --git a/examples/celix-examples/services_example_c/README.md b/examples/celix-examples/services_example_c/README.md
index ab3f36e..6fa7112 100644
--- a/examples/celix-examples/services_example_c/README.md
+++ b/examples/celix-examples/services_example_c/README.md
@@ -1,3 +1,7 @@
+---
+title: Services example C
+---
+
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
diff --git a/libs/dependency_manager/README.md b/libs/dependency_manager/README.md
index a1a83ad..6e57595 100644
--- a/libs/dependency_manager/README.md
+++ b/libs/dependency_manager/README.md
@@ -1,3 +1,7 @@
+---
+title: Dependency Manager
+---
+
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
diff --git a/libs/dependency_manager/TODO.md b/libs/dependency_manager/TODO.md
index a344048..a6a7ce1 100644
--- a/libs/dependency_manager/TODO.md
+++ b/libs/dependency_manager/TODO.md
@@ -1,3 +1,7 @@
+---
+title: TODO Dependency Manager
+---
+
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
@@ -17,5 +21,5 @@ limitations under the License.
# TODO integrate dep man into framework
-- Update documentetion for CELIX_GEN_BUNDLE_ACTIVATOR usage and removal of dep manager libs / shell_dm
+- Update documentation for CELIX_GEN_BUNDLE_ACTIVATOR usage and removal of dep manager libs / shell_dm
- Move documentation
diff --git a/libs/dependency_manager_cxx/README.md b/libs/dependency_manager_cxx/README.md
index 0befc68..c01fc10 100644
--- a/libs/dependency_manager_cxx/README.md
+++ b/libs/dependency_manager_cxx/README.md
@@ -1,3 +1,7 @@
+---
+title: C++ Dependency Manager
+---
+
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
diff --git a/libs/dependency_manager_cxx/TODO.md b/libs/dependency_manager_cxx/TODO.md
index 9127511..ad16896 100644
--- a/libs/dependency_manager_cxx/TODO.md
+++ b/libs/dependency_manager_cxx/TODO.md
@@ -1,3 +1,7 @@
+---
+title: TODO C++ Dependency Manager
+---
+
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
@@ -17,5 +21,5 @@ limitations under the License.
# TODO integrate cxx dep man into framework
-- Update documentetion for CELIX_GEN_CXX_BUNDLE_ACTIVATOR usage and removal of dep manager libs / shell_dm
+- Update documentation for CELIX_GEN_CXX_BUNDLE_ACTIVATOR usage and removal of dep manager libs / shell_dm
- Move documentation
diff --git a/libs/etcdlib/README.md b/libs/etcdlib/README.md
index a4dbac1..fd7e080 100644
--- a/libs/etcdlib/README.md
+++ b/libs/etcdlib/README.md
@@ -1,3 +1,7 @@
+---
+title: Etcdlib
+---
+
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
diff --git a/libs/launcher/README.md b/libs/launcher/README.md
index 513ac7e..cfcadcc 100644
--- a/libs/launcher/README.md
+++ b/libs/launcher/README.md
@@ -1,3 +1,7 @@
+---
+title: Launcher
+---
+
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
diff --git a/libs/utils/README.md b/libs/utils/README.md
index 1cf67d8..3928526 100644
--- a/libs/utils/README.md
+++ b/libs/utils/README.md
@@ -1,3 +1,7 @@
+---
+title: Utils
+---
+
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
diff --git a/misc/experimental/README.md b/misc/experimental/README.md
index d56c614..34728bb 100644
--- a/misc/experimental/README.md
+++ b/misc/experimental/README.md
@@ -1,3 +1,7 @@
+---
+title: Experimental
+---
+
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
diff --git a/misc/experimental/bundles/config_admin/README.md b/misc/experimental/bundles/config_admin/README.md
index f3dce1f..e6c3341 100644
--- a/misc/experimental/bundles/config_admin/README.md
+++ b/misc/experimental/bundles/config_admin/README.md
@@ -1,3 +1,7 @@
+---
+title: Configuration Admin
+---
+
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
diff --git a/misc/experimental/promise/README.md b/misc/experimental/promise/README.md
index fd5c652..97c2ae8 100644
--- a/misc/experimental/promise/README.md
+++ b/misc/experimental/promise/README.md
@@ -1,3 +1,7 @@
+---
+title: Promises
+---
+
# Celix Promises
Celix Promises are based on the OSGI Promises (OSGi Compendium Release 7 Specification, Chapter 705).