correct param descriptions

Author: sidecus

README.md

@@ -1,7 +1,8 @@
 # My devcontainer features
 
+My devcontainer features using the [feature-starter](https://github.com/devcontainers/feature-starter) template.
 
-## `magircmirror`
+## `magicmirror`
 
 Automatically setup package manager mirrors, including ubuntu, pypi and apk etc.
 
@@ -10,91 +11,9 @@ Automatically setup package manager mirrors, including ubuntu, pypi and apk etc.
     "image": "mcr.microsoft.com/devcontainers/base:ubuntu",
     "features": {
         "ghcr.io/sidecus/devcontainer-features/magicmirror:1": {
-            "pypi_mirror": "https://mirrors.bfsu.edu.cn/pypi/web/simple/",
-            "ubuntu_mirror": "mirrors.bfsu.edu.cn",
-            "apk_mirror": "mirrors.tuna.tsinghua.edu.cn"
-        }
-    }
-}
-```
-
-## Distributing Features
-
-### Versioning
-
-Features are individually versioned by the `version` attribute in a Feature's `devcontainer-feature.json`.  Features are versioned according to the semver specification. More details can be found in [the dev container Feature specification](https://containers.dev/implementors/features/#versioning).
-
-### Publishing
-
-> NOTE: The Distribution spec can be [found here](https://containers.dev/implementors/features-distribution/).  
->
-> While any registry [implementing the OCI Distribution spec](https://github.com/opencontainers/distribution-spec) can be used, this template will leverage GHCR (GitHub Container Registry) as the backing registry.
-
-Features are meant to be easily sharable units of dev container configuration and installation code.  
-
-This repo contains a **GitHub Action** [workflow](.github/workflows/release.yaml) that will publish each Feature to GHCR. 
-
-*Allow GitHub Actions to create and approve pull requests* should be enabled in the repository's `Settings > Actions > General > Workflow permissions` for auto generation of `src/<feature>/README.md` per Feature (which merges any existing `src/<feature>/NOTES.md`).
-
-By default, each Feature will be prefixed with the `<owner/<repo>` namespace.  For example, the two Features in this repository can be referenced in a `devcontainer.json` with:
-
-```
-ghcr.io/devcontainers/feature-starter/color:1
-ghcr.io/devcontainers/feature-starter/hello:1
-```
-
-The provided GitHub Action will also publish a third "metadata" package with just the namespace, eg: `ghcr.io/devcontainers/feature-starter`.  This contains information useful for tools aiding in Feature discovery.
-
-'`devcontainers/feature-starter`' is known as the feature collection namespace.
-
-### Marking Feature Public
-
-Note that by default, GHCR packages are marked as `private`.  To stay within the free tier, Features need to be marked as `public`.
-
-This can be done by navigating to the Feature's "package settings" page in GHCR, and setting the visibility to 'public`.  The URL may look something like:
-
-```
-https://github.com/users/<owner>/packages/container/<repo>%2F<featureName>/settings
-```
-
-<img width="669" alt="image" src="https://user-images.githubusercontent.com/23246594/185244705-232cf86a-bd05-43cb-9c25-07b45b3f4b04.png">
-
-### Adding Features to the Index
-
-If you'd like your Features to appear in our [public index](https://containers.dev/features) so that other community members can find them, you can do the following:
-
-* Go to [github.com/devcontainers/devcontainers.github.io](https://github.com/devcontainers/devcontainers.github.io)
-     * This is the GitHub repo backing the [containers.dev](https://containers.dev/) spec site
-* Open a PR to modify the [collection-index.yml](https://github.com/devcontainers/devcontainers.github.io/blob/gh-pages/_data/collection-index.yml) file
-
-This index is from where [supporting tools](https://containers.dev/supporting) like [VS Code Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) and [GitHub Codespaces](https://github.com/features/codespaces) surface Features for their dev container creation UI.
-
-#### Using private Features in Codespaces
-
-For any Features hosted in GHCR that are kept private, the `GITHUB_TOKEN` access token in your environment will need to have `package:read` and `contents:read` for the associated repository.
-
-Many implementing tools use a broadly scoped access token and will work automatically.  GitHub Codespaces uses repo-scoped tokens, and therefore you'll need to add the permissions in `devcontainer.json`
-
-An example `devcontainer.json` can be found below.
-
-```jsonc
-{
-    "image": "mcr.microsoft.com/devcontainers/base:ubuntu",
-    "features": {
-     "ghcr.io/my-org/private-features/hello:1": {
-            "greeting": "Hello"
-        }
-    },
-    "customizations": {
-        "codespaces": {
-            "repositories": {
-                "my-org/private-features": {
-                    "permissions": {
-                        "packages": "read",
-                        "contents": "read"
-                    }
-                }
-            }
+            "pypi_mirror": "your-pypi-mirror",
+            "ubuntu_mirror": "your-ubuntu-mirror",
+            "apk_mirror": "your-alpine-apk-mirror"
         }
     }
 }

src/magicmirror/devcontainer-feature.json

@@ -10,7 +10,7 @@
                 "https://mirrors.bfsu.edu.cn/pypi/web/simple/"
             ],
             "default": "",
-            "description": "Pypi mirror url"
+            "description": "Python Pypi mirror"
         },
         "ubuntu_mirror": {
             "type": "string",
@@ -26,7 +26,7 @@
                 "mirrors.tuna.tsinghua.edu.cn"
             ],
             "default": "",
-            "description": "Ubuntu mirror"
+            "description": "Alpine apk mirror"
         }
     },
     "installsAfter": [

src/magicmirror/install.sh

@@ -18,7 +18,7 @@ echo "The effective dev container containerUser's home directory is '$_CONTAINER
 OS=$(awk -F= '/^NAME/{print $2}' /etc/os-release)
 echo "Target OS is ${OS}"
 
-# Ubuntu mirror. TODO[sidecus]: Check this is Ubuntu
+# Ubuntu mirror, only run when OS is Ubuntu
 UBUNTU_MIRROR=${UBUNTU_MIRROR:-""}
 echo "UBUNTU_MIRROR: $UBUNTU_MIRROR"
 if [ "${OS}" = '"Ubuntu"' ] && [ -n "${UBUNTU_MIRROR}" ]; then
@@ -38,7 +38,7 @@ if [ -n "${PYPI_MIRROR}" ]; then
     echo "index-url = ${PYPI_MIRROR}" >> /etc/pip.conf
 fi
 
-# Alpine apk mirror.
+# Alpine apk mirror, only run when OS is Alpine
 APK_MIRROR=${APK_MIRROR:-""}
 echo "APK_MIRROR: $APK_MIRROR"
 if [ "${OS}" = '"Alpine Linux"' ] && [ -n "${APK_MIRROR}" ]; then