Skip to content

Commit

Permalink
Merge pull request #1593 from folio-org/FOLIO-873-improve-docs-256
Browse files Browse the repository at this point in the history
FOLIO-873 improve docs
  • Loading branch information
dcrossleyau authored Feb 15, 2024
2 parents fa33428 + 19940cd commit 4065c38
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 12 deletions.
6 changes: 4 additions & 2 deletions _faqs/how-to-get-started-with-rancher.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,11 @@ Useful links:
Before commencing become familiar with this FAQ.
Some teams also provide [further general instructions](/guides/run-local-folio/#scratch-environments-rancher-docker).

For general assistance use the [Slack channel](/guidelines/which-forum/#slack) `#scratch-environments` and help via your team-specific channel.
For general assistance use the [Slack channel](/guidelines/which-forum/#slack) `#rancher-support` and help via your team-specific channel.

To raise Jira tickets related to scratch environments, refer to the [FAQ](/faqs/how-to-raise-devops-ticket/#rancher-scratch-environments).
To raise Jira tickets related to Rancher scratch environments, refer to the [FAQ](/faqs/how-to-raise-devops-ticket/#rancher-scratch-environments).

See the Wiki [How to work with Rancher environments](https://folio-org.atlassian.net/wiki/spaces/FOLIJET/pages/1396559/How+to+work+with+Rancher+environments).

The [Kitfox](https://wiki.folio.org/display/FOLIJET/Kitfox+Team+DevOps+-+Dev+Support) DevOps team wiki page has further resources regarding Rancher scratch environments.

Expand Down
2 changes: 1 addition & 1 deletion _faqs/how-to-raise-devops-ticket.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ The "Kitfox" team attends to the Rancher developer scratch environments.

Be familiar with the FAQ [How to get started with Rancher environment](/faqs/how-to-get-started-with-rancher/).

For general assistance, use the [Slack channel](/guidelines/which-forum/#slack) `#scratch-environments` and your team-specific channel.
For general assistance, use the [Slack channel](/guidelines/which-forum/#slack) `#rancher-support` and your team-specific channel.

For anything beyond simple assistance, please create a Jira ticket.
The DevOps teams are small and busy, so requests will need to be queued.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -90,32 +90,32 @@ Form controls require associated labels so that AT can convey the purpose of a t

Typical labeling of form elements is as follows (explicit labeling) our form controls set these up under the hood:
```
<!-- general html controls -->
{/* general html controls */}
<label for="inputid">username</label>
<input type="text" id="inputid" />
<!-- stripes-components controls -->
{/* stripes-components controls */}
<TextField label="username" />
```

Given this, a screen reader will announce 'username edit blank' when the user tabs to the field. Without the `<label>`, it simply announces 'edit blank'.

If visible labels are inadequate, `aria-label` can be used:
```
<!-- general html controls -->
{/* general html controls */}
<input type="text" aria-label="username" id="inputid" />
<!-- stripes-components controls -->
{/* stripes-components controls */}
<TextField aria-label="username" />
```
If the label is visible elsewhere in the page, its element can be associated with the input via `aria-labelledby`:
```
<!-- general html controls -->
{/* general html controls */}
<div id="columnlabel">starting date</div>
...
<input type="text" aria-labelledby="columnlabel" />
<!-- stripes-components controls -->
{/* stripes-components controls */}
<TextField aria-labelledby="columnlabel" />
```

Expand Down
2 changes: 1 addition & 1 deletion guidelines/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ See other orientation [guides](/guides/#background-orientation).
## Development management

- [Release procedures](/guidelines/release-procedures/).
- [Officially Supported Technologies](https://wiki.folio.org/display/TC/Officially+Supported+Technologies) for each upcoming release.
- [Officially Supported Technologies](https://wiki.folio.org/display/TC/Officially+Supported+Technologies) for each upcoming release (also known as Approved Technologies).
- FOLIO Technical Council ([TC](/reference/glossary/#tc))
and FOLIO Product Council ([PC](/reference/glossary/#pc)).
- Each FOLIO Development [Team](https://wiki.folio.org/display/FOLIJET/Folio+Development+Teams+Home)
Expand Down
6 changes: 4 additions & 2 deletions guides/developer-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,11 @@ and the [client-side](/source-code#client-side) Stripes toolkit.
Note that some parts of the development environment could be handled using
[folio-ansible](https://github.com/folio-org/folio-ansible) (virtual machines using Vagrant and Ansible).

Be aware of the [Officially Supported Technologies](https://wiki.folio.org/display/TC/Officially+Supported+Technologies) for each upcoming release.

Otherwise the development environment would need the following fundamental tools:

* Apache Maven (3.3+) -- For building and deploying Okapi and some server-side modules.
* Apache Maven (3.6+) -- For building and deploying Okapi and some server-side modules.
* Node.js ([Active LTS version](https://github.com/nodejs/Release#release-schedule)) -- For Stripes and for some modules, and for UI testing.
* Docker -- Recommended method for deployment.
* PostgreSQL (12) -- For running an external database to support storage modules.
Expand All @@ -41,7 +43,7 @@ As each FOLIO component can utilise whatever suite of appropriate tools, refer t

Occasionally it becomes necessary to specify minimum versions of some tools:

* Java: [11](/faqs/how-to-specify-backend-java-ci/).
* Java: [17](/faqs/how-to-specify-backend-java-ci/).
* Postgres: [12](https://github.com/folio-org/raml-module-builder#postgresql-integration).

### Other tools
Expand Down

0 comments on commit 4065c38

Please sign in to comment.