Skip to content

Commit

Permalink
Merge pull request #3647 from matyasselmeci/pr/fix-readme-syntax
Browse files Browse the repository at this point in the history
Fix 'syntax errors' in README.md code samples (i.e. put ellipses in comments)
  • Loading branch information
matyasselmeci authored Feb 14, 2024
2 parents 87decc3 + cd80200 commit 357468f
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions src/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -226,7 +226,7 @@ DataFederation:
Namespaces:
- <NAMESPACE 1>
- <NAMESPACE 2>
...
# ...
- <NAMESPACE n>
```
Expand All @@ -250,7 +250,7 @@ Alternatively:
```yaml
Authorizations:
- <DN/FQAN/SCITOKENS AUTH 1>
...
# ...
- <DN/FQAN/SCITOKENS AUTH n>
```
These denote an authenticated namespace, which requires authentication for read access.
Expand Down Expand Up @@ -302,7 +302,7 @@ There are three kinds of authorization types:
```yaml
AllowedOrigins:
- ORIGIN_RESOURCE1
...
# ...
- ORIGIN_RESOURCEn
```
AllowedOrigins is a list of resource names of origins that will serve data for this namespace.
Expand All @@ -316,7 +316,7 @@ or
```yaml
AllowedCaches:
- CACHE_RESOURCE1
...
# ...
- CACHE_RESOURCEn
```
AllowedCaches is a list of resource names of caches that will serve data for this namespace.
Expand Down Expand Up @@ -389,14 +389,14 @@ For example:
```yaml
Resources:
Stashcache-Chicago:
...
# ...
Services:
XRootD cache server:
Description: Internet2 Chicago Cache
Details:
endpoint_override: osg-chicago-stashcache.nrp.internet2.edu:8443
auth_endpoint_override: osg-chicago-stashcache.nrp.internet2.edu:8444
...
# ...
```

### Supporting a Namespace
Expand Down Expand Up @@ -577,7 +577,7 @@ The final result looks like
},
{
"caches": [
(a whole bunch)
// (a whole bunch)
],
"credential_generation": {
"issuer": "https://osg-htc.org/ospool",
Expand Down

0 comments on commit 357468f

Please sign in to comment.