Skip to content

Commit c660f56

Browse files
authored
Update README.md
Added the remaining code for the Read Me File on How to use this repository.
1 parent 7b119f4 commit c660f56

1 file changed

Lines changed: 32 additions & 7 deletions

File tree

README.md

Lines changed: 32 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,22 +7,43 @@ National Oceanic and Atmospheric Administration (NOAA)
77

88
Visit the [website](http://www.swpc.noaa.gov/) [http://www.swpc.noaa.gov/]
99

10+
1011
# How to Use This Repository
1112

12-
If you are a consumer of the metadata simple clone the repostory
13+
If you are a consumer of the metadata simply clone the repostory
1314

1415
````
15-
git clone -b master --single-branch --depth=1 https://github.com/hpde/NOAA
16+
git clone -b master --single-branch --depth=1 https://github.com/hpde/NASA
1617
````
1718

18-
If you are a contributor, clone the repository and use the "draft" branch.
19+
If you are a contributor (someone authorized to make changes directly to the repository), clone the repository with:
20+
1921
````
20-
git clone git@github.com:hpde/NOAA.git
21-
git checkout draft
22+
git clone git@github.com:hpde/NASA.git
2223
````
2324

24-
After pushing updates send a "pull request". After a review, the changes
25-
will be added to the master branch and shared with consumers.
25+
and use your favorite XML editor and tools to make the changes your want.
26+
27+
After making changes run validation and referential checks on the changed files.
28+
You can use the [SPASE Resource Tools](https://spase-group.org/tools/resource/) to do this task.
29+
Then push updates (git commit, git push) to the repository.
30+
31+
# How to suggest or make changes
32+
33+
Anyone can suggested changes or updates to a description by loading the description
34+
in the editor, make the changes then click "Submit to Metadata Working Group" at the last step.
35+
You can jump to the last step by clicking "Export" on the list of steps on the left.
36+
37+
The easiest way to load a description into the SPASE Metadata Editor is to find the
38+
landing page for a resource description by replacing the "spase://" in the
39+
SPASE Resource ID with "https://spase-metadata.org/". For example, change
40+
41+
spase://ESA/NumericalData/PROBA2/LYRA/Flarelist/PT24H
42+
43+
to
44+
https://spase-metadata.org/ESA/NumericalData/PROBA2/LYRA/Flarelist/PT24H
45+
46+
Navigate to that URL with a browser, the click "Edit" to load the description into the SPASE Metadata editor.
2647

2748
# Validation Actions
2849

@@ -47,3 +68,7 @@ last loaded the page, then refresh the page.
4768
**Notes for repository administrator**: There is no garbage collection for workflows. So, its a good practice to
4869
occassionally visit the [action workflows](../../actions) and remove old workflow runs. To remove a run click
4970
the elipses (...) for a work flow and select "Delete workflow run". Typically you would only need the most recent run.
71+
72+
73+
74+

0 commit comments

Comments
 (0)