From 1b898d3080fe1481f45792cb7f06911df7769451 Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Fri, 14 Feb 2020 19:39:34 +0100 Subject: [PATCH] :hammer: Re-branding --- .github/settings.yml | 4 ++-- CHANGELOG.md | 13 ------------- README.md | 18 +++++++++--------- jupyterlab/.README.j2 | 8 ++++---- jupyterlab/Dockerfile | 2 +- .../rootfs/etc/cont-init.d/10-requirements.sh | 2 +- jupyterlab/rootfs/etc/cont-init.d/11-nginx.sh | 2 +- .../rootfs/etc/cont-init.d/20-notebooks-dir.sh | 2 +- .../etc/cont-init.d/21-persistent-storage.sh | 2 +- jupyterlab/rootfs/etc/cont-init.d/51-github.sh | 2 +- .../etc/cont-init.d/80-system-packages.sh | 2 +- .../rootfs/etc/cont-init.d/81-user-scripts.sh | 2 +- jupyterlab/rootfs/etc/nginx/ha-auth.lua | 6 +++--- .../rootfs/etc/services.d/jupyter/finish | 2 +- jupyterlab/rootfs/etc/services.d/jupyter/run | 2 +- jupyterlab/rootfs/etc/services.d/nginx/finish | 2 +- jupyterlab/rootfs/etc/services.d/nginx/run | 2 +- 17 files changed, 30 insertions(+), 43 deletions(-) delete mode 100644 CHANGELOG.md diff --git a/.github/settings.yml b/.github/settings.yml index 06a4ded..ae597eb 100644 --- a/.github/settings.yml +++ b/.github/settings.yml @@ -1,8 +1,8 @@ --- repository: - description: "JupyterLab Lite - Community Hass.io Add-on for Home Assistant" + description: "JupyterLab Lite - Home Assistant Community Add-ons" homepage: https://addons.community - topics: jupyter, jupyterlab, hassio-addons, hassio, hass, home-assistant, homeassistant + topics: jupyter, jupyterlab, addon, addons, home-assistant, homeassistant private: false has_issues: true has_projects: false diff --git a/CHANGELOG.md b/CHANGELOG.md deleted file mode 100644 index a7ab528..0000000 --- a/CHANGELOG.md +++ /dev/null @@ -1,13 +0,0 @@ -# Community Hass.io Add-ons: JupyterLab Lite - -All notable changes to this add-on will be documented in this file. - -The format is based on [Keep a Changelog][keep-a-changelog] -and this project adheres to [Semantic Versioning][semantic-versioning]. - -## Unreleased - -No are unreleased changes yet. - -[keep-a-changelog]: http://keepachangelog.com/en/1.0.0/ -[semantic-versioning]: http://semver.org/spec/v2.0.0.html diff --git a/README.md b/README.md index 11f33ee..54205e3 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Community Hass.io Add-ons: JupyterLab Lite +# Home Assistant Community Add-on: JupyterLab Lite [![GitHub Release][releases-shield]][releases] ![Project Stage][project-stage-shield] @@ -40,9 +40,9 @@ reproducible computing, based on the Jupyter Notebook and Architecture. ## Installation The installation of this add-on is pretty straightforward and not different in -comparison to installing any other Hass.io add-on. +comparison to installing any other Home Assistant add-on. -1. Search for the "JupyterLab Lite" add-on in the Hass.io add-on store +1. Search for the "JupyterLab Lite" add-on in the Supervisor add-on store and install it. 1. Start the "JupyterLab Lite" add-on 1. Check the logs of the "JupyterLab Lite" add-on to see if everything went well. @@ -106,13 +106,13 @@ Enables/Disables SSL (HTTPS) on the JupyterLab Set it `true` to enable it, The certificate file to use for SSL. -**Note**: _The file MUST be stored in `/ssl/`, which is default for Hass.io_ +**Note**: _The file MUST be stored in `/ssl/`, which is the default_ ### Option: `keyfile` The private key file to use for SSL. -**Note**: _The file MUST be stored in `/ssl/`, which is default for Hass.io_ +**Note**: _The file MUST be stored in `/ssl/`, which is the default_ ### Option: `system_packages` @@ -182,7 +182,7 @@ Got questions? You have several options to get them answered: -- The [Community Hass.io Add-ons Discord chat server][discord] for add-on +- The [Home Assistant Community Add-ons Discord chat server][discord] for add-on support and feature requests. - The [Home Assistant Discord chat server][discord-ha] for general Home Assistant discussions and questions. @@ -208,11 +208,11 @@ The original setup of this repository is by [Franck Nijhof][frenck]. For a full list of all authors and contributors, check [the contributor's page][contributors]. -## We have got some Hass.io add-ons for you +## We have got some Home Assistant add-ons for you -Want some more functionality to your Hass.io Home Assistant instance? +Want some more functionality to your Home Assistant instance? -We have created multiple add-ons for Hass.io. For a full list, check out +We have created multiple add-ons for Home Assistant. For a full list, check out our [GitHub Repository][repository]. ## License diff --git a/jupyterlab/.README.j2 b/jupyterlab/.README.j2 index 9e7e0ae..ff234b9 100644 --- a/jupyterlab/.README.j2 +++ b/jupyterlab/.README.j2 @@ -1,4 +1,4 @@ -# Community Hass.io Add-ons: JupyterLab Lite +# Home Assistant Community Add-on: JupyterLab Lite [![Release][release-shield]][release] ![Project Stage][project-stage-shield] ![Project Maintenance][maintenance-shield] @@ -29,8 +29,8 @@ reproducible computing, based on the Jupyter Notebook and Architecture. {% if channel == "edge" %} ## WARNING! THIS IS AN EDGE VERSION! -This Hass.io Add-ons repository contains edge builds of add-ons. Edge builds -add-ons are based upon the latest development version. +This Home Assistant Add-ons repository contains edge builds of add-ons. +Edge builds add-ons are based upon the latest development version. - They may not work at all. - They might stop working at any time. @@ -50,7 +50,7 @@ If you are more interested in stable releases of our add-ons: {% if channel == "beta" %} ## WARNING! THIS IS A BETA VERSION! -This Hass.io Add-ons repository contains beta releases of add-ons. +This Home Assistant Add-ons repository contains beta releases of add-ons. - They might stop working at any time. - They could have a negative impact on your system. diff --git a/jupyterlab/Dockerfile b/jupyterlab/Dockerfile index 9a38819..fced229 100644 --- a/jupyterlab/Dockerfile +++ b/jupyterlab/Dockerfile @@ -134,4 +134,4 @@ LABEL \ org.label-schema.usage="https://github.com/hassio-addons/addon-jupyterlab-lite/tree/master/README.md" \ org.label-schema.vcs-ref=${BUILD_REF} \ org.label-schema.vcs-url="https://github.com/hassio-addons/addon-jupyterlab-lite" \ - org.label-schema.vendor="Community Hass.io Add-ons" + org.label-schema.vendor="Home Assistant Community Add-ons" diff --git a/jupyterlab/rootfs/etc/cont-init.d/10-requirements.sh b/jupyterlab/rootfs/etc/cont-init.d/10-requirements.sh index 06310de..de034f5 100644 --- a/jupyterlab/rootfs/etc/cont-init.d/10-requirements.sh +++ b/jupyterlab/rootfs/etc/cont-init.d/10-requirements.sh @@ -1,6 +1,6 @@ #!/usr/bin/with-contenv bashio # ============================================================================== -# Community Hass.io Add-ons: JupyterLab Lite +# Home Assistant Community Add-on: JupyterLab Lite # This files check if all user configuration requirements are met # ============================================================================== bashio::config.require.ssl diff --git a/jupyterlab/rootfs/etc/cont-init.d/11-nginx.sh b/jupyterlab/rootfs/etc/cont-init.d/11-nginx.sh index 8d554b2..6640e54 100644 --- a/jupyterlab/rootfs/etc/cont-init.d/11-nginx.sh +++ b/jupyterlab/rootfs/etc/cont-init.d/11-nginx.sh @@ -1,6 +1,6 @@ #!/usr/bin/with-contenv bashio # ============================================================================== -# Community Hass.io Add-ons: JupyterLab Lite +# Home Assistant Community Add-on: JupyterLab Lite # Configures NGINX for use with JupyterLab # ============================================================================== declare certfile diff --git a/jupyterlab/rootfs/etc/cont-init.d/20-notebooks-dir.sh b/jupyterlab/rootfs/etc/cont-init.d/20-notebooks-dir.sh index 5866be8..90c9f7d 100644 --- a/jupyterlab/rootfs/etc/cont-init.d/20-notebooks-dir.sh +++ b/jupyterlab/rootfs/etc/cont-init.d/20-notebooks-dir.sh @@ -1,6 +1,6 @@ #!/usr/bin/with-contenv bashio # ============================================================================== -# Community Hass.io Add-ons: JupyterLab Lite +# Home Assistant Community Add-on: JupyterLab Lite # Ensures the JupyterLab notebooks directory exists # ============================================================================== readonly BOOKS="/config/notebooks/" diff --git a/jupyterlab/rootfs/etc/cont-init.d/21-persistent-storage.sh b/jupyterlab/rootfs/etc/cont-init.d/21-persistent-storage.sh index 1f8eba4..6351de0 100644 --- a/jupyterlab/rootfs/etc/cont-init.d/21-persistent-storage.sh +++ b/jupyterlab/rootfs/etc/cont-init.d/21-persistent-storage.sh @@ -1,6 +1,6 @@ #!/usr/bin/with-contenv bashio # ============================================================================== -# Community Hass.io Add-ons: JupyterLab Lite +# Home Assistant Community Add-on: JupyterLab Lite # Ensure directories in the persistent storage exists # ============================================================================== if ! bashio::fs.directory_exists '/data/user-settings'; then diff --git a/jupyterlab/rootfs/etc/cont-init.d/51-github.sh b/jupyterlab/rootfs/etc/cont-init.d/51-github.sh index 0b11bb3..aeaaf36 100644 --- a/jupyterlab/rootfs/etc/cont-init.d/51-github.sh +++ b/jupyterlab/rootfs/etc/cont-init.d/51-github.sh @@ -1,6 +1,6 @@ #!/usr/bin/with-contenv bashio # ============================================================================== -# Community Hass.io Add-ons: JupyterLab Lite +# Home Assistant Community Add-on: JupyterLab Lite # Install the users GitHub Access token into JupyterLab # ============================================================================== readonly CONFIG_PATH="/etc/jupyter/jupyter_notebook_config.py" diff --git a/jupyterlab/rootfs/etc/cont-init.d/80-system-packages.sh b/jupyterlab/rootfs/etc/cont-init.d/80-system-packages.sh index a9ad915..4b2780a 100644 --- a/jupyterlab/rootfs/etc/cont-init.d/80-system-packages.sh +++ b/jupyterlab/rootfs/etc/cont-init.d/80-system-packages.sh @@ -1,6 +1,6 @@ #!/usr/bin/with-contenv bashio # ============================================================================== -# Community Hass.io Add-ons: JupyterLab Lite +# Home Assistant Community Add-on: JupyterLab Lite # Install user configured/requested packages # ============================================================================== if bashio::config.has_value 'system_packages'; then diff --git a/jupyterlab/rootfs/etc/cont-init.d/81-user-scripts.sh b/jupyterlab/rootfs/etc/cont-init.d/81-user-scripts.sh index dfd4bf1..70cd097 100644 --- a/jupyterlab/rootfs/etc/cont-init.d/81-user-scripts.sh +++ b/jupyterlab/rootfs/etc/cont-init.d/81-user-scripts.sh @@ -1,6 +1,6 @@ #!/usr/bin/with-contenv bashio # ============================================================================== -# Community Hass.io Add-ons: JupyterLab Lite +# Home Assistant Community Add-on: JupyterLab Lite # Executes user configured/requested commands on startup # ============================================================================== if bashio::config.has_value 'init_commands'; then diff --git a/jupyterlab/rootfs/etc/nginx/ha-auth.lua b/jupyterlab/rootfs/etc/nginx/ha-auth.lua index 998b509..7aa9d3e 100644 --- a/jupyterlab/rootfs/etc/nginx/ha-auth.lua +++ b/jupyterlab/rootfs/etc/nginx/ha-auth.lua @@ -29,7 +29,7 @@ function authenticate() return true end - --- HTTP request against Hassio API + --- HTTP request against the Supervisor API local httpc = http.new() local res, err = httpc:request_uri("http://supervisor.local.hass.io/auth", { method = "POST", @@ -44,13 +44,13 @@ function authenticate() --- Error during API request if err then - ngx.log(ngx.WARN, "Error during Hassio user authentication.", err) + ngx.log(ngx.WARN, "Error during Home Assistant user authentication.", err) return false end --- No result? Something went wrong... if not res then - ngx.log(ngx.WARN, "Error during Hassio user authentication.") + ngx.log(ngx.WARN, "Error during Home Assistant user authentication.") return false end diff --git a/jupyterlab/rootfs/etc/services.d/jupyter/finish b/jupyterlab/rootfs/etc/services.d/jupyter/finish index 8a479a0..060d272 100644 --- a/jupyterlab/rootfs/etc/services.d/jupyter/finish +++ b/jupyterlab/rootfs/etc/services.d/jupyter/finish @@ -1,6 +1,6 @@ #!/usr/bin/execlineb -S0 # ============================================================================== -# Community Hass.io Add-ons: JupyterLab Lite +# Home Assistant Community Add-on: JupyterLab Lite # Take down the S6 supervision tree when the Jupyter daemon fails # ============================================================================== if -n { s6-test $# -ne 0 } diff --git a/jupyterlab/rootfs/etc/services.d/jupyter/run b/jupyterlab/rootfs/etc/services.d/jupyter/run index d95b8d3..632fe44 100644 --- a/jupyterlab/rootfs/etc/services.d/jupyter/run +++ b/jupyterlab/rootfs/etc/services.d/jupyter/run @@ -1,7 +1,7 @@ #!/usr/bin/with-contenv bashio # shellcheck disable=SC2191 # ============================================================================== -# Community Hass.io Add-ons: JupyterLab Lite +# Home Assistant Community Add-on: JupyterLab Lite # Runs Jupyter # ============================================================================== declare -a options diff --git a/jupyterlab/rootfs/etc/services.d/nginx/finish b/jupyterlab/rootfs/etc/services.d/nginx/finish index 607eceb..7c06f65 100644 --- a/jupyterlab/rootfs/etc/services.d/nginx/finish +++ b/jupyterlab/rootfs/etc/services.d/nginx/finish @@ -1,6 +1,6 @@ #!/usr/bin/execlineb -S0 # ============================================================================== -# Community Hass.io Add-ons: JupyterLab Lite +# Home Assistant Community Add-on: JupyterLab Lite # Take down the S6 supervision tree when Nginx fails # ============================================================================== if -n { s6-test $# -ne 0 } diff --git a/jupyterlab/rootfs/etc/services.d/nginx/run b/jupyterlab/rootfs/etc/services.d/nginx/run index 170582b..2b44d69 100644 --- a/jupyterlab/rootfs/etc/services.d/nginx/run +++ b/jupyterlab/rootfs/etc/services.d/nginx/run @@ -1,6 +1,6 @@ #!/usr/bin/with-contenv bashio # ============================================================================== -# Community Hass.io Add-ons: JupyterLab Lite +# Home Assistant Community Add-on: JupyterLab Lite # Runs the Nginx daemon # ==============================================================================