From 85355120257f03174f384fa118c12f9ebc89412a Mon Sep 17 00:00:00 2001 From: Andreas Pfau Date: Thu, 28 Nov 2024 16:22:31 +0100 Subject: [PATCH 1/3] chore(limes): remove ressource link from nav (#1471) --- config/navigations/services_navigation.rb | 694 +++++++++--------- .../app/views/resources/v2/project.html.haml | 17 +- 2 files changed, 355 insertions(+), 356 deletions(-) diff --git a/config/navigations/services_navigation.rb b/config/navigations/services_navigation.rb index 6ac65dad7a..f62b4ce6f6 100644 --- a/config/navigations/services_navigation.rb +++ b/config/navigations/services_navigation.rb @@ -6,11 +6,11 @@ # navigation.renderer = Your::Custom::Renderer # Specify the class that will be applied to active navigation items. Defaults to 'selected' - navigation.selected_class = "active" + navigation.selected_class = 'active' # Specify the class that will be applied to the current leaf of # active navigation items. Defaults to 'simple-navigation-active-leaf' - navigation.active_leaf_class = "nav-active-leaf" + navigation.active_leaf_class = 'nav-active-leaf' # Specify if item keys are added to navigation items as id. Defaults to true # navigation.autogenerate_item_ids = true @@ -57,460 +57,460 @@ # primary.item :compute, - "Compute", - nil, - html: { - class: "fancy-nav-header", - "data-icon": "compute-icon" - }, - if: - lambda { - (services.available?(:compute, :instances) || - services.available?(:image, :os_images)) && ( - plugin_available?(:block_storage) || - plugin_available?(:compute) || - plugin_available?(:image)) - } do |compute_nav| + 'Compute', + nil, + html: { + class: 'fancy-nav-header', + "data-icon": 'compute-icon' + }, + if: + lambda { + (services.available?(:compute, :instances) || + services.available?(:image, :os_images)) && ( + plugin_available?(:block_storage) || + plugin_available?(:compute) || + plugin_available?(:image)) + } do |compute_nav| compute_nav.item :instances, - "Servers", - -> { plugin("compute").instances_path }, - if: -> do - services.available?(:compute, :instances) && - plugin_available?(:compute) - end, - highlights_on: - proc { params[:controller][%r{compute/instances}] } + 'Servers', + -> { plugin('compute').instances_path }, + if: lambda { + services.available?(:compute, :instances) && + plugin_available?(:compute) + }, + highlights_on: + proc { params[:controller][%r{compute/instances}] } compute_nav.item :block_storage, - "Volumes & Snapshots", - -> { plugin("block_storage").root_path + "?r=" }, - if: -> { plugin_available?(:block_storage) }, - highlights_on: - proc { params[:controller][/block_storage/] } + 'Volumes & Snapshots', + -> { plugin('block_storage').root_path + '?r=' }, + if: -> { plugin_available?(:block_storage) }, + highlights_on: + proc { params[:controller][/block_storage/] } compute_nav.item :images, - "Server Images & Snapshots", - lambda { - if Gem::Version.new( - services.image.current_version.gsub("v", "") - ) >= Gem::Version.new("2.5") - plugin("image").ng_path + "?r=" - else - plugin("image").os_images_public_index_path - end - }, - if: -> do - current_user.has_service?("image") && - plugin_available?(:image) - end, - highlights_on: proc { params[:controller][%r{image/.*}] } + 'Server Images & Snapshots', + lambda { + if Gem::Version.new( + services.image.current_version.gsub('v', '') + ) >= Gem::Version.new('2.5') + plugin('image').ng_path + '?r=' + else + plugin('image').os_images_public_index_path + end + }, + if: lambda { + current_user.has_service?('image') && + plugin_available?(:image) + }, + highlights_on: proc { params[:controller][%r{image/.*}] } compute_nav.item :flavors, - "Flavors", - -> { plugin("compute").flavors_path }, - if: -> { plugin_available?(:compute) }, - highlights_on: -> do - params[:controller][%r{flavors/?.*}] - end + 'Flavors', + -> { plugin('compute').flavors_path }, + if: -> { plugin_available?(:compute) }, + highlights_on: lambda { + params[:controller][%r{flavors/?.*}] + } end primary.item :containers, - "Containers", - nil, - html: { - class: "fancy-nav-header", - "data-icon": "containers-icon" - }, - if: - lambda { - plugin_available?(:kubernetes) && current_user && - current_user.has_service?("kubernikus") - } do |containers_nav| + 'Containers', + nil, + html: { + class: 'fancy-nav-header', + "data-icon": 'containers-icon' + }, + if: + lambda { + plugin_available?(:kubernetes) && current_user && + current_user.has_service?('kubernikus') + } do |containers_nav| containers_nav.item :kubernetes, - "Kubernetes", - -> { plugin("kubernetes").root_path }, + 'Kubernetes', + -> { plugin('kubernetes').root_path }, if: lambda { plugin_available?(:kubernetes) && current_user && - current_user.has_service?("kubernikus") + current_user.has_service?('kubernikus') }, highlights_on: proc { params[:controller][%r{kubernetes/.*}] } end primary.item :automation, - "Monsoon Automation", - nil, - html: { - class: "fancy-nav-header", - "data-icon": "automation-icon" - }, - if: -> { - services.available?(:automation, :nodes) && - plugin_available?(:automation) + 'Monsoon Automation', + nil, + html: { + class: 'fancy-nav-header', + "data-icon": 'automation-icon' + }, + if: lambda { + services.available?(:automation, :nodes) && + plugin_available?(:automation) } do |automation_nav| automation_nav.item :automation, - "Automation", - -> { plugin("automation").nodes_path }, - if: -> do + 'Automation', + -> { plugin('automation').nodes_path }, + if: lambda { services.available?(:automation, :nodes) && plugin_available?(:automation) - end, + }, highlights_on: proc { params[:controller][%r{automation/.*}] } end primary.item :hana, - "Bare Metal Data Processing & HANA", - nil, - html: { - class: "fancy-nav-header", - "data-icon": "hana-icon" - }, - if: -> { - services.available?(:bare_metal_hana, :nodes) && - plugin_available?(:bare_metal_hana) + 'Bare Metal Data Processing & HANA', + nil, + html: { + class: 'fancy-nav-header', + "data-icon": 'hana-icon' + }, + if: lambda { + services.available?(:bare_metal_hana, :nodes) && + plugin_available?(:bare_metal_hana) } do |bare_metal_hana_nav| bare_metal_hana_nav.item :bare_metal_hana, - "HANA Servers", - -> { plugin("bare_metal_hana").entry_path }, - if: -> do - services.available?( - :bare_metal_hana, - :nodes - ) && plugin_available?(:bare_metal_hana) - end, - highlights_on: - proc { - params[:controller][%r{bare_metal_hana/.*}] - } + 'HANA Servers', + -> { plugin('bare_metal_hana').entry_path }, + if: lambda { + services.available?( + :bare_metal_hana, + :nodes + ) && plugin_available?(:bare_metal_hana) + }, + highlights_on: + proc { + params[:controller][%r{bare_metal_hana/.*}] + } end primary.item :api, - "API Access", - nil, - html: { - class: "fancy-nav-header", - "data-icon": "api-icon" - }, - if: -> { - (services.available?(:webconsole) && plugin_available?(:webconsole)) || - plugin_available?(:identity) - } do |api_nav| + 'API Access', + nil, + html: { + class: 'fancy-nav-header', + "data-icon": 'api-icon' + }, + if: lambda { + (services.available?(:webconsole) && plugin_available?(:webconsole)) || + plugin_available?(:identity) + } do |api_nav| api_nav.item :web_console, - "Web Shell", - -> { plugin("webconsole").root_path }, - if: - lambda { - services.available?(:webconsole) && current_user && - current_user.is_allowed?( - "webconsole:application_get" - ) && plugin_available?(:webconsole) - }, - highlights_on: - proc { params[:controller][%r{webconsole/.*}] } + 'Web Shell', + -> { plugin('webconsole').root_path }, + if: + lambda { + services.available?(:webconsole) && current_user && + current_user.is_allowed?( + 'webconsole:application_get' + ) && plugin_available?(:webconsole) + }, + highlights_on: + proc { params[:controller][%r{webconsole/.*}] } api_nav.item :api_endpoints, - "API Endpoints for Clients", - -> { plugin("identity").projects_api_endpoints_path }, - if: -> { plugin_available?(:identity) } + 'API Endpoints for Clients', + -> { plugin('identity').projects_api_endpoints_path }, + if: -> { plugin_available?(:identity) } end primary.item :access_management, - "Authorizations", - nil, - html: { - class: "fancy-nav-header", - "data-icon": "access_management-icon" - }, - if: - lambda { - plugin_available?(:key_manager) or - (plugin_available?(:identity) && services.available?(:identity) and - current_user && - ( - current_user.is_allowed?( - "identity:project_member_list" - ) or - ( - current_user && - current_user.is_allowed?( - "identity:project_group_list" - ) - ) - ) - ) - } do |access_management_nav| + 'Authorizations', + nil, + html: { + class: 'fancy-nav-header', + "data-icon": 'access_management-icon' + }, + if: + lambda { + plugin_available?(:key_manager) or + (plugin_available?(:identity) && services.available?(:identity) and + current_user && + ( + current_user.is_allowed?( + 'identity:project_member_list' + ) or + ( + current_user && + current_user.is_allowed?( + 'identity:project_group_list' + ) + ) + ) + ) + } do |access_management_nav| access_management_nav.item :user_role_assignments, - "User Role Assignments", - -> do - plugin( - "identity" - ).projects_role_assignments_path - end, - if: -> do - current_user.is_allowed?( - "identity:project_member_list" - ) && plugin_available?(:identity) - end, - highlights_on: - %r{identity/projects/members/?.*} + 'User Role Assignments', + lambda { + plugin( + 'identity' + ).projects_role_assignments_path + }, + if: lambda { + current_user.is_allowed?( + 'identity:project_member_list' + ) && plugin_available?(:identity) + }, + highlights_on: + %r{identity/projects/members/?.*} access_management_nav.item :group_management, - "Group Role Assignments", - -> do - plugin( - "identity" - ).projects_role_assignments_path( - active_tab: "groupRoles" - ) - end, - if: -> do - current_user.is_allowed?( - "identity:project_group_list" - ) && plugin_available?(:identity) - end, - highlights_on: %r{identity/projects/groups/?.*} + 'Group Role Assignments', + lambda { + plugin( + 'identity' + ).projects_role_assignments_path( + active_tab: 'groupRoles' + ) + }, + if: lambda { + current_user.is_allowed?( + 'identity:project_group_list' + ) && plugin_available?(:identity) + }, + highlights_on: %r{identity/projects/groups/?.*} access_management_nav.item :key_manager, - "Key Manager", - -> { plugin("key_manager").secrets_path }, - if: -> do - services.available?(:key_manager) && - plugin_available?(:key_manager) - end, - highlights_on: - proc { - params[:controller][%r{key_manager/.*}] - } + 'Key Manager', + -> { plugin('key_manager').secrets_path }, + if: lambda { + services.available?(:key_manager) && + plugin_available?(:key_manager) + }, + highlights_on: + proc { + params[:controller][%r{key_manager/.*}] + } end primary.item :networking, - "Networking & Loadbalancing", - nil, - html: { - class: "fancy-nav-header", - "data-icon": "networking-icon" - }, - if: - lambda { - plugin_available?(:networking) || - plugin_available?(:lbaas2) || - plugin_available?(:dns_service) - } do |networking_nav| + 'Networking & Loadbalancing', + nil, + html: { + class: 'fancy-nav-header', + "data-icon": 'networking-icon' + }, + if: + lambda { + plugin_available?(:networking) || + plugin_available?(:lbaas2) || + plugin_available?(:dns_service) + } do |networking_nav| networking_nav.item :networks, - "Networks & Routers", - -> do - plugin("networking").networks_external_index_path + - "?preview=true" - end, + 'Networks & Routers', + lambda { + plugin('networking').networks_external_index_path + + '?preview=true' + }, if: -> { plugin_available?(:networking) }, highlights_on: %r{networking/(networks|routers|widget/bgp-vpns)/?.*} networking_nav.item :backup_networks, - "Backup Networks", - -> { plugin("networking").backup_networks_path }, + 'Backup Networks', + -> { plugin('networking').backup_networks_path }, if: -> { plugin_available?(:networking) }, highlights_on: %r{networking/(backup_networks)/?.*} networking_nav.item :ports, - "Fixed IPs / Ports", - -> { plugin("networking").ports_widget_path }, + 'Fixed IPs / Ports', + -> { plugin('networking').ports_widget_path }, if: -> { plugin_available?(:networking) }, highlights_on: %r{networking/widget/ports/?.*} networking_nav.item :floating_ips, - "Floating IPs", - -> { plugin("networking").floating_ips_path }, + 'Floating IPs', + -> { plugin('networking').floating_ips_path }, if: -> { plugin_available?(:networking) }, highlights_on: %r{networking/floating_ips/?.*} networking_nav.item :security_groups, - "Security Groups", - -> do - plugin("networking").security_groups_widget_path - end, + 'Security Groups', + lambda { + plugin('networking').security_groups_widget_path + }, if: -> { plugin_available?(:networking) }, highlights_on: %r{networking/widget/security-groups/?.*} networking_nav.item :loadbalancing, - "Load Balancers", - -> { plugin("lbaas2").root_path() + "?r=/" }, - if: -> do + 'Load Balancers', + -> { plugin('lbaas2').root_path + '?r=/' }, + if: lambda { plugin_available?(:lbaas2) && services.available?(:lbaas2) - end, - highlights_on: -> do + }, + highlights_on: lambda { params[:controller][%r{lbaas2/?.*}] - end + } networking_nav.item :dns_service, - "DNS", - -> { plugin("dns_service").zones_path }, - if: -> do + 'DNS', + -> { plugin('dns_service').zones_path }, + if: lambda { plugin_available?(:dns_service) && services.available?(:dns_service) - end, - highlights_on: -> do + }, + highlights_on: lambda { params[:controller][%r{dns_service/?.*}] - end + } end primary.item :storage, - "Storage", - nil, - html: { - class: "fancy-nav-header", - "data-icon": "storage-icon" - }, - if: - lambda { - plugin_available?(:object_storage) || - plugin_available?(:keppel) || - plugin_available?(:shared_filesystem_storage) - } do |storage_nav| + 'Storage', + nil, + html: { + class: 'fancy-nav-header', + "data-icon": 'storage-icon' + }, + if: + lambda { + plugin_available?(:object_storage) || + plugin_available?(:keppel) || + plugin_available?(:shared_filesystem_storage) + } do |storage_nav| storage_nav.item :shared_storage, - "Shared Object Storage", - -> { plugin("object_storage").service_path(service_name: "swift") }, - if: -> do - current_user.has_service?("object-store") && - plugin_available?(:object_storage) - end, - highlights_on: - proc { params[:controller][%r{object_storage/.*}] } + 'Shared Object Storage', + -> { plugin('object_storage').service_path(service_name: 'swift') }, + if: lambda { + current_user.has_service?('object-store') && + plugin_available?(:object_storage) + }, + highlights_on: + proc { params[:controller][%r{object_storage/.*}] } storage_nav.item :shared_storage_ceph, - capture { - concat "Shared Object Storage " - concat content_tag( - :span, "ceph", class: "label label-info" - ) - }, - -> { plugin("object_storage").service_path(service_name: "ceph") }, - if: -> do - current_user.has_service?("object-store-ceph") && - plugin_available?(:object_storage) && - @active_project&.tags && @active_project.tags.include?("ceph") - end, - highlights_on: - proc { params[:controller][%r{object_storage/.*}] } + capture { + concat 'Shared Object Storage ' + concat content_tag( + :span, 'ceph', class: 'label label-info' + ) + }, + -> { plugin('object_storage').service_path(service_name: 'ceph') }, + if: lambda { + current_user.has_service?('object-store-ceph') && + plugin_available?(:object_storage) && + @active_project&.tags && @active_project.tags.include?('ceph') + }, + highlights_on: + proc { params[:controller][%r{object_storage/.*}] } storage_nav.item :shared_filesystem_storage, - "Shared File System Storage", - -> do - plugin("shared_filesystem_storage").start_path( - "shares" - ) + "?r=" - end, - if: - lambda { - services.available?(:shared_filesystem_storage) and - current_user.is_allowed?( - "shared_filesystem_storage:application_get" - ) && plugin_available?(:shared_filesystem_storage) - }, - highlights_on: - proc { - params[:controller][%r{shared_filesystem_storage/.*}] - } + 'Shared File System Storage', + lambda { + plugin('shared_filesystem_storage').start_path( + 'shares' + ) + '?r=' + }, + if: + lambda { + services.available?(:shared_filesystem_storage) and + current_user.is_allowed?( + 'shared_filesystem_storage:application_get' + ) && plugin_available?(:shared_filesystem_storage) + }, + highlights_on: + proc { + params[:controller][%r{shared_filesystem_storage/.*}] + } storage_nav.item :container_image_registry, - "Container Image Registry", - -> { plugin("keppel").start_path }, - if: -> do - services.available?(:keppel) && - plugin_available?(:keppel) - end, - highlights_on: - proc { params[:controller][%r{keppel/.*}] } + 'Container Image Registry', + -> { plugin('keppel').start_path }, + if: lambda { + services.available?(:keppel) && + plugin_available?(:keppel) + }, + highlights_on: + proc { params[:controller][%r{keppel/.*}] } end primary.item :resource_management, - "Capacity, Masterdata & Metrics", - nil, - html: { - class: "fancy-nav-header", - "data-icon": "monitoring-icon" - }, - if: - lambda { - (services.available?(:resources) && plugin_available?(:resources)) || - (services.available?(:masterdata_cockpit) && plugin_available?(:masterdata_cockpit)) && - plugin_available?(:resources) || - plugin_available?(:metrics) || - plugin_available?(:audit) || - plugin_available?(:reports) - } do |monitoring_nav| + 'Capacity, Masterdata & Metrics', + nil, + html: { + class: 'fancy-nav-header', + "data-icon": 'monitoring-icon' + }, + if: + lambda { + (services.available?(:resources) && plugin_available?(:resources) && current_user.is_allowed?('resources:project:edit')) || + (services.available?(:masterdata_cockpit) && plugin_available?(:masterdata_cockpit)) && + plugin_available?(:resources) || + plugin_available?(:metrics) || + plugin_available?(:audit) || + plugin_available?(:reports) + } do |monitoring_nav| monitoring_nav.item :resources, - "Resource Management", - -> { plugin("resources").v2_project_path }, - if: -> do + 'Resource Management', + -> { plugin('resources').v2_project_path }, + if: lambda { # current_region.start_with?("qa-") && - plugin_available?(:resources) - end, + plugin_available?(:resources) && current_user.is_allowed?('resources:project:edit') + }, highlights_on: proc { params[:controller][%r{resources/v2}] } monitoring_nav.item :masterdata_cockpit, - "Masterdata", - -> do - plugin("masterdata_cockpit").project_masterdata_path - end, - if: -> do + 'Masterdata', + lambda { + plugin('masterdata_cockpit').project_masterdata_path + }, + if: lambda { services.available?(:masterdata_cockpit) && plugin_available?(:masterdata_cockpit) - end, + }, highlights_on: proc { params[:controller][%r{masterdata_cockpit/.*}] } monitoring_nav.item :metrics, - "Metrics", - -> { plugin("metrics").index_path }, + 'Metrics', + -> { plugin('metrics').index_path }, if: -> { plugin_available?(:metrics) }, highlights_on: proc { params[:controller][%r{metrics/.*}] } monitoring_nav.item :audit, - "Audit", - -> { plugin("audit").root_path }, + 'Audit', + -> { plugin('audit').root_path }, if: -> { plugin_available?(:audit) }, - highlights_on: -> do + highlights_on: lambda { params[:controller][%r{audit/?.*}] - end + } monitoring_nav.item :reports, - "Cost Report", - -> { plugin("reports").project_cost_index_path }, + 'Cost Report', + -> { plugin('reports').project_cost_index_path }, if: -> { plugin_available?(:reports) }, - highlights_on: -> do + highlights_on: lambda { params[:controller][%r{reports/?.*}] - end + } end primary.item :services, - "Services", - nil, - html: { - class: "fancy-nav-header", - "data-icon": "service-icon" - }, - if: - lambda { - services.available?(:email_service) and - plugin_available?(:email_service) - } do |services_nav| + 'Services', + nil, + html: { + class: 'fancy-nav-header', + "data-icon": 'service-icon' + }, + if: + lambda { + services.available?(:email_service) and + plugin_available?(:email_service) + } do |services_nav| services_nav.item :email_service, - "Email", - -> { plugin("email_service").index_path }, + 'Email', + -> { plugin('email_service').index_path }, if: -> { plugin_available?(:email_service) }, - highlights_on: -> do + highlights_on: lambda { params[:controller][%r{email_service/?.*}] - end + } end primary.item :cc_tools, - "Tools", - nil, - html: { - class: "fancy-nav-header", - "data-icon": "cloud-admin-icon" - }, - if: -> do - current_user.is_allowed?("tools:application_get") && plugin_available?(:cc_tools) - end do |cc_tools_nav| + 'Tools', + nil, + html: { + class: 'fancy-nav-header', + "data-icon": 'cloud-admin-icon' + }, + if: lambda { + current_user.is_allowed?('tools:application_get') && plugin_available?(:cc_tools) + } do |cc_tools_nav| cc_tools_nav.item :universal_search, - "Universal Search", - -> { plugin("cc_tools").start_path }, - if: -> do - current_user.is_allowed?("tools:application_get") && + 'Universal Search', + -> { plugin('cc_tools').start_path }, + if: lambda { + current_user.is_allowed?('tools:application_get') && plugin_available?(:cc_tools) - end, + }, highlights_on: -> { params[:controller][%r{tools/?.*}] } end @@ -528,7 +528,7 @@ # you can also specify html attributes to attach to this particular level # works for all levels of the menu - primary.dom_attributes = { class: "fancy-nav", role: "menu" } + primary.dom_attributes = { class: 'fancy-nav', role: 'menu' } # You can turn off auto highlighting for a specific level # primary.auto_highlight = false diff --git a/plugins/resources/app/views/resources/v2/project.html.haml b/plugins/resources/app/views/resources/v2/project.html.haml index ca5e7d0184..f333c48bb7 100644 --- a/plugins/resources/app/views/resources/v2/project.html.haml +++ b/plugins/resources/app/views/resources/v2/project.html.haml @@ -1,9 +1,8 @@ -- if current_user.is_allowed?('resources:project:edit', {selected: {domain_id: @scoped_domain_id, project_id: @scoped_project_id} }) - = javascript_include_tag 'resources_limes-ui_widget', data: { props: { | - embedded: true, | - theme: 'theme-light', | - endpoint: "https://limes-3.#{current_region}.cloud.sap", | - "projectID": "#{@scoped_project_id}", | - "domainID": "#{@scoped_domain_id}", | - "getTokenFuncName": "_getCurrentToken", | - "canEdit": "#{current_user.is_allowed?('resources:project:edit', {selected: {domain_id: @scoped_domain_id, project_id: @scoped_project_id} })}" } } \ No newline at end of file += javascript_include_tag 'resources_limes-ui_widget', data: { props: { | + embedded: true, | + theme: 'theme-light', | + endpoint: "https://limes-3.#{current_region}.cloud.sap", | + "projectID": "#{@scoped_project_id}", | + "domainID": "#{@scoped_domain_id}", | + "getTokenFuncName": "_getCurrentToken", | + "canEdit": "#{current_user.is_allowed?('resources:project:edit', {selected: {domain_id: @scoped_domain_id, project_id: @scoped_project_id} })}" } } From a7c549664ff13dfaa77db0709ad483f739c7d6d4 Mon Sep 17 00:00:00 2001 From: Hans-Georg Winkler Date: Thu, 28 Nov 2024 16:56:33 +0100 Subject: [PATCH 2/3] chore(docu):cleanup MIT Licence and adjust help texts (#1460) Co-authored-by: Andreas Pfau --- plugins/access_profile/MIT-LICENSE | 20 ------------------- plugins/access_profile/README.md | 13 +++++++----- plugins/audit/MIT-LICENSE | 20 ------------------- plugins/audit/README.md | 3 +++ plugins/audit/README.rdoc | 3 --- plugins/audit/plugin_help.md | 8 ++++---- plugins/automation/README.md | 3 +++ plugins/automation/README.rdoc | 3 --- plugins/automation/plugin_nodes_help.md | 10 ++++++---- plugins/block_storage/MIT-LICENSE | 20 ------------------- plugins/block_storage/README.md | 3 +++ plugins/block_storage/README.rdoc | 3 --- plugins/cloudops/MIT-LICENSE | 20 ------------------- plugins/cloudops/README.md | 13 +++++++----- plugins/compute/README.md | 3 +++ plugins/compute/README.rdoc | 3 --- plugins/compute/plugin_instances_help.md | 13 +++++++----- plugins/dns_service/MIT-LICENSE | 20 ------------------- plugins/dns_service/README.md | 3 +++ plugins/dns_service/README.rdoc | 3 --- plugins/email_service/MIT-LICENSE | 20 ------------------- plugins/email_service/README.md | 19 ++++++++++-------- plugins/email_service/plugin_help.md | 4 ---- plugins/identity/MIT-LICENSE | 20 ------------------- plugins/identity/README.md | 3 +++ plugins/identity/README.rdoc | 3 --- plugins/image/README.md | 3 +++ plugins/image/README.rdoc | 3 --- .../image/plugin_os_images_private_help.md | 4 ++-- plugins/inquiry/MIT-LICENSE | 20 ------------------- plugins/inquiry/README.md | 3 +++ plugins/inquiry/README.rdoc | 3 --- plugins/keppel/MIT-LICENSE | 20 ------------------- plugins/keppel/README.md | 13 +++++++----- plugins/key_manager/README.md | 3 +++ plugins/key_manager/README.rdoc | 3 --- plugins/keymanagerng/MIT-LICENSE | 20 ------------------- plugins/keymanagerng/README.md | 11 ++++++---- plugins/kubernetes/MIT-LICENSE | 20 ------------------- plugins/kubernetes/README.md | 3 +++ plugins/kubernetes/README.rdoc | 3 --- plugins/lbaas2/MIT-LICENSE | 20 ------------------- plugins/lbaas2/README.md | 11 ++++++++-- plugins/lookup/MIT-LICENSE | 20 ------------------- plugins/lookup/README.md | 3 +++ plugins/lookup/README.rdoc | 3 --- plugins/masterdata_cockpit/MIT-LICENSE | 20 ------------------- plugins/masterdata_cockpit/README.md | 3 +++ plugins/masterdata_cockpit/README.rdoc | 3 --- plugins/metrics/MIT-LICENSE | 20 ------------------- plugins/metrics/README.md | 13 +++++++----- plugins/networking/README.md | 3 +++ plugins/networking/README.rdoc | 3 --- plugins/object_storage/MIT-LICENSE | 20 ------------------- plugins/object_storage/README.md | 8 ++------ plugins/reports/MIT-LICENSE | 20 ------------------- plugins/reports/README.md | 13 +++++++----- plugins/resources/MIT-LICENSE | 20 ------------------- plugins/resources/README.md | 13 +++++++----- plugins/shared_filesystem_storage/MIT-LICENSE | 20 ------------------- plugins/shared_filesystem_storage/README.md | 3 +++ plugins/shared_filesystem_storage/README.rdoc | 3 --- plugins/testikus/MIT-LICENSE | 20 ------------------- plugins/testikus/README.md | 13 +++++++----- plugins/tools/MIT-LICENSE | 20 ------------------- plugins/tools/README.md | 3 +++ plugins/tools/README.rdoc | 4 ---- plugins/webconsole/MIT-LICENSE | 20 ------------------- plugins/webconsole/README.md | 3 +++ 69 files changed, 153 insertions(+), 560 deletions(-) delete mode 100644 plugins/access_profile/MIT-LICENSE delete mode 100644 plugins/audit/MIT-LICENSE create mode 100644 plugins/audit/README.md delete mode 100644 plugins/audit/README.rdoc create mode 100644 plugins/automation/README.md delete mode 100644 plugins/automation/README.rdoc delete mode 100644 plugins/block_storage/MIT-LICENSE create mode 100644 plugins/block_storage/README.md delete mode 100644 plugins/block_storage/README.rdoc delete mode 100644 plugins/cloudops/MIT-LICENSE create mode 100644 plugins/compute/README.md delete mode 100644 plugins/compute/README.rdoc delete mode 100644 plugins/dns_service/MIT-LICENSE create mode 100644 plugins/dns_service/README.md delete mode 100644 plugins/dns_service/README.rdoc delete mode 100644 plugins/email_service/MIT-LICENSE delete mode 100644 plugins/identity/MIT-LICENSE create mode 100644 plugins/identity/README.md delete mode 100644 plugins/identity/README.rdoc create mode 100644 plugins/image/README.md delete mode 100644 plugins/image/README.rdoc delete mode 100644 plugins/inquiry/MIT-LICENSE create mode 100644 plugins/inquiry/README.md delete mode 100644 plugins/inquiry/README.rdoc delete mode 100644 plugins/keppel/MIT-LICENSE create mode 100644 plugins/key_manager/README.md delete mode 100644 plugins/key_manager/README.rdoc delete mode 100644 plugins/keymanagerng/MIT-LICENSE delete mode 100644 plugins/kubernetes/MIT-LICENSE create mode 100644 plugins/kubernetes/README.md delete mode 100644 plugins/kubernetes/README.rdoc delete mode 100644 plugins/lbaas2/MIT-LICENSE delete mode 100644 plugins/lookup/MIT-LICENSE create mode 100644 plugins/lookup/README.md delete mode 100644 plugins/lookup/README.rdoc delete mode 100644 plugins/masterdata_cockpit/MIT-LICENSE create mode 100644 plugins/masterdata_cockpit/README.md delete mode 100644 plugins/masterdata_cockpit/README.rdoc delete mode 100644 plugins/metrics/MIT-LICENSE create mode 100644 plugins/networking/README.md delete mode 100644 plugins/networking/README.rdoc delete mode 100644 plugins/object_storage/MIT-LICENSE delete mode 100644 plugins/reports/MIT-LICENSE delete mode 100644 plugins/resources/MIT-LICENSE delete mode 100644 plugins/shared_filesystem_storage/MIT-LICENSE create mode 100644 plugins/shared_filesystem_storage/README.md delete mode 100644 plugins/shared_filesystem_storage/README.rdoc delete mode 100644 plugins/testikus/MIT-LICENSE delete mode 100644 plugins/tools/MIT-LICENSE create mode 100644 plugins/tools/README.md delete mode 100644 plugins/tools/README.rdoc delete mode 100644 plugins/webconsole/MIT-LICENSE create mode 100644 plugins/webconsole/README.md diff --git a/plugins/access_profile/MIT-LICENSE b/plugins/access_profile/MIT-LICENSE deleted file mode 100644 index a311515438..0000000000 --- a/plugins/access_profile/MIT-LICENSE +++ /dev/null @@ -1,20 +0,0 @@ -Copyright 2021 TODO: Write your name - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND -NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE -LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION -OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION -WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/plugins/access_profile/README.md b/plugins/access_profile/README.md index 0641a4d5fe..ed519a5c42 100644 --- a/plugins/access_profile/README.md +++ b/plugins/access_profile/README.md @@ -1,10 +1,13 @@ -# Galvani -Short description and motivation. +# Galvani Plugin + +This README serves as a central location for plugin-specific information, including setup instructions, configurations, usage examples, or any other relevant details specific to this plugin. ## Usage + How to use my plugin. ## Installation + Add this line to your application's Gemfile: ```ruby @@ -12,17 +15,17 @@ gem 'galvani' ``` And then execute: + ```bash $ bundle ``` Or install it yourself as: + ```bash $ gem install galvani ``` ## Contributing -Contribution directions go here. -## License -The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). +Contribution directions go here. diff --git a/plugins/audit/MIT-LICENSE b/plugins/audit/MIT-LICENSE deleted file mode 100644 index 7cf9df3047..0000000000 --- a/plugins/audit/MIT-LICENSE +++ /dev/null @@ -1,20 +0,0 @@ -Copyright 2017 TODO: Write your name - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND -NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE -LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION -OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION -WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/plugins/audit/README.md b/plugins/audit/README.md new file mode 100644 index 0000000000..66ece122b4 --- /dev/null +++ b/plugins/audit/README.md @@ -0,0 +1,3 @@ +# Audit Plugin + +This README serves as a central location for plugin-specific information, including setup instructions, configurations, usage examples, or any other relevant details specific to this plugin. diff --git a/plugins/audit/README.rdoc b/plugins/audit/README.rdoc deleted file mode 100644 index 2e78ef204c..0000000000 --- a/plugins/audit/README.rdoc +++ /dev/null @@ -1,3 +0,0 @@ -= Audit - -This project rocks and uses MIT-LICENSE. \ No newline at end of file diff --git a/plugins/audit/plugin_help.md b/plugins/audit/plugin_help.md index f31daa58ce..15272a643f 100644 --- a/plugins/audit/plugin_help.md +++ b/plugins/audit/plugin_help.md @@ -1,9 +1,9 @@ #### What is Audit Log? -Audit Log provides an audit trail or change log for Converged Cloud services. +The Audit Log feature offers a comprehensive audit trail and change log for Converged Cloud services. -It records audit-relevant activities and stores them in a project-specific journal. In the journal, each recorded activity is represented by an audit event. The event describes the performed activity, the outcome and lastly the resources that are affected. +It captures audit-relevant activities and stores them in a project-specific journal. Within this journal, each recorded activity is represented by an audit event. These events detail the performed action, its outcome, and the affected resources. -This service is not just for auditors! Use it to conduct a root-cause analysis when you run into configuration issues (e.g. downtimes). With the information of the audit events, it is much easier to separate human error from platform malfunctions. +This service isn't exclusively for auditors. It's a valuable tool for conducting root-cause analysis when encountering configuration issues, such as downtimes. The information provided by audit events significantly simplifies the process of distinguishing between human errors and platform malfunctions. -For now only Keystone events are recorded, additional sources will be added one by one. +Currently, the system only records Keystone events. However, additional sources will be incorporated incrementally in the future. diff --git a/plugins/automation/README.md b/plugins/automation/README.md new file mode 100644 index 0000000000..f0d3111a23 --- /dev/null +++ b/plugins/automation/README.md @@ -0,0 +1,3 @@ +# Automation Plugin + +This README serves as a central location for plugin-specific information, including setup instructions, configurations, usage examples, or any other relevant details specific to this plugin. diff --git a/plugins/automation/README.rdoc b/plugins/automation/README.rdoc deleted file mode 100644 index 40b971ce22..0000000000 --- a/plugins/automation/README.rdoc +++ /dev/null @@ -1,3 +0,0 @@ -= Automation - -This project rocks and uses MIT-LICENSE. \ No newline at end of file diff --git a/plugins/automation/plugin_nodes_help.md b/plugins/automation/plugin_nodes_help.md index b992e032dc..47e08e1723 100644 --- a/plugins/automation/plugin_nodes_help.md +++ b/plugins/automation/plugin_nodes_help.md @@ -2,8 +2,10 @@ ##### Floating IP reported by the Arc node -By default Arc nodes report the fixed IP and floating IP as a fact from the instance they run on. If the floating IP is not shown check the following: +By default, Arc nodes report both the fixed IP and floating IP as facts from the instance they are running on. If the floating IP is not displayed, consider the following possibilities: -* There is no floating IP assigned to the instance. If this is the case go the **servers area** and assign a floating IP to your instance. -* The Arc node is outdated. Check if the Arc node is still running and if it is running with the latest version. Check the documentation for more help. -* The Arc node is not running on an Openstack instance. In this case cannot be retrieved because the metadata service is not reachable from the instance. +1. No floating IP is assigned to the instance. In this case, navigate to the **Servers section** and allocate a floating IP to your instance. + +2. The Arc node is outdated. Verify that the Arc node is still operational and running the latest version. Consult the documentation for further guidance. + +3. The Arc node is not operating on an OpenStack instance. In this scenario, the floating IP cannot be retrieved because the metadata service is inaccessible from the instance. diff --git a/plugins/block_storage/MIT-LICENSE b/plugins/block_storage/MIT-LICENSE deleted file mode 100644 index 979dc84029..0000000000 --- a/plugins/block_storage/MIT-LICENSE +++ /dev/null @@ -1,20 +0,0 @@ -Copyright 2016 TODO: Write your name - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND -NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE -LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION -OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION -WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/plugins/block_storage/README.md b/plugins/block_storage/README.md new file mode 100644 index 0000000000..8a00bb0b5e --- /dev/null +++ b/plugins/block_storage/README.md @@ -0,0 +1,3 @@ +# Block Storage Plugin + +This README serves as a central location for plugin-specific information, including setup instructions, configurations, usage examples, or any other relevant details specific to this plugin. diff --git a/plugins/block_storage/README.rdoc b/plugins/block_storage/README.rdoc deleted file mode 100644 index b02d2d22fa..0000000000 --- a/plugins/block_storage/README.rdoc +++ /dev/null @@ -1,3 +0,0 @@ -= BlockStorage - -This project rocks and uses MIT-LICENSE. \ No newline at end of file diff --git a/plugins/cloudops/MIT-LICENSE b/plugins/cloudops/MIT-LICENSE deleted file mode 100644 index 35a0672a44..0000000000 --- a/plugins/cloudops/MIT-LICENSE +++ /dev/null @@ -1,20 +0,0 @@ -Copyright 2018 TODO: Write your name - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND -NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE -LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION -OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION -WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/plugins/cloudops/README.md b/plugins/cloudops/README.md index 471fc1e42e..0c748e524e 100644 --- a/plugins/cloudops/README.md +++ b/plugins/cloudops/README.md @@ -1,10 +1,13 @@ -# Cloudops -Short description and motivation. +# Cloudops Plugin + +This README serves as a central location for plugin-specific information, including setup instructions, configurations, usage examples, or any other relevant details specific to this plugin. ## Usage + How to use my plugin. ## Installation + Add this line to your application's Gemfile: ```ruby @@ -12,17 +15,17 @@ gem 'cloudops' ``` And then execute: + ```bash $ bundle ``` Or install it yourself as: + ```bash $ gem install cloudops ``` ## Contributing -Contribution directions go here. -## License -The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT). +Contribution directions go here. diff --git a/plugins/compute/README.md b/plugins/compute/README.md new file mode 100644 index 0000000000..15ecf0ad88 --- /dev/null +++ b/plugins/compute/README.md @@ -0,0 +1,3 @@ +# Compute Plugin + +This README serves as a central location for plugin-specific information, including setup instructions, configurations, usage examples, or any other relevant details specific to this plugin. diff --git a/plugins/compute/README.rdoc b/plugins/compute/README.rdoc deleted file mode 100644 index f4e91265dd..0000000000 --- a/plugins/compute/README.rdoc +++ /dev/null @@ -1,3 +0,0 @@ -= Compute - -This project rocks and uses MIT-LICENSE. \ No newline at end of file diff --git a/plugins/compute/plugin_instances_help.md b/plugins/compute/plugin_instances_help.md index ee872db139..2053f8be61 100644 --- a/plugins/compute/plugin_instances_help.md +++ b/plugins/compute/plugin_instances_help.md @@ -2,9 +2,12 @@ ##### Creating new servers -By default new servers you create are not accessible from outside the network they were deployed into. To create a VM with external access follow these steps: +By default, newly created servers are not accessible from outside their deployment network. To create a VM with external access, follow these steps: -1. Create a new VM instance: since you'll most likely eventually want to login via SSH, be sure to also **create or import an SSH public key** (if you haven't done so already) and specify the key during VM creation. You won't be able to add your key later to an already existing VM. -2. Once the instance is created and an IP has been assigned from the private network, associate a Floating IP to the instance. Before doing this you will need to allocate one to your project from the External network pool. -3. The instance is now accessible via the Floating IP you assigned. However, during creation (unless you specified otherwise) it was assigned to your project's Default security group. Before you can access via SSH or ping the instance you need ensure the security group has a rule allowing ingress for TCP port 22 and/or ICMP Type 8 Code 0 respectively. Corresponding egress rules are also required. -4. You should now be able to access the instance via SSH using ssh [user]@[floating ip]. In most cases the user is `ccloud` (for CoreOS `core`). On older images before March 2017 the user is dependent on the image operating system: for Ubuntu use 'ubuntu', for Cirros use 'cirros', for RHEL use 'fedora' and for SLES use 'root'. You also need to make sure that your SSH client is using the private key corresponding to the public key you have assigned during machine creation. +1. Create a new VM instance: As you'll likely want to log in via SSH eventually, ensure you create or import an SSH public key (if you haven't already) and specify it during VM creation. Note that you cannot add a key to an existing VM later. + +2. Once the instance is created and assigned an IP from the private network, associate a Floating IP with the instance. Before doing this, you'll need to allocate one to your project from the External network pool. + +3. The instance is now accessible via the assigned Floating IP. However, during creation (unless specified otherwise), it was assigned to your project's Default security group. Before you can access the instance via SSH or ping it, ensure the security group has rules allowing ingress for TCP port 22 and/or ICMP Type 8 Code 0, respectively. Corresponding egress rules are also required. + +4. You should now be able to access the instance via SSH using the command: ssh [user]@[floating ip]. In most cases, the user is 'ccloud' (for CoreOS, use 'core'). On older images (before March 2017), the user depends on the image operating system: for Ubuntu use 'ubuntu', for Cirros use 'cirros', for RHEL use 'fedora', and for SLES use 'root'. Ensure your SSH client is using the private key corresponding to the public key you assigned during machine creation. diff --git a/plugins/dns_service/MIT-LICENSE b/plugins/dns_service/MIT-LICENSE deleted file mode 100644 index 1842adb878..0000000000 --- a/plugins/dns_service/MIT-LICENSE +++ /dev/null @@ -1,20 +0,0 @@ -Copyright 2016 SAP SE - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND -NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE -LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION -OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION -WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/plugins/dns_service/README.md b/plugins/dns_service/README.md new file mode 100644 index 0000000000..c0f443fea0 --- /dev/null +++ b/plugins/dns_service/README.md @@ -0,0 +1,3 @@ +# DNS Service Plugin + +This README serves as a central location for plugin-specific information, including setup instructions, configurations, usage examples, or any other relevant details specific to this plugin. diff --git a/plugins/dns_service/README.rdoc b/plugins/dns_service/README.rdoc deleted file mode 100644 index 7df7b30c1b..0000000000 --- a/plugins/dns_service/README.rdoc +++ /dev/null @@ -1,3 +0,0 @@ -= DnsService - -This project rocks and uses MIT-LICENSE. \ No newline at end of file diff --git a/plugins/email_service/MIT-LICENSE b/plugins/email_service/MIT-LICENSE deleted file mode 100644 index bbf2807edc..0000000000 --- a/plugins/email_service/MIT-LICENSE +++ /dev/null @@ -1,20 +0,0 @@ -Copyright 2020 TODO: Write your name - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND -NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE -LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION -OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION -WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/plugins/email_service/README.md b/plugins/email_service/README.md index 4692f6a319..e0ad65d270 100644 --- a/plugins/email_service/README.md +++ b/plugins/email_service/README.md @@ -1,10 +1,13 @@ -# EmailService -Short description and motivation. +# EmailService Plugin + +This README serves as a central location for plugin-specific information, including setup instructions, configurations, usage examples, or any other relevant details specific to this plugin. ## Usage + How to use my plugin. ## Installation + Add this line to your application's Gemfile: ```ruby @@ -12,22 +15,22 @@ gem 'email_service' ``` And then execute: + ```bash $ bundle ``` Or install it yourself as: + ```bash $ gem install email_service ``` ## Contributing -Contribution directions go here. -## License -The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). +Contribution directions go here. ## TODO LIST - * Multi-encoding support - to send plain and templated emails. - * Send email with verified domains. - \ No newline at end of file + +- Multi-encoding support - to send plain and templated emails. +- Send email with verified domains. diff --git a/plugins/email_service/plugin_help.md b/plugins/email_service/plugin_help.md index 987494bc3f..7786c78ddb 100644 --- a/plugins/email_service/plugin_help.md +++ b/plugins/email_service/plugin_help.md @@ -1,5 +1 @@ #### Email Service - -##### What it is - -##### How to use diff --git a/plugins/identity/MIT-LICENSE b/plugins/identity/MIT-LICENSE deleted file mode 100644 index bc34d95cbb..0000000000 --- a/plugins/identity/MIT-LICENSE +++ /dev/null @@ -1,20 +0,0 @@ -Copyright 2015 TODO: Write your name - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND -NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE -LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION -OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION -WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/plugins/identity/README.md b/plugins/identity/README.md new file mode 100644 index 0000000000..caa4884c9f --- /dev/null +++ b/plugins/identity/README.md @@ -0,0 +1,3 @@ +# Identity Plugin + +This README serves as a central location for plugin-specific information, including setup instructions, configurations, usage examples, or any other relevant details specific to this plugin. diff --git a/plugins/identity/README.rdoc b/plugins/identity/README.rdoc deleted file mode 100644 index 46c61924f5..0000000000 --- a/plugins/identity/README.rdoc +++ /dev/null @@ -1,3 +0,0 @@ -= Identity - -This project rocks and uses MIT-LICENSE. \ No newline at end of file diff --git a/plugins/image/README.md b/plugins/image/README.md new file mode 100644 index 0000000000..c9eac5b7ba --- /dev/null +++ b/plugins/image/README.md @@ -0,0 +1,3 @@ +# Image Plugin + +This README serves as a central location for plugin-specific information, including setup instructions, configurations, usage examples, or any other relevant details specific to this plugin. diff --git a/plugins/image/README.rdoc b/plugins/image/README.rdoc deleted file mode 100644 index 08c7d116d0..0000000000 --- a/plugins/image/README.rdoc +++ /dev/null @@ -1,3 +0,0 @@ -= Image - -This project rocks and uses MIT-LICENSE. \ No newline at end of file diff --git a/plugins/image/plugin_os_images_private_help.md b/plugins/image/plugin_os_images_private_help.md index c7a704fdfa..14d26319c0 100644 --- a/plugins/image/plugin_os_images_private_help.md +++ b/plugins/image/plugin_os_images_private_help.md @@ -2,6 +2,6 @@ ##### Creating new private images -You can bring your own images to deploy instances. We store the data in Swift. +You have the option to use your own custom images for deploying instances. We store these images in our Swift object storage system. -Therefore you have to **make sure you have object storage enabled** for this project. +To utilize this feature, please ensure that object storage is activated for your project. This is a prerequisite for storing and accessing your custom images. diff --git a/plugins/inquiry/MIT-LICENSE b/plugins/inquiry/MIT-LICENSE deleted file mode 100644 index bc34d95cbb..0000000000 --- a/plugins/inquiry/MIT-LICENSE +++ /dev/null @@ -1,20 +0,0 @@ -Copyright 2015 TODO: Write your name - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND -NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE -LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION -OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION -WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/plugins/inquiry/README.md b/plugins/inquiry/README.md new file mode 100644 index 0000000000..d93caf8c28 --- /dev/null +++ b/plugins/inquiry/README.md @@ -0,0 +1,3 @@ +# Inquiry Plugin + +This README serves as a central location for plugin-specific information, including setup instructions, configurations, usage examples, or any other relevant details specific to this plugin. diff --git a/plugins/inquiry/README.rdoc b/plugins/inquiry/README.rdoc deleted file mode 100644 index 7b462a0642..0000000000 --- a/plugins/inquiry/README.rdoc +++ /dev/null @@ -1,3 +0,0 @@ -= Inquiry - -This project rocks and uses MIT-LICENSE. \ No newline at end of file diff --git a/plugins/keppel/MIT-LICENSE b/plugins/keppel/MIT-LICENSE deleted file mode 100644 index cd8e3e6fe0..0000000000 --- a/plugins/keppel/MIT-LICENSE +++ /dev/null @@ -1,20 +0,0 @@ -Copyright 2019 TODO: Write your name - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND -NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE -LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION -OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION -WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/plugins/keppel/README.md b/plugins/keppel/README.md index 23b6602837..fceab5ffe9 100644 --- a/plugins/keppel/README.md +++ b/plugins/keppel/README.md @@ -1,10 +1,13 @@ -# Keppel -Short description and motivation. +# Keppel Plugin + +This README serves as a central location for plugin-specific information, including setup instructions, configurations, usage examples, or any other relevant details specific to this plugin. ## Usage + How to use my plugin. ## Installation + Add this line to your application's Gemfile: ```ruby @@ -12,17 +15,17 @@ gem 'keppel' ``` And then execute: + ```bash $ bundle ``` Or install it yourself as: + ```bash $ gem install keppel ``` ## Contributing -Contribution directions go here. -## License -The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). +Contribution directions go here. diff --git a/plugins/key_manager/README.md b/plugins/key_manager/README.md new file mode 100644 index 0000000000..e7ad465e7c --- /dev/null +++ b/plugins/key_manager/README.md @@ -0,0 +1,3 @@ +# Key Manager Plugin + +This README serves as a central location for plugin-specific information, including setup instructions, configurations, usage examples, or any other relevant details specific to this plugin. diff --git a/plugins/key_manager/README.rdoc b/plugins/key_manager/README.rdoc deleted file mode 100644 index 09731aed16..0000000000 --- a/plugins/key_manager/README.rdoc +++ /dev/null @@ -1,3 +0,0 @@ -= KeyManager - -This project rocks and uses MIT-LICENSE. \ No newline at end of file diff --git a/plugins/keymanagerng/MIT-LICENSE b/plugins/keymanagerng/MIT-LICENSE deleted file mode 100644 index 74da3fbc2b..0000000000 --- a/plugins/keymanagerng/MIT-LICENSE +++ /dev/null @@ -1,20 +0,0 @@ -Copyright 2022 TODO: Write your name - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND -NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE -LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION -OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION -WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/plugins/keymanagerng/README.md b/plugins/keymanagerng/README.md index e794642c04..3874e9239b 100644 --- a/plugins/keymanagerng/README.md +++ b/plugins/keymanagerng/README.md @@ -1,10 +1,13 @@ # Keymanagerng -Short description and motivation. + +This README serves as a central location for plugin-specific information, including setup instructions, configurations, usage examples, or any other relevant details specific to this plugin. ## Usage + How to use my plugin. ## Installation + Add this line to your application's Gemfile: ```ruby @@ -12,17 +15,17 @@ gem 'keymanagerng' ``` And then execute: + ```bash $ bundle ``` Or install it yourself as: + ```bash $ gem install keymanagerng ``` ## Contributing -Contribution directions go here. -## License -The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). +Contribution directions go here. diff --git a/plugins/kubernetes/MIT-LICENSE b/plugins/kubernetes/MIT-LICENSE deleted file mode 100644 index 7cf9df3047..0000000000 --- a/plugins/kubernetes/MIT-LICENSE +++ /dev/null @@ -1,20 +0,0 @@ -Copyright 2017 TODO: Write your name - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND -NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE -LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION -OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION -WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/plugins/kubernetes/README.md b/plugins/kubernetes/README.md new file mode 100644 index 0000000000..c827138787 --- /dev/null +++ b/plugins/kubernetes/README.md @@ -0,0 +1,3 @@ +# Kubernetes Plugin + +This README serves as a central location for plugin-specific information, including setup instructions, configurations, usage examples, or any other relevant details specific to this plugin. diff --git a/plugins/kubernetes/README.rdoc b/plugins/kubernetes/README.rdoc deleted file mode 100644 index d628bcb3b2..0000000000 --- a/plugins/kubernetes/README.rdoc +++ /dev/null @@ -1,3 +0,0 @@ -= Kubernetes - -This project rocks and uses MIT-LICENSE. \ No newline at end of file diff --git a/plugins/lbaas2/MIT-LICENSE b/plugins/lbaas2/MIT-LICENSE deleted file mode 100644 index bbf2807edc..0000000000 --- a/plugins/lbaas2/MIT-LICENSE +++ /dev/null @@ -1,20 +0,0 @@ -Copyright 2020 TODO: Write your name - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND -NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE -LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION -OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION -WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/plugins/lbaas2/README.md b/plugins/lbaas2/README.md index 6587d02db2..85b0c08664 100644 --- a/plugins/lbaas2/README.md +++ b/plugins/lbaas2/README.md @@ -1,10 +1,13 @@ -# Lbaas2 -Short description and motivation. +# Lbaas2 Plugin + +This README serves as a central location for plugin-specific information, including setup instructions, configurations, usage examples, or any other relevant details specific to this plugin. ## Usage + How to use my plugin. ## Installation + Add this line to your application's Gemfile: ```ruby @@ -12,17 +15,21 @@ gem 'lbaas2' ``` And then execute: + ```bash $ bundle ``` Or install it yourself as: + ```bash $ gem install lbaas2 ``` ## Contributing + Contribution directions go here. ## License + The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). diff --git a/plugins/lookup/MIT-LICENSE b/plugins/lookup/MIT-LICENSE deleted file mode 100644 index 14e116c0ea..0000000000 --- a/plugins/lookup/MIT-LICENSE +++ /dev/null @@ -1,20 +0,0 @@ -Copyright 2017 Maurice Schreiber - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND -NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE -LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION -OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION -WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/plugins/lookup/README.md b/plugins/lookup/README.md new file mode 100644 index 0000000000..64b10d4bd3 --- /dev/null +++ b/plugins/lookup/README.md @@ -0,0 +1,3 @@ +# Lookup Plugin + +This README serves as a central location for plugin-specific information, including setup instructions, configurations, usage examples, or any other relevant details specific to this plugin. diff --git a/plugins/lookup/README.rdoc b/plugins/lookup/README.rdoc deleted file mode 100644 index 1d01ed88a2..0000000000 --- a/plugins/lookup/README.rdoc +++ /dev/null @@ -1,3 +0,0 @@ -= Lookup - -This project rocks and uses MIT-LICENSE. \ No newline at end of file diff --git a/plugins/masterdata_cockpit/MIT-LICENSE b/plugins/masterdata_cockpit/MIT-LICENSE deleted file mode 100644 index 7cf9df3047..0000000000 --- a/plugins/masterdata_cockpit/MIT-LICENSE +++ /dev/null @@ -1,20 +0,0 @@ -Copyright 2017 TODO: Write your name - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND -NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE -LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION -OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION -WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/plugins/masterdata_cockpit/README.md b/plugins/masterdata_cockpit/README.md new file mode 100644 index 0000000000..839dce7bc7 --- /dev/null +++ b/plugins/masterdata_cockpit/README.md @@ -0,0 +1,3 @@ +# Masterdata Plugin + +This README serves as a central location for plugin-specific information, including setup instructions, configurations, usage examples, or any other relevant details specific to this plugin. diff --git a/plugins/masterdata_cockpit/README.rdoc b/plugins/masterdata_cockpit/README.rdoc deleted file mode 100644 index 0866a5713b..0000000000 --- a/plugins/masterdata_cockpit/README.rdoc +++ /dev/null @@ -1,3 +0,0 @@ -= MasterdataCockpit - -This project rocks and uses MIT-LICENSE. diff --git a/plugins/metrics/MIT-LICENSE b/plugins/metrics/MIT-LICENSE deleted file mode 100644 index 7cf9df3047..0000000000 --- a/plugins/metrics/MIT-LICENSE +++ /dev/null @@ -1,20 +0,0 @@ -Copyright 2017 TODO: Write your name - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND -NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE -LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION -OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION -WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/plugins/metrics/README.md b/plugins/metrics/README.md index 3c6d909657..efea473dae 100644 --- a/plugins/metrics/README.md +++ b/plugins/metrics/README.md @@ -1,10 +1,13 @@ -# Metrics -Short description and motivation. +# Metrics Plugin + +This README serves as a central location for plugin-specific information, including setup instructions, configurations, usage examples, or any other relevant details specific to this plugin. ## Usage + How to use my plugin. ## Installation + Add this line to your application's Gemfile: ```ruby @@ -12,17 +15,17 @@ gem 'metrics' ``` And then execute: + ```bash $ bundle ``` Or install it yourself as: + ```bash $ gem install metrics ``` ## Contributing -Contribution directions go here. -## License -The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT). +Contribution directions go here. diff --git a/plugins/networking/README.md b/plugins/networking/README.md new file mode 100644 index 0000000000..a9421884cf --- /dev/null +++ b/plugins/networking/README.md @@ -0,0 +1,3 @@ +# Networking Plugin + +This README serves as a central location for plugin-specific information, including setup instructions, configurations, usage examples, or any other relevant details specific to this plugin. diff --git a/plugins/networking/README.rdoc b/plugins/networking/README.rdoc deleted file mode 100644 index f2d4348f85..0000000000 --- a/plugins/networking/README.rdoc +++ /dev/null @@ -1,3 +0,0 @@ -= Networking - -This project rocks and uses MIT-LICENSE. \ No newline at end of file diff --git a/plugins/object_storage/MIT-LICENSE b/plugins/object_storage/MIT-LICENSE deleted file mode 100644 index a311515438..0000000000 --- a/plugins/object_storage/MIT-LICENSE +++ /dev/null @@ -1,20 +0,0 @@ -Copyright 2021 TODO: Write your name - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND -NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE -LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION -OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION -WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/plugins/object_storage/README.md b/plugins/object_storage/README.md index 62c97f0e06..5c953d1168 100644 --- a/plugins/object_storage/README.md +++ b/plugins/object_storage/README.md @@ -1,6 +1,6 @@ -# ObjectStorage +# ObjectStorage Plugin -Short description and motivation. +This README serves as a central location for plugin-specific information, including setup instructions, configurations, usage examples, or any other relevant details specific to this plugin. ## Usage @@ -29,7 +29,3 @@ $ gem install object_storage ## Contributing Contribution directions go here. - -## License - -The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). diff --git a/plugins/reports/MIT-LICENSE b/plugins/reports/MIT-LICENSE deleted file mode 100644 index 35a0672a44..0000000000 --- a/plugins/reports/MIT-LICENSE +++ /dev/null @@ -1,20 +0,0 @@ -Copyright 2018 TODO: Write your name - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND -NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE -LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION -OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION -WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/plugins/reports/README.md b/plugins/reports/README.md index bff4495c2a..db2f67aaeb 100644 --- a/plugins/reports/README.md +++ b/plugins/reports/README.md @@ -1,10 +1,13 @@ -# Reports -Short description and motivation. +# Reports Plugin + +This README serves as a central location for plugin-specific information, including setup instructions, configurations, usage examples, or any other relevant details specific to this plugin. ## Usage + How to use my plugin. ## Installation + Add this line to your application's Gemfile: ```ruby @@ -12,17 +15,17 @@ gem 'reports' ``` And then execute: + ```bash $ bundle ``` Or install it yourself as: + ```bash $ gem install reports ``` ## Contributing -Contribution directions go here. -## License -The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT). +Contribution directions go here. diff --git a/plugins/resources/MIT-LICENSE b/plugins/resources/MIT-LICENSE deleted file mode 100644 index b92fbb04f6..0000000000 --- a/plugins/resources/MIT-LICENSE +++ /dev/null @@ -1,20 +0,0 @@ -Copyright 2019 SAP SE - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND -NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE -LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION -OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION -WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/plugins/resources/README.md b/plugins/resources/README.md index 242a2d4d0e..5e0b97abe2 100644 --- a/plugins/resources/README.md +++ b/plugins/resources/README.md @@ -1,10 +1,13 @@ -# Resources -Short description and motivation. +# Resources Plugin + +This README serves as a central location for plugin-specific information, including setup instructions, configurations, usage examples, or any other relevant details specific to this plugin. ## Usage + How to use my plugin. ## Installation + Add this line to your application's Gemfile: ```ruby @@ -12,17 +15,17 @@ gem 'resources' ``` And then execute: + ```bash $ bundle ``` Or install it yourself as: + ```bash $ gem install resources ``` ## Contributing -Contribution directions go here. -## License -The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT). +Contribution directions go here. diff --git a/plugins/shared_filesystem_storage/MIT-LICENSE b/plugins/shared_filesystem_storage/MIT-LICENSE deleted file mode 100644 index 1842adb878..0000000000 --- a/plugins/shared_filesystem_storage/MIT-LICENSE +++ /dev/null @@ -1,20 +0,0 @@ -Copyright 2016 SAP SE - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND -NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE -LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION -OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION -WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/plugins/shared_filesystem_storage/README.md b/plugins/shared_filesystem_storage/README.md new file mode 100644 index 0000000000..3d322effeb --- /dev/null +++ b/plugins/shared_filesystem_storage/README.md @@ -0,0 +1,3 @@ +# Shared Filesystem Storage Plugin + +This README serves as a central location for plugin-specific information, including setup instructions, configurations, usage examples, or any other relevant details specific to this plugin. diff --git a/plugins/shared_filesystem_storage/README.rdoc b/plugins/shared_filesystem_storage/README.rdoc deleted file mode 100644 index 3af71dbd5a..0000000000 --- a/plugins/shared_filesystem_storage/README.rdoc +++ /dev/null @@ -1,3 +0,0 @@ -= SharedFilesystemStorage - -This project rocks and uses MIT-LICENSE. \ No newline at end of file diff --git a/plugins/testikus/MIT-LICENSE b/plugins/testikus/MIT-LICENSE deleted file mode 100644 index 74da3fbc2b..0000000000 --- a/plugins/testikus/MIT-LICENSE +++ /dev/null @@ -1,20 +0,0 @@ -Copyright 2022 TODO: Write your name - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND -NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE -LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION -OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION -WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/plugins/testikus/README.md b/plugins/testikus/README.md index 7342207bbc..4f2090c2c3 100644 --- a/plugins/testikus/README.md +++ b/plugins/testikus/README.md @@ -1,10 +1,13 @@ -# Testikus -Short description and motivation. +# Testikus Plugin + +This README serves as a central location for plugin-specific information, including setup instructions, configurations, usage examples, or any other relevant details specific to this plugin. ## Usage + How to use my plugin. ## Installation + Add this line to your application's Gemfile: ```ruby @@ -12,17 +15,17 @@ gem 'testikus' ``` And then execute: + ```bash $ bundle ``` Or install it yourself as: + ```bash $ gem install testikus ``` ## Contributing -Contribution directions go here. -## License -The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). +Contribution directions go here. diff --git a/plugins/tools/MIT-LICENSE b/plugins/tools/MIT-LICENSE deleted file mode 100644 index 35a0672a44..0000000000 --- a/plugins/tools/MIT-LICENSE +++ /dev/null @@ -1,20 +0,0 @@ -Copyright 2018 TODO: Write your name - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND -NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE -LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION -OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION -WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/plugins/tools/README.md b/plugins/tools/README.md new file mode 100644 index 0000000000..292f2e8b9d --- /dev/null +++ b/plugins/tools/README.md @@ -0,0 +1,3 @@ +# Tools + +This README serves as a central location for plugin-specific information, including setup instructions, configurations, usage examples, or any other relevant details specific to this plugin. diff --git a/plugins/tools/README.rdoc b/plugins/tools/README.rdoc deleted file mode 100644 index 137ea764e2..0000000000 --- a/plugins/tools/README.rdoc +++ /dev/null @@ -1,4 +0,0 @@ -= Tools - -This plugin implements different tools that do not necessarily interact directly with the -backend services, but represent Elektra-Added Value to make the lives of support staff easier. diff --git a/plugins/webconsole/MIT-LICENSE b/plugins/webconsole/MIT-LICENSE deleted file mode 100644 index 979dc84029..0000000000 --- a/plugins/webconsole/MIT-LICENSE +++ /dev/null @@ -1,20 +0,0 @@ -Copyright 2016 TODO: Write your name - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND -NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE -LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION -OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION -WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/plugins/webconsole/README.md b/plugins/webconsole/README.md new file mode 100644 index 0000000000..57a08591d4 --- /dev/null +++ b/plugins/webconsole/README.md @@ -0,0 +1,3 @@ +# Webconsole Plugin + +This README serves as a central location for plugin-specific information, including setup instructions, configurations, usage examples, or any other relevant details specific to this plugin. From 4fbf0d2587d2c13774b74c6d7aead44b177db8f2 Mon Sep 17 00:00:00 2001 From: Andreas Pfau Date: Fri, 29 Nov 2024 14:26:48 +0100 Subject: [PATCH 3/3] chore(ci): enforce to rebuild the image (#1475) --- docker/Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docker/Dockerfile b/docker/Dockerfile index 8d0cc3b1aa..746bade35d 100644 --- a/docker/Dockerfile +++ b/docker/Dockerfile @@ -30,7 +30,7 @@ RUN apk upgrade --no-cache --no-progress \ ################################### BUILDER ################################ FROM base AS builder -RUN echo "Rebuild image 1" +RUN echo "Rebuild image 2" # Note: we need to install git here because bundle needs git in the next step RUN apk --no-cache add git curl nodejs yarn shared-mime-info