From ffe5657084e67728a78a231040ac8b59736473cb Mon Sep 17 00:00:00 2001 From: Michael Hucka Date: Sun, 19 Nov 2023 18:17:22 -0800 Subject: [PATCH] docs: add alt text to images --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 00fba75..d4defae 100644 --- a/README.md +++ b/README.md @@ -29,9 +29,9 @@ IGA is the _InvenioRDM GitHub Archiver_, a standalone program as well as a [GitH IGA creates metadata records and sends releases from GitHub to an InvenioRDM-based repository server. IGA can be invoked from the command line; it also can be set up as a [GitHub Actions](https://docs.github.com/en/actions) workflow to archive GitHub releases automatically for a repository each time they are made.

- +Screenshot of a software release in GitHub ➜ - +Screenshot of the corresponding entry in InvenioRDM

IGA offers many notable features: @@ -214,7 +214,7 @@ No matter whether IGA is run locally on your computer or as a GitHub Actions wor ### Getting an InvenioRDM token - +Screenshot of InvenioRDM PAT menu 1. Log in to your InvenioRDM account 2. Go to the _Applications_ page in your account profile @@ -252,9 +252,9 @@ More options are described in the section on [detailed usage information](#usage After doing the [GitHub Actions installation](#configuring-and-running-iga-as-a-github-actions-workflow) steps and [obtaining an InvenioRDM token](#getting-an-inveniordm-token), one more step is needed: the token must be stored as a "secret" in your GitHub repository. -1. Go to the _Settings_ page of your GitHub repository

-2. In the left-hand sidebar, find _Secrets and variables_ in the Security section, click on it to reveal _Actions_ underneath, then click on _Actions_

-3. In the next page, click the green New repository secret button

+1. Go to the _Settings_ page of your GitHub repository

Screenshot of repository tabs in GitHub

+2. In the left-hand sidebar, find _Secrets and variables_ in the Security section, click on it to reveal _Actions_ underneath, then click on _Actions_

Screenshot of GitHub secrets sidebar item

+3. In the next page, click the green New repository secret button

Screenshot of GitHub secrets interface

4. Name the variable `INVENIO_TOKEN` and paste in your InvenioRDM token 5. Finish by clicking the green Add secret button @@ -262,11 +262,11 @@ After doing the [GitHub Actions installation](#configuring-and-running-iga-as-a- After setting up the workflow and storing the InvenioRDM token in your repository on GitHub, it's a good idea to run the workflow manually to test that it works as expected. -1. Go to the _Actions_ tab in your repository and click on the name of the workflow in the sidebar on the left

+1. Go to the _Actions_ tab in your repository and click on the name of the workflow in the sidebar on the left

Screenshot of GitHub actions workflow list

2. Click the Run workflow button in the right-hand side of the blue strip -3. In the pull-down, change the value of "Mark the record as a draft" to `true`

+3. In the pull-down, change the value of "Mark the record as a draft" to `true`

Screenshot of GitHub Actions workflow menu

4. Click the green Run workflow button near the bottom -5. Refresh the web page and a new line will be shown named after your workflow file

+5. Refresh the web page and a new line will be shown named after your workflow file

Screenshot of a running workflow in GitHub Actions

6. Click the title of the workflow to see the IGA workflow progress and results @@ -514,6 +514,6 @@ IGA uses multiple other open-source packages, without which it would have taken

- + Caltech logo