Merge pull request #87 from rails/rm-NOTES

Add NOTES.md files to all features

Author: rafaelfranca

features/src/activestorage/NOTES.md

@@ -0,0 +1,3 @@
+## OS Support
+
+This Feature should work on recent versions of Debian/Ubuntu-based distributions with the `apt` package manager installed.

features/src/activestorage/README.md

@@ -20,8 +20,3 @@ Installs libvips, ffmpeg and poppler-utils which are required to use Active Stor
 
 ### VS Code Extensions
 
-## OS Support
-
-This Feature should work on recent versions of Debian/Ubuntu-based distributions with the `apt` package manager installed.
-
-`bash` is required to execute the `install.sh` script.

features/src/activestorage/devcontainer-feature.json

@@ -2,7 +2,7 @@
     "id": "activestorage",
     "version": "1.1.1",
     "name": "Active Storage",
-    "description": "Installs utilities needed for Rails Active Storage",
+    "description": "Installs libvips, ffmpeg and poppler-utils which are required to use Active Storage for Rails apps.",
     "options": {
         "variantProcessor": {
             "type": "string",

features/src/bun/NOTES.md

@@ -0,0 +1,3 @@
+## OS Support
+
+This Feature should work on recent versions of Debian/Ubuntu-based distributions.

features/src/bun/devcontainer-feature.json

@@ -2,5 +2,5 @@
     "id": "bun",
     "version": "1.0.2",
     "name": "Bun",
-    "description": "Installs needed client-side dependencies for Rails apps using Bun"
+    "description": "Installs needed client-side dependencies for Rails apps using Bun."
 }

features/src/bundler-cache/NOTES.md

@@ -2,7 +2,7 @@
   "id": "bundler-cache",
   "version": "1.0.1",
   "name": "Bundler cache",
-  "description": "Creates a volume for persisting the installed gems across different containers",
+  "description": "Creates a volume for persisting the installed gems across different containers.",
   "containerEnv": {
     "BUNDLE_PATH": "/bundle/vendor"
   },

features/src/bundler-cache/devcontainer-feature.json

@@ -0,0 +1,9 @@
+## OS Support
+
+This Feature should work on recent versions of Debian/Ubuntu-based distributions with the `apt` package manager installed.
+
+## Notes
+
+NOTE: This feature does not install the dependencies needed for the MySQL Server. For that we
+recommend running a service using the official
+[MySQL docker image](https://hub.docker.com/_/mysql).

features/src/mysql-client/NOTES.md

@@ -2,5 +2,5 @@
     "id": "mysql-client",
     "version": "1.1.1",
     "name": "MySQL Client",
-    "description": "Installs needed client-side dependencies for Rails apps using MySQL"
+    "description": "Installs needed client-side dependencies for Rails apps using MySQL."
 }

features/src/mysql-client/devcontainer-feature.json

@@ -0,0 +1,9 @@
+## OS Support
+
+This Feature should work on recent versions of Debian/Ubuntu-based distributions with the `apt` package manager installed.
+
+## Notes
+
+NOTE: This feature does not install the dependencies needed for the Postgres server.
+For that we recommend running a service using the official
+[Postgres docker image](https://hub.docker.com/_/postgres).

features/src/postgres-client/NOTES.md

@@ -2,7 +2,7 @@
     "id": "postgres-client",
     "version": "1.1.3",
     "name": "Postgres Client",
-    "description": "Installs needed client-side dependencies for Rails apps using Postgres",
+    "description": "Installs needed client-side dependencies for Rails apps using Postgres.",
     "options": {
         "version": {
             "type": "string",

features/src/postgres-client/devcontainer-feature.json

@@ -0,0 +1,3 @@
+## OS Support
+
+This Feature should work on recent versions of Debian/Ubuntu-based distributions with the `apt` package manager installed.

features/src/ruby/NOTES.md

@@ -2,7 +2,7 @@
     "id": "ruby",
     "version": "1.1.3",
     "name": "Ruby (via rbenv)",
-    "description": "Installs Ruby, rbenv, ruby-build and libraries needed to build Ruby",
+    "description": "Installs Ruby, rbenv, and ruby-build as well as the dependencies needed to build Ruby.",
     "customizations": {
         "vscode": {
             "extensions": [

features/src/ruby/devcontainer-feature.json

@@ -0,0 +1,3 @@
+## OS Support
+
+This Feature should work on recent versions of Debian/Ubuntu-based distributions with the `apt` package manager installed.

features/src/sqlite3/NOTES.md

@@ -2,5 +2,5 @@
     "id": "sqlite3",
     "version": "1.0.0",
     "name": "SQLite3",
-    "description": "Installs needed dependencies for Rails apps using SQLite3"
+    "description": "Installs needed dependencies for Rails apps using SQLite3."
 }