Merge pull request #1729 from folio-org/FOLIO-873-improve-docs-281

FOLIO-873 improve docs
folio-org · Sep 6, 2024 · f6b8d39 · f6b8d39
2 parents e1bb6dd + 7824918
commit f6b8d39
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 9 deletions.
diff --git a/_data/repos.json b/_data/repos.json
@@ -1,6 +1,6 @@
 {
   "metadata": {
-    "generatedDateTime": "2024-08-16T01:01:37.848012+00:00"
+    "generatedDateTime": "2024-09-05T07:42:10.833705+00:00"
   },
   "repos": [
     {
@@ -798,7 +798,20 @@
       "org": "folio-org",
       "repoLanguageHint": "other",
       "repoType": "other",
-      "snippetIntro": "<p>A docker image for keycloak installation</p>"
+      "snippetIntro": "<p>A docker image for keycloak installation</p>",
+      "workflows": [
+        "do-docker.yml"
+      ]
+    },
+    {
+      "defaultBranch": "master",
+      "description": "Folio plugins for Keycloak",
+      "docDirName": null,
+      "name": "folio-keycloak-plugins",
+      "org": "folio-org",
+      "repoLanguageHint": "java",
+      "repoType": "other",
+      "snippetIntro": "<p>A collection of Keycloak plugins used by Folio platform</p>"
     },
     {
       "defaultBranch": "master",
@@ -808,7 +821,10 @@
       "org": "folio-org",
       "repoLanguageHint": "other",
       "repoType": "other",
-      "snippetIntro": "<p>A docker image for kong.</p>"
+      "snippetIntro": "<p>A docker image for kong.</p>",
+      "workflows": [
+        "do-docker.yml"
+      ]
     },
     {
       "defaultBranch": "master",
@@ -2334,9 +2350,9 @@
       "defaultBranch": "master",
       "description": "FOLIO SAML login module",
       "docDirName": null,
-      "hasDbSchema": null,
+      "hasDbSchema": "blob/master/src/main/resources/templates/db_scripts/schema.json",
       "hintRmb": true,
-      "isRmb": null,
+      "isRmb": true,
       "name": "mod-login-saml",
       "org": "folio-org",
       "ramlDirName": "ramls",
@@ -2500,7 +2516,7 @@
       "ramlDirName": null,
       "repoLanguageHint": "java",
       "repoType": "backend-mod",
-      "snippetIntro": "<p>Okapi facade partially implements okapi\u2019s interface(s) via interactions w/ manager components.</p>",
+      "snippetIntro": "<p>Okapi facade partially implements okapi\ufffds interface(s) via interactions w/ manager components.</p>",
       "workflows": [
         "api-doc.yml",
         "api-lint.yml",
@@ -2849,7 +2865,7 @@
     {
       "apiTypes": "RAML",
       "defaultBranch": "main",
-      "description": "Plug-compatible reimplementation of mod-ldp",
+      "description": "Interface to Metadb/LDP reporting databases (plug-compatible reimplementation of mod-ldp)",
       "docDirName": "doc",
       "name": "mod-reporting",
       "org": "folio-org",
@@ -2861,6 +2877,7 @@
         "api-doc.yml",
         "api-lint.yml",
         "api-schema-lint.yml",
+        "do-go.yml",
         "docker.yml",
         "go.yml"
       ],
@@ -5258,7 +5275,7 @@
       "org": "folio-org",
       "repoLanguageHint": "node",
       "repoType": "ui",
-      "snippetIntro": "<p>Congratulations on creating a new Stripes UI app module!  Follow the instructions below to run ui-reading-room and start your development.</p>",
+      "snippetIntro": "<p>The <code>ui-reading-room</code> module facilitates the process of confirming patron access to the reading room, enabling staff users to effectively oversee and record patron entries.</p>",
       "workflows": [
         "build-npm-release.yml",
         "build-npm.yml",

diff --git a/guides/module-descriptor.md b/guides/module-descriptor.md
@@ -175,7 +175,7 @@ This environment variable must at least have the setting as shown in the [exampl
 
 <a id="dockerfile"></a>The module's Dockerfile needs to use a base image that has the feature "UseContainerSupport". Use that feature in conjunction with "MaxRAMPercentage".
 
-Note that all Java-based modules should now be [using Java 11](/faqs/how-to-specify-backend-java-ci/) or [using Java 17](/faqs/how-to-specify-backend-java-ci/).
+Note that all Java-based modules should now be [using Java 17](/faqs/how-to-specify-backend-java-ci/).
 
 Other necessary options can be appended (e.g. -XX:+PrintFlagsFinal).