Skip to content

Commit

Permalink
Merge pull request #1692 from folio-org/FOLIO-873-improve-docs-270
Browse files Browse the repository at this point in the history
FOLIO-873 improve docs
  • Loading branch information
dcrossleyau authored Jul 2, 2024
2 parents db264a4 + a74fab3 commit 3061484
Show file tree
Hide file tree
Showing 5 changed files with 40 additions and 12 deletions.
44 changes: 36 additions & 8 deletions _data/repos.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"metadata": {
"generatedDateTime": "2024-06-18T05:30:36.498100+00:00"
"generatedDateTime": "2024-07-02T01:07:37.886603+00:00"
},
"repos": [
{
Expand Down Expand Up @@ -520,6 +520,16 @@
"build-npm.yml"
]
},
{
"defaultBranch": "master",
"description": "Repository to manage deployment code to run Eureka platform",
"docDirName": null,
"name": "eureka-setup",
"org": "folio-org",
"repoLanguageHint": "other",
"repoType": "other",
"snippetIntro": "<ul>\n<li>Repository for Eureka-based environments</li>\n</ul>"
},
{
"defaultBranch": "main",
"description": "Community query repository for FOLIO analytics based on Metadb/LDP",
Expand Down Expand Up @@ -887,7 +897,7 @@
},
{
"defaultBranch": "master",
"description": "Various tools and support glue for FOLIO CI",
"description": "Various tools, and support glue for FOLIO CI",
"docDirName": null,
"name": "folio-tools",
"org": "folio-org",
Expand Down Expand Up @@ -2811,6 +2821,7 @@
"workflows": [
"deploy.yml",
"gradle.yml",
"iso18626.yml",
"release.yml"
]
},
Expand Down Expand Up @@ -3490,6 +3501,24 @@
"build-npm.yml"
]
},
{
"defaultBranch": "master",
"description": "Components to be used by modules and applications that handle Authorization (ui-authorization-roles, ui-authorization-capabilities, etc.) duties. Other modules and applications may not find them as useful.",
"docDirName": null,
"name": "stripes-authorization-components",
"org": "folio-org",
"repoLanguageHint": "node",
"repoType": "stripes",
"snippetIntro": "<p>This is a library of React components and utility functions for use with <a href='https://github.com/folio-org/stripes-core/'>the Stripes UI toolkit</a>, part of <a href='https://www.folio.org/'>the FOLIO project</a>.</p>",
"workflows": [
"build-npm-release.yml",
"build-npm.yml"
],
"workflowsFolio": [
"build-npm-release.yml",
"build-npm.yml"
]
},
{
"defaultBranch": "master",
"description": "Command line interface for creating, building, and testing Stripes UI modules.",
Expand Down Expand Up @@ -3908,13 +3937,11 @@
"repoType": "ui",
"snippetIntro": "<p>The Agreements UI Module, or <code>ui-agreements</code>, is a Stripes UI module used for management of various E-resource tasks including handling agreements and viewing available E-resources.</p>",
"workflows": [
"build-npm-release.yml",
"build-npm.yml",
"stuck-license-cla.yml"
"stuck-license-cla.yml",
"ui.yml"
],
"workflowsFolio": [
"build-npm-release.yml",
"build-npm.yml"
"ui.yml"
]
},
{
Expand Down Expand Up @@ -4948,7 +4975,8 @@
"snippetIntro": "<p>This package furnishes a single Stripes plugin of type <code>find-license</code>, which can be included in Stripes modules by means of a <code>&lt;Pluggable type='find-license'&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"
"build-npm.yml",
"stuck-license-cla.yml"
],
"workflowsFolio": [
"build-npm-release.yml",
Expand Down
2 changes: 1 addition & 1 deletion _faqs/how-to-request-github-access.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ faqOrder: 2

## GitHub new developer

For new developers (i.e. not yet a [member](https://github.com/orgs/folio-org/people) of "folio-org" organization) we ask that a project manager (see [Team and module responsibility matrix](https://folio-org.atlassian.net/wiki/x/plAV)) or at least a known existing developer, makes this request.
For new developers (i.e. not yet a [member](https://github.com/orgs/folio-org/people) of "folio-org" organization) we ask that a project manager (see [Team and module responsibility matrix](https://folio-org.atlassian.net/wiki/x/kIBP)) or at least a known existing developer, makes this request.

They need to either request on the #devops Slack channel, or [raise a FOLIO DevOps Jira ticket](/faqs/how-to-raise-devops-ticket/#general-folio-devops). Especially do the latter with a group of new people.

Expand Down
2 changes: 1 addition & 1 deletion community/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ Since [commencing](/about/) in mid-2016 the FOLIO project continues to grow.
Some contact points for the communities:

* [Collaboration tools](#collaboration-tools).
* [Team and module responsibility matrix](https://folio-org.atlassian.net/wiki/x/plAV).
* [Team and module responsibility matrix](https://folio-org.atlassian.net/wiki/x/kIBP).
* [List of GitHub Teams](https://github.com/orgs/folio-org/teams).
* [Development teams wiki space](https://wiki.folio.org/display/FOLIJET/).
* [Testing Community wiki space](https://wiki.folio.org/display/FTC/Folio+Testing+Community+Home).
Expand Down
2 changes: 1 addition & 1 deletion guidelines/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ and FOLIO Product Council ([PC](/reference/glossary/#pc)).
has their "Definition of Ready ([DoR](/reference/glossary/#dor))"
and "Definition of Done ([DoD](/reference/glossary/#dod))"
to manage the development process.
- [Team and module responsibility matrix](https://folio-org.atlassian.net/wiki/x/plAV).
- [Team and module responsibility matrix](https://folio-org.atlassian.net/wiki/x/kIBP).
- [Create a new FOLIO module and do initial setup](/guidelines/create-new-repo/).

## Other statements and policies
Expand Down
2 changes: 1 addition & 1 deletion guides/devops-introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ The "Add" button is way to the right-hand side.

Developers can create their own Jira [accounts](/community/#collaboration-tools).

Occasionally a project manager (see [team matrix](https://folio-org.atlassian.net/wiki/x/plAV)) will request special access to maintain the "Fix Version/s" settings.
Occasionally a project manager (see [team matrix](https://folio-org.atlassian.net/wiki/x/kIBP)) will request special access to maintain the "Fix Version/s" settings.

Visit the Jira admin "User management" and filter to find the relevant user.
Add the Group "external-core-collaborators".
Expand Down

0 comments on commit 3061484

Please sign in to comment.