Skip to content

Commit 53a46ca

Browse files
authored
Update README.md
added NASA README file code under the existing naming auth info
1 parent f6babb8 commit 53a46ca

1 file changed

Lines changed: 75 additions & 0 deletions

File tree

README.md

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,78 @@ and add .github/workflows scripts to automate alerts on push updates.
77
When creating a new Naming Authority repository, select
88
hpde/naming-auth-template
99
from the "Repository template" dropdown at the top of the new repository panel.
10+
11+
[![SPASE Monthly Validation](https://github.com/hpde/NASA/actions/workflows/validate-schedule.yml/badge.svg)](https://github.com/hpde/NASA/actions/workflows/validate-schedule.yml)
12+
[![SPASE Push Validation](https://github.com/hpde/NASA/actions/workflows/validate-push.yml/badge.svg)](https://github.com/hpde/NASA/actions/workflows/validate-push.yml)
13+
14+
# GMU
15+
16+
George Mason University (GMU).
17+
18+
SPASE resource descriptions with the GMU naming authority.
19+
20+
# How to Use This Repository
21+
22+
If you are a consumer of the metadata simply clone the repostory
23+
24+
````
25+
git clone -b master --single-branch --depth=1 https://github.com/hpde/GMU
26+
````
27+
28+
If you are a contributor (someone authorized to make changes directly to the repository), clone the repository with:
29+
30+
````
31+
git clone git@github.com:hpde/GMU.git
32+
````
33+
34+
and use your favorite XML editor and tools to make the changes your want.
35+
36+
After making changes run validation and referential checks on the changed files.
37+
You can use the [SPASE Resource Tools](https://spase-group.org/tools/resource/) to do this task.
38+
Then push updates (git commit, git push) to the repository.
39+
40+
# How to suggest or make changes
41+
42+
Anyone can suggested changes or updates to a description by loading the description
43+
in the editor, make the changes then click "Submit to Metadata Working Group" at the last step.
44+
You can jump to the last step by clicking "Export" on the list of steps on the left.
45+
46+
The easiest way to load a description into the SPASE Metadata Editor is to find the
47+
landing page for a resource description by replacing the "spase://" in the
48+
SPASE Resource ID with "https://spase-metadata.org/". For example, change
49+
50+
spase://ESA/NumericalData/PROBA2/LYRA/Flarelist/PT24H
51+
52+
to
53+
https://spase-metadata.org/ESA/NumericalData/PROBA2/LYRA/Flarelist/PT24H
54+
55+
Navigate to that URL with a browser, the click "Edit" to load the description into the SPASE Metadata editor.
56+
57+
# Validation Actions
58+
59+
GitHub actions are configured for this repository. When a "git push" occurs
60+
a validation and referential check is performed on the changes or additions
61+
to the repository since the last push. The status of the action is displayed in the
62+
"SPASE Push Validation" badge at the top of the page. You can view the log of the
63+
validation by viewing the [action workflows](../../actions), clicking on the appropriate workflow
64+
run, then "validate-log" artifict.
65+
66+
The "SPASE Push Validation" is designed to incrementally validate the repository. It assumes
67+
that the repository is valid before the "git push". To perform a whole repository validation
68+
run the "SPASE Manual Validation" action. To manually run an action go to the [actions](../../actions) page,
69+
select the "SPASE Manual Validation" action, then click on "Run Workflow". For large repositories it
70+
can take many minutes for the workflow to complete - be patient. Once it is complete the "SPASE Manual Validation"
71+
badge will update.
72+
73+
**Note on badge refresh**: The status portion of a badge is an image. Typically browsers cache images so an
74+
updated status may not appear immediately. One way to view the current badge is to clear cached images back to when you
75+
last loaded the page, then refresh the page.
76+
77+
**Notes for repository administrator**: There is no garbage collection for workflows. So, its a good practice to
78+
occassionally visit the [action workflows](../../actions) and remove old workflow runs. To remove a run click
79+
the elipses (...) for a work flow and select "Delete workflow run". Typically you would only need the most recent run.
80+
81+
82+
83+
84+

0 commit comments

Comments
 (0)