Merge pull request #87 from rails/rm-NOTES

rafaelfranca · web-flow · commit ac0985717894 · 2025-06-06T16:20:19.000-04:00
Add NOTES.md files to all features
diff --git a/features/src/activestorage/NOTES.md b/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.
diff --git a/features/src/activestorage/README.md b/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.
diff --git a/features/src/activestorage/devcontainer-feature.json b/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",
diff --git a/features/src/bun/NOTES.md b/features/src/bun/NOTES.md
@@ -0,0 +1,3 @@
+## OS Support
+
+This Feature should work on recent versions of Debian/Ubuntu-based distributions.
diff --git a/features/src/bun/devcontainer-feature.json b/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."
 }
diff --git a/features/src/bundler-cache/NOTES.md b/features/src/bundler-cache/NOTES.md
diff --git a/features/src/bundler-cache/devcontainer-feature.json b/features/src/bundler-cache/devcontainer-feature.json
@@ -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"
   },
diff --git a/features/src/mysql-client/NOTES.md b/features/src/mysql-client/NOTES.md
@@ -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).
diff --git a/features/src/mysql-client/devcontainer-feature.json b/features/src/mysql-client/devcontainer-feature.json
@@ -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."
 }
diff --git a/features/src/postgres-client/NOTES.md b/features/src/postgres-client/NOTES.md
@@ -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).
diff --git a/features/src/postgres-client/devcontainer-feature.json b/features/src/postgres-client/devcontainer-feature.json
@@ -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",
diff --git a/features/src/ruby/NOTES.md b/features/src/ruby/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.
diff --git a/features/src/ruby/devcontainer-feature.json b/features/src/ruby/devcontainer-feature.json
@@ -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": [
diff --git a/features/src/sqlite3/NOTES.md b/features/src/sqlite3/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.
diff --git a/features/src/sqlite3/devcontainer-feature.json b/features/src/sqlite3/devcontainer-feature.json
@@ -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."
 }

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+## OS Support`
	`2`	`+`
	`3`	+This Feature should work on recent versions of Debian/Ubuntu-based distributions with the `apt` package manager installed.
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+## OS Support`
	`2`	`+`
	`3`	`+This Feature should work on recent versions of Debian/Ubuntu-based distributions.`
Original file line number	Diff line number	Diff line change
`@@ -2,5 +2,5 @@`
`2`	`2`	`"id": "bun",`
`3`	`3`	`"version": "1.0.2",`
`4`	`4`	`"name": "Bun",`
`5`		`- "description": "Installs needed client-side dependencies for Rails apps using Bun"`
	`5`	`+ "description": "Installs needed client-side dependencies for Rails apps using Bun."`
`6`	`6`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,5 +2,5 @@`
`2`	`2`	`"id": "mysql-client",`
`3`	`3`	`"version": "1.1.1",`
`4`	`4`	`"name": "MySQL Client",`
`5`		`- "description": "Installs needed client-side dependencies for Rails apps using MySQL"`
	`5`	`+ "description": "Installs needed client-side dependencies for Rails apps using MySQL."`
`6`	`6`	`}`