Skip to content

Commit

Permalink
Merge pull request #1530 from folio-org/FOLIO-873-improve-docs-246
Browse files Browse the repository at this point in the history
Update software map;  configure new api-related
  • Loading branch information
dcrossleyau committed Dec 14, 2023
2 parents 301d625 + c34acdd commit 02c03fe
Show file tree
Hide file tree
Showing 2 changed files with 201 additions and 5 deletions.
6 changes: 6 additions & 0 deletions _data/apigroup.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,15 @@ login:
- mod-authtoken
- mod-password-validator
- mod-permissions
- mod-login-keycloak
users:
title: Users
description: Information about users.
modules:
- mod-users-bl
- mod-users
- mod-roles-keycloak
- mod-users-keycloak
- mod-patron
- edge-patron
- mod-patron-blocks
Expand Down Expand Up @@ -136,6 +139,9 @@ other:
- folio-query-tool-metadata
- folio-spring-support
- folio-vertx-lib
- mgr-applications
- mgr-tenants
- mgr-tenant-entitlements
deprecated:
title: Deprecated
description: Some old ones that have been renamed recently.
Expand Down
200 changes: 195 additions & 5 deletions _data/repos.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"metadata": {
"generatedDateTime": "2023-11-30T00:17:22.702443+00:00"
"generatedDateTime": "2023-12-13T12:47:20.044419+00:00"
},
"repos": [
{
Expand All @@ -19,6 +19,36 @@
"api-schema-lint.yml"
]
},
{
"defaultBranch": "master",
"description": null,
"docDirName": null,
"name": "application-builder",
"org": "folio-org",
"repoLanguageHint": "other",
"repoType": "other",
"snippetIntro": ""
},
{
"defaultBranch": "master",
"description": null,
"docDirName": null,
"name": "application-descriptors",
"org": "folio-org",
"repoLanguageHint": "other",
"repoType": "other",
"snippetIntro": ""
},
{
"defaultBranch": "master",
"description": null,
"docDirName": null,
"name": "applications-poc-tools",
"org": "folio-org",
"repoLanguageHint": "other",
"repoType": "other",
"snippetIntro": "<p>Library with general purpose classes to help with FOLIO backend development and testing</p>"
},
{
"defaultBranch": "master",
"description": "The library to handle events from data-import",
Expand Down Expand Up @@ -504,6 +534,16 @@
"api-schema-lint.yml"
]
},
{
"defaultBranch": "master",
"description": null,
"docDirName": null,
"name": "folio-flow-engine",
"org": "folio-org",
"repoLanguageHint": "other",
"repoType": "other",
"snippetIntro": "<p>This is a simple flow engine that can be used to execute a series of tasks in a specific order. The tasks are executed in a separate thread. The tasks are executed in the order they are added to the flow. The flow can be executed multiple times. The flow can be executed in parallel or in sequence.</p>"
},
{
"defaultBranch": "master",
"description": "Serves up GraphiQL for use with FOLIO",
Expand Down Expand Up @@ -577,6 +617,16 @@
"repoType": "other",
"snippetIntro": "<p>ISBN number converter utilities.</p>"
},
{
"defaultBranch": "master",
"description": null,
"docDirName": null,
"name": "folio-java-checkstyle",
"org": "folio-org",
"repoLanguageHint": "other",
"repoType": "other",
"snippetIntro": "<p>This repository contains the checkstyle configuration for the FOLIO Java projects.</p>"
},
{
"defaultBranch": "master",
"description": "Library with transport layer's utilities for interaction with Kafka ",
Expand Down Expand Up @@ -840,6 +890,42 @@
"repoType": "other",
"snippetIntro": ""
},
{
"defaultBranch": "master",
"description": null,
"docDirName": null,
"hintOas": true,
"name": "mgr-applications",
"org": "folio-org",
"ramlDirName": null,
"repoLanguageHint": "other",
"repoType": "backend-mod",
"snippetIntro": "<p><code>mgr-applications</code> provides following functionality:</p>"
},
{
"defaultBranch": "master",
"description": null,
"docDirName": null,
"hintOas": true,
"name": "mgr-tenant-entitlements",
"org": "folio-org",
"ramlDirName": null,
"repoLanguageHint": "other",
"repoType": "backend-mod",
"snippetIntro": "<p><code>mgr-tenant-entitlements</code> provides following functionality:</p>"
},
{
"defaultBranch": "master",
"description": null,
"docDirName": null,
"hintOas": true,
"name": "mgr-tenants",
"org": "folio-org",
"ramlDirName": null,
"repoLanguageHint": "other",
"repoType": "backend-mod",
"snippetIntro": "<p>For now, <code>mgr-tenants</code> proxies requests to OKAPI's tenant API When any operation will happen on tenant, it will take place on realm in keycloak, also it will send a request to keycloak to retrieve a token and persist in cache for 60s for doing all the stuff related to realm</p>"
},
{
"defaultBranch": "master",
"description": "A FOLIO Module for handling the server side work needed for the ERM system",
Expand Down Expand Up @@ -1311,7 +1397,9 @@
"repoType": "backend-mod",
"snippetIntro": "<p>Mod-Directory is a service intiailly proposed for use in resource sharing environments but offering services to any library scenario that involves documenting and using service interactions between peers. It's purpose is to provide a bounded context for the storage, retrieval and update of directory service information which underpins inter-library services. This directory contains, but is not restricted to</p>",
"workflows": [
"gradle.yml"
"deploy.yml",
"gradle.yml",
"release.yml"
]
},
{
Expand Down Expand Up @@ -1938,6 +2026,19 @@
"api-schema-lint.yml"
]
},
{
"defaultBranch": "master",
"description": null,
"docDirName": null,
"hintOas": true,
"isSpringway": true,
"name": "mod-login-keycloak",
"org": "folio-org",
"ramlDirName": null,
"repoLanguageHint": "other",
"repoType": "backend-mod",
"snippetIntro": "<p>mod-login-keycloak provides following functionality:</p>"
},
{
"apiTypes": "RAML",
"defaultBranch": "master",
Expand Down Expand Up @@ -2414,6 +2515,19 @@
"repoType": "other",
"snippetIntro": "<p>This is a Maven archetype used to generate an RMB-based server-side module. Install this locally if you wish to build such a module.</p>"
},
{
"defaultBranch": "master",
"description": null,
"docDirName": null,
"hintOas": true,
"isSpringway": true,
"name": "mod-roles-keycloak",
"org": "folio-org",
"ramlDirName": null,
"repoLanguageHint": "other",
"repoType": "backend-mod",
"snippetIntro": "<p>For now, <code>mod-roles-keycloak</code> proxies requests to Keycloak. Service helps manage roles and policies: creating, updating, deleting and searching. The service can be used to associate roles with the user.<code>mod-roles-keycloak</code> stores metadata about who and when created a record.</p>"
},
{
"defaultBranch": "master",
"description": "Module providing Resource Sharing services to an OKAPI environment",
Expand All @@ -2425,7 +2539,8 @@
"snippetIntro": "",
"workflows": [
"deploy.yml",
"gradle.yml"
"gradle.yml",
"release.yml"
]
},
{
Expand Down Expand Up @@ -2754,6 +2869,19 @@
"api-schema-lint.yml"
]
},
{
"defaultBranch": "master",
"description": null,
"docDirName": null,
"hintOas": true,
"isSpringway": true,
"name": "mod-users-keycloak",
"org": "folio-org",
"ramlDirName": null,
"repoLanguageHint": "other",
"repoType": "backend-mod",
"snippetIntro": "<p>Business logic 'join' module to provide simple access to all user-centric data.</p>"
},
{
"defaultBranch": "master",
"description": null,
Expand Down Expand Up @@ -3480,6 +3608,42 @@
"build-npm.yml"
]
},
{
"defaultBranch": "master",
"description": "FOLIO app for Authorization Policies",
"docDirName": null,
"name": "ui-authorization-policies",
"org": "folio-org",
"repoLanguageHint": "node",
"repoType": "ui",
"snippetIntro": "<p>The Authorization Policies UI Module or ui-authorization-policies, is a Stripes UI module for the authorization roles requests and related resources</p>",
"workflows": [
"build-npm-release.yml",
"build-npm.yml"
],
"workflowsFolio": [
"build-npm-release.yml",
"build-npm.yml"
]
},
{
"defaultBranch": "master",
"description": "FOLIO app for Authorization Roles",
"docDirName": null,
"name": "ui-authorization-roles",
"org": "folio-org",
"repoLanguageHint": "node",
"repoType": "ui",
"snippetIntro": "",
"workflows": [
"build-npm-release.yml",
"build-npm.yml"
],
"workflowsFolio": [
"build-npm-release.yml",
"build-npm.yml"
]
},
{
"defaultBranch": "master",
"description": null,
Expand Down Expand Up @@ -4543,6 +4707,24 @@
"build-npm.yml"
]
},
{
"defaultBranch": "master",
"description": "Application-finder for Stripes",
"docDirName": null,
"name": "ui-plugin-select-application",
"org": "folio-org",
"repoLanguageHint": "node",
"repoType": "ui-plugin",
"snippetIntro": "<p>This package furnishes a single Stripes plugin of type <code>select-application</code>, which can be included in Stripes modules by means of a <code>&lt;Pluggable type='select-application'&gt;</code> element. See <a href='https://github.com/folio-org/stripes-core/blob/master/doc/dev-guide.md#plugins'>the <em>Plugins</em> section</a> of the Module Developer's Guide.</p>",
"workflows": [
"build-npm-release.yml",
"build-npm.yml"
],
"workflowsFolio": [
"build-npm-release.yml",
"build-npm.yml"
]
},
{
"defaultBranch": "master",
"description": "Stripes UI for quickMARC editor",
Expand Down Expand Up @@ -4657,7 +4839,15 @@
"name": "ui-rs",
"org": "openlibraryenvironment",
"repoType": "ui",
"snippetIntro": "<p>Congratulations on creating a new Stripes UI app module! Follow the instructions below to run ui-rs and start your development.</p>"
"snippetIntro": "<p>Congratulations on creating a new Stripes UI app module! Follow the instructions below to run ui-rs and start your development.</p>",
"workflows": [
"build-npm-release.yml",
"build-npm.yml"
],
"workflowsFolio": [
"build-npm-release.yml",
"build-npm.yml"
]
},
{
"defaultBranch": "master",
Expand Down Expand Up @@ -4783,7 +4973,7 @@
"name": "ui-update",
"org": "openlibraryenvironment",
"repoType": "ui",
"snippetIntro": "<p>Congratulations on creating a new Stripes UI app module! Follow the instructions below to run ui-scan and start your development.</p>",
"snippetIntro": "",
"workflows": [
"build-npm-release.yml",
"build-npm.yml"
Expand Down

0 comments on commit 02c03fe

Please sign in to comment.