Update transformation docs for script profile changes & Clean-Up addo…

…ns folder (#2235) * Update transformation docs for script profile changes Refs openhab/openhab-core#4058. Signed-off-by: Florian Hotze <[email protected]> * Migrate actions docs from addons to configuration folder Signed-off-by: Florian Hotze <[email protected]> * Clean-up addons docs The removed files have not been picked up by the build process, i.e. they were not used by the website. Looking at their content, they also seem outdated. Signed-off-by: Florian Hotze <[email protected]> * Minor enhancements Signed-off-by: Florian Hotze <[email protected]> * Address review Signed-off-by: Florian Hotze <[email protected]> --------- Signed-off-by: Florian Hotze <[email protected]> Co-authored-by: stefan-hoehn <[email protected]>
openhab · Feb 26, 2024 · 3de78d1 · 3de78d1
1 parent c9a8344
commit 3de78d1
Show file tree

Hide file tree

Showing 13 changed files with 43 additions and 377 deletions.
diff --git a/.vuepress/process_file.rb b/.vuepress/process_file.rb
@@ -104,18 +104,6 @@ def process_file(indir, file, outdir, source)
                 next
             end
 
-            # Actions and transformations are currently partly in add-ons, copy the content above the list of add-ons
-            if line =~ /^More details regarding this and other Transformation services can be found in the individual transformation articles linked below./
-                out.puts ""
-                out.puts ":::tip"
-                out.puts "You can find the available transformation services [here](https://www.openhab.org/addons/#transform)."
-                out.puts ":::"
-                out.puts ""
-                break
-            end
-
-            break if line =~ /^## Installable Actions/
-
             # Remove collapsibles in Linux install document and replace them by regular headings
             next if line =~ /include collapsible/ && file =~ /linux/
             line = "##### " + line if line =~ /^Apt Based Systems/ && file =~ /linux/

diff --git a/.vuepress/process_main_docs.rb b/.vuepress/process_main_docs.rb
@@ -63,8 +63,6 @@ def process_main_docs(docs_source_dir)
     }
     puts " -> images"
     FileUtils.cp_r("#{docs_source_dir}/configuration/images", "docs/configuration")
-    process_file("#{docs_source_dir}/addons", "actions.md", "docs/configuration", "#{$docs_repo_root}/addons/actions.md")
-    process_file("#{docs_source_dir}/addons", "transformations.md", "docs/configuration", "#{$docs_repo_root}/addons/transformations.md")
     #process_file("#{docs_source_dir}/tutorials", "migration.md", "docs/configuration/migration", "#{$docs_repo_root}/tutorials/migration.md")
     #FileUtils.mv("docs/configuration/migration/migration.md", "docs/configuration/migration/index.md")
     #FileUtils.cp_r("#{docs_source_dir}/tutorials/images", "docs/configuration/migration")

diff --git a/addons/bindings.md b/addons/bindings.md
diff --git a/addons/images/index_installation_paperui.gif b/addons/images/index_installation_paperui.gif
diff --git a/addons/index.md b/addons/index.md
diff --git a/addons/io.md b/addons/io.md
diff --git a/addons/persistence.md b/addons/persistence.md
diff --git a/addons/uis.md b/addons/uis.md
diff --git a/addons/voices.md b/addons/voices.md
diff --git a/addons/actions.md → configuration/actions.md b/addons/actions.md → configuration/actions.md
@@ -386,7 +386,8 @@ We recommend placing these custom files somewhere inside your `$OH_CONF` folder,
 
 #### Localization
 
-Ephemeris supports translation of holidays into many languages. Localization support files can be found in the [GitHub repo](https://github.com/focus-shift/jollyday/tree/main/jollyday-core/src/main/resources/descriptions). Currently these language supports are available:
+Ephemeris supports translation of holidays into many languages. Localization support files can be found in the [GitHub repo](https://github.com/focus-shift/jollyday/tree/main/jollyday-core/src/main/resources/descriptions).
+Currently, these language supports are available:
 
 1. [Dutch](https://github.com/focus-shift/jollyday/tree/main/jollyday-core/src/main/resources/descriptions/holiday_descriptions_nl.properties)
 1. [English](https://github.com/focus-shift/jollyday/tree/main/jollyday-core/src/main/resources/descriptions/holiday_descriptions.properties)
@@ -396,56 +397,10 @@ Ephemeris supports translation of holidays into many languages. Localization sup
 1. [Portuguese](https://github.com/focus-shift/jollyday/tree/main/jollyday-core/src/main/resources/descriptions/holiday_descriptions_pt.properties)
 1. [Swedish](https://github.com/focus-shift/jollyday/tree/main/jollyday-core/src/main/resources/descriptions/holiday_descriptions_sv.properties)
 
-Feel free to extent this list by providing additional language support files.
-
-To enable localization,
-
-- copy the file for your language to your OH setup.
-  - again a folder in `$OH_CONF` folder, such as `$OH_CONF/services` is proposed.
-- use function 'Ephemeris.getHolidayDescription' to convert the name according to your localization file.
-
-## Installable Actions
-
-The following actions are available as installable add-ons.
-
-<table id="actions-select" class="striped">
-  <tbody>
-    <tr>
-      <td width="20%">
-        <p>
-          <input type="checkbox" class="filled-in" id="manual-checkbox" />
-          <label for="manual-checkbox"><img src="{{base}}/images/tag-install-manual.svg"></label>
-        </p>
-      </td>
-      <td>
-        <p>
-        Some openHAB 1 actions have not yet completed validation for inclusion in the distribution; however, they may indeed work properly under openHAB 2.
-        All openHAB 1 addons can be downloaded in a <a href="https://bintray.com/openhab/mvn/download_file?file_path=org%2Fopenhab%2Fdistro%2Fopenhab%2F1.9.0%2Fopenhab-1.9.0-addons.zip">zip file</a>.
-        We need your help testing them so that they may be easily installed in a future distribution.
-        Please see the <a href="{{base}}/developers/development/compatibilitylayer.html#how-to-use-openhab-1x-add-ons-that-are-not-part-of-the-distribution">compatibility layer documentation</a> and
-        also search the <a href="https://community.openhab.org">openHAB community forum</a> for the latest information and steps for manual installation.
-        </p>
-      </td>
-    </tr>
-  </tbody>
-</table>
-
-<table id="actions-overview" class="bordered addon-table">
-  <thead>
-    <tr>
-      <th data-field="label" width="20%">Name</th>
-      <th data-field="description">Description</th>
-    </tr>
-  </thead>
-  <tbody>
-    {% for action in site.addons_actions %}
-        <tr class="install-{{action.install}} since-{{action.since}}">
-          <td>
-            <h4><a href="{{base}}{{action.url}}">{% if action.logo %}<img class="logo" src="{{base}}/{{action.logo}}" title="{{ action.label }}" alt="{{ action.label }}" />{% else %}{{ action.label }}{% endif %}</a></h4>
-            <img src="{{base}}/images/tag-since-{{action.since}}.svg"> <img src="{{base}}/images/tag-install-{{action.install}}.svg">
-          </td>
-          <td>{{ action.description | markdownify }}</td>
-        </tr>
-    {% endfor %}
- </tbody>
-</table>
+Feel free to extend this list by providing additional language support files.
+
+To enable localization:
+
+- Copy the file for your language to your OH setup.
+  - A folder in `$OH_CONF` folder, such as `$OH_CONF/services` is proposed.
+- Use the function `Ephemeris.getHolidayDescription` to convert the name according to your localization file.