Skip to content

Commit

Permalink
Merge pull request #1762 from folio-org/FOLIO-873-improve-docs-288
Browse files Browse the repository at this point in the history
FOLIO-873 improve docs
  • Loading branch information
dcrossleyau authored Oct 15, 2024
2 parents bd20ff8 + e9192d4 commit a84b057
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 12 deletions.
12 changes: 6 additions & 6 deletions _data/repos.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"metadata": {
"generatedDateTime": "2024-10-11T03:21:54.736547+00:00"
"generatedDateTime": "2024-10-15T00:10:30.228545+00:00"
},
"repos": [
{
Expand Down Expand Up @@ -3859,7 +3859,7 @@
"ui.yml"
],
"workflowsFolio": [
"ui.yml@v1.1"
"ui.yml@v1.5"
]
},
{
Expand Down Expand Up @@ -3979,7 +3979,7 @@
"ui.yml"
],
"workflowsFolio": [
"ui.yml@v1.1"
"ui.yml@v1.5"
]
},
{
Expand Down Expand Up @@ -4069,7 +4069,7 @@
"ui.yml"
],
"workflowsFolio": [
"ui.yml@v1.1"
"ui.yml@v1.5"
]
},
{
Expand All @@ -4086,7 +4086,7 @@
"ui.yml"
],
"workflowsFolio": [
"ui.yml@v1.1"
"ui.yml@v1.5"
]
},
{
Expand Down Expand Up @@ -4260,7 +4260,7 @@
"ui.yml"
],
"workflowsFolio": [
"ui.yml@v1.1"
"ui.yml@v1.5"
]
},
{
Expand Down
24 changes: 18 additions & 6 deletions guides/devops-introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,29 +53,31 @@ The main Slack channels:
## Infrastructure

Refer to the overview of the [Build, test, and deployment infrastructure](/guides/automation/) and notes about Jenkins, Docker, Nexus, etc.
.

See [explanation](https://folio-org.atlassian.net/browse/FOLIO-3171?focusedCommentId=197577) of precedence of environment variables and handling via Okapi (DeploymentDescriptor, system-level, LaunchDescriptor) and support for that in folio-ansible roles.

## Reference environments

Explanations of each of the regularly-built [reference environments](/guides/automation/#reference-environments) including the build times and links to the relevant Jenkins jobs.

We monitor those builds, triage problems, and try to direct issues back to developers.
Refer to the [explanations](/guidelines/release-procedures/#add-to-platforms) about how these environments are constructed, the key branches, and the key files.
(The Kitfox DevOps Team handles the platform-complete master branch and release branches.)

We try to limit out-of-band requests to manually rebuild these.
Many other people utilise these systems.
We monitor those "Reference environment" builds, triage problems, and try to direct issues back to developers.

We try to [limit](/guides/automation/#off-schedule-rebuilds) out-of-band requests to manually rebuild these.
Many other people utilise these systems, so try to limit disruption.
See Slack #hosted-reference-envs channel.
People need to ask there and allow time for others to be aware.

To determine the cause of failed builds, search the [Jenkins output logfile](/faqs/how-to-investigate-jenkins-logs/).
Remember that the cause might be in the earlier build of "Pipeline build-platform-complete-snapshot" etc.
Remember that the cause might be in the earlier [Platform hourly build](/guides/automation/#platform-hourly-build) of "Pipeline build-platform-complete-snapshot" etc.

Encourage developers to utilise the [facility](/faqs/how-to-obtain-refenv-logs/) to obtain reference environment module logs, rather than asking us to do it for them.

## Developer scratch environments

Refer to the overview of [How to get started with Rancher environment](/faqs/how-to-get-started-with-rancher/) and Helm.
Refer to the Kitfox DevOps Team overview of [How to get started with Rancher environment](/faqs/how-to-get-started-with-rancher/) and Helm.

## GitHub and Jenkins access

Expand Down Expand Up @@ -110,6 +112,11 @@ The "Add" button is way to the right-hand side.

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

<div class="attention">
Note: FOLIO DevOps can no longer do the below-mentioned tasks. <br/>
Refer them to the Slack channel #folio-atlassian-support
</div>

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.
Expand All @@ -118,6 +125,11 @@ Add the Group "external-core-collaborators".

## Jira add new project

<div class="attention">
Note: FOLIO DevOps can no longer do the below-mentioned tasks. <br/>
Refer them to the Slack channel #folio-atlassian-support
</div>

Project managers will sometimes ask us to add a new Jira Project.
They should provide the name and key.

Expand Down

0 comments on commit a84b057

Please sign in to comment.