Cleaning up app names, descriptions and categories.

Change-Id: I684fdf23fcd8a8078d82bc6ff5e3d1af664b20c2
2025-10-14 17:01:02 +02:00 · 2017-08-28 10:47:48 -07:00 · 2017-08-28 10:47:48 -07:00 · c98aa2a8a8
commit c98aa2a8a8
parent 4070c04945
12 changed files with 47 additions and 38 deletions
--- a/apps/faultmanagement/BUCK
+++ b/apps/faultmanagement/BUCK
@ -5,10 +5,11 @@ BUNDLES = [
    '//apps/faultmanagement/fmweb:onos-apps-faultmanagement-fmweb',
 ]

-onos_app (
-  title = 'Fault Management',
-  description = 'ONOS fault management application',
-  category = 'Monitoring',
-  url = 'https://wiki.onosproject.org/display/ONOS/Fault+Management',
-  included_bundles = BUNDLES,
+onos_app(
+    title = 'Fault Management',
+    description = 'Provides managements of alarms. Stores retrieved alarms from devices. ' +
+        'Offers CLI, UI and REST integration to obtain and display them from ONOS.',
+    category = 'Monitoring',
+    url = 'https://wiki.onosproject.org/display/ONOS/Fault+Management',
+    included_bundles = BUNDLES,
 )
--- a/apps/netconf/client/BUCK
+++ b/apps/netconf/client/BUCK
@ -1,28 +1,29 @@
 APPS = [
-  'org.onosproject.yang',
-  'org.onosproject.config',
-  'org.onosproject.netconf',
+    'org.onosproject.yang',
+    'org.onosproject.config',
+    'org.onosproject.netconf',
 ]

 COMPILE_DEPS = [
-  '//lib:CORE_DEPS',
-  '//lib:onos-yang-model',
-  '//lib:onos-yang-runtime',
-  '//apps/config:onos-apps-config',
-  '//utils/misc:onlab-misc',
-  '//protocols/netconf/api:onos-protocols-netconf-api',
-  '//utils/osgi:onlab-osgi',
+    '//lib:CORE_DEPS',
+    '//lib:onos-yang-model',
+    '//lib:onos-yang-runtime',
+    '//apps/config:onos-apps-config',
+    '//utils/misc:onlab-misc',
+    '//protocols/netconf/api:onos-protocols-netconf-api',
+    '//utils/osgi:onlab-osgi',
 ]

 osgi_jar_with_tests(
-  deps = COMPILE_DEPS,
+    deps = COMPILE_DEPS,
 )

 onos_app(
-  app_name = 'org.onosproject.netconfsb',
-  title = 'NETCONF Device Configuration',
-  category = 'Protocol',
-  url = 'http://onosproject.org',
-  description = 'Extension to allow ONOS to configure NETCONF devices.',
-  required_apps = APPS,
+    app_name = 'org.onosproject.netconfsb',
+    title = 'NETCONF Protocol Subsystem',
+    category = 'Protocol',
+    url = 'http://onosproject.org',
+    description = 'Exposes APIs to establish NETCONF connections to devices and to send and receive ' +
+        'messages and asynchronous notifications over such connection.',
+    required_apps = APPS,
 )
--- a/apps/network-troubleshoot/BUCK
+++ b/apps/network-troubleshoot/BUCK
@ -5,8 +5,8 @@ BUNDLES = [
 ]

 onos_app (
-  title = 'Network Trouble-Shooter',
-  description = 'ONOS Network Trouble-Shooting utility',
+  title = 'Network Troubleshooter',
+  description = 'Provides various network troubleshooting utilities.',
  category = 'Utility',
  url = 'https://wiki.onosproject.org/display/ONOS/Network+TroubleShooting+Module',
  included_bundles = BUNDLES,
--- a/apps/pcep-api/BUCK
+++ b/apps/pcep-api/BUCK
@ -11,7 +11,7 @@ osgi_jar_with_tests (

 onos_app (
    title = 'PCEP Protocol API',
-    category = 'Traffic Steering',
+    category = 'Protocol',
    url = 'http://onosproject.org',
    description = 'PCEP protocol API.',
 )
--- a/bucklets/yang.bucklet
+++ b/bucklets/yang.bucklet
@ -69,7 +69,7 @@ def yang_model(
    onos_app (
      app_name = app_name,
      title = title,
-      category = 'Model',
+      category = 'Models',
      url = url,
      description = description,
      required_apps = [ 'org.onosproject.yang' ],
--- a/drivers/p4runtime/BUCK
+++ b/drivers/p4runtime/BUCK
@ -17,7 +17,7 @@ osgi_jar(

 onos_app (
    app_name = 'org.onosproject.drivers.p4runtime',
-    title = 'P4 Runtime Drivers',
+    title = 'P4Runtime Drivers',
    category = 'Drivers',
    url = 'http://onosproject.org',
    description = 'Adds support for devices using P4 Runtime protocol.',
--- a/protocols/grpc/BUCK
+++ b/protocols/grpc/BUCK
@ -33,6 +33,8 @@ onos_app (
    title = 'gRPC Protocol Subsystem',
    category = 'Protocol',
    url = 'http://onosproject.org',
-    description = 'ONOS gRPC protocol subsystem',
+    description = 'Exposes APIs to setup, manage and teardown gRPC Managed channels with devices. ' +
+        'Also offers channel observer registration and removal capabilities. ' +
+        'The exposed APis abstract low level channel operations.',
    included_bundles = BUNDLES,
 )
--- a/providers/netconf/BUCK
+++ b/providers/netconf/BUCK
@ -13,10 +13,12 @@ EXCLUDED_BUNDLES = [
 onos_app (
    title = 'NETCONF Provider',
    category = 'Provider',
-    url = 'http://onosproject.org',
+    url = 'https://wiki.onosproject.org/display/ONOS/NETCONF',
    included_bundles = BUNDLES,
    excluded_bundles = EXCLUDED_BUNDLES,
-    description = 'NETCONF protocol southbound providers.',
+    description = 'Provides means for ONOS to discover and trigger the initial handshake procedure ' +
+        'with NETCONF from information given by network configuration.' +
+        'Also provides capabilities for receiving asynchronous alarm notifications from devices.',
    required_apps = [ 'org.onosproject.faultmanagement'],
 )

--- a/providers/openflow/base/BUCK
+++ b/providers/openflow/base/BUCK
@ -17,7 +17,7 @@ onos_app (
    app_name = 'org.onosproject.openflow-base',
    title = 'OpenFlow Base Provider',
    category = 'Provider',
-    url = 'http://onosproject.org',
+    url = 'https://wiki.onosproject.org/display/ONOS/OpenFlow',
    description = 'Provides the base suite of device, flow and packet providers that rely on the ' +
        'OpenFlow protocol to interact with network devices.',
    included_bundles = BUNDLES,
--- a/providers/rest/BUCK
+++ b/providers/rest/BUCK
@ -12,8 +12,9 @@ onos_app (
    app_name = 'org.onosproject.restsb',
    title = 'REST Provider',
    category = 'Provider',
-    url = 'http://onosproject.org',
+    url = 'https://wiki.onosproject.org/display/ONOS/REST',
    included_bundles = BUNDLES,
-    description = 'REST protocol southbound providers.',
+    description = 'Provides means for ONOS to discover the existence of a REST API enabled device ' +
+        'or proxy for multiple devices from information given by network configuration.',
 )

--- a/providers/snmp/BUCK
+++ b/providers/snmp/BUCK
@ -13,7 +13,8 @@ onos_app (
    app_name = 'org.onosproject.snmp',
    title = 'SNMP Provider',
    category = 'Provider',
-    url = 'http://onosproject.org',
+    url = 'https://wiki.onosproject.org/display/ONOS/SNMP',
    included_bundles = BUNDLES,
-    description = 'SNMP providers.',
+    description = 'Provides means for ONOS to discover and trigger the initial handshake procedure ' +
+        'with SNMP enabled devices from information given by network configuration.',
 )
--- a/providers/tl1/BUCK
+++ b/providers/tl1/BUCK
@ -7,7 +7,8 @@ onos_app (
    app_name = 'org.onosproject.tl1',
    title = 'TL1 Provider',
    category = 'Provider',
-    url = 'http://onosproject.org',
+    url = 'https://wiki.onosproject.org/display/ONOS/TL1',
    included_bundles = BUNDLES,
-    description = 'TL1 protocol southbound providers.',
+    description = 'Provides means for ONOS to discover and trigger the initial handshake procedure ' +
+        'with TL1 enable devices from information given by network configuration.',
 )