Skip to content

Commit

Permalink
Fixing random typos in various documentation pages. (PelicanPlatform#…
Browse files Browse the repository at this point in the history
…1181)

* Fix typo in alpine.mdx

* Fix typo in debian.mdx

* Fix typo in macos.mdx

* Fix typo in client-usage.mdx

* Fix typo in serving_a_federation.mdx

* Fix typo in grafana.mdx
  • Loading branch information
aowen-uwmad authored Apr 26, 2024
1 parent 2335dcf commit f499b68
Show file tree
Hide file tree
Showing 6 changed files with 8 additions and 8 deletions.
4 changes: 2 additions & 2 deletions docs/pages/client-usage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The Pelican client currently only supports *fetching* objects from Pelican federations, although a much richer feature set that will allow users to interact with federation objects in more advanced ways is forthcoming.

One thing to note is that Pelican should be thought of as a tool that works with federated *objects* as opposed to *files*. The reason for this is that calling something a file carries with it the connotation that the file is mutable, ie its contents can change without requiring a new name. Objects in a Pelican federation, however, should be treated as immutable, especially in any case where objects are pulled through a cache (which will be the case for almost all files in the OSDF). This is because the underlying cache mechanism, powered by XRootD, will deliver whatever object it already has access to; if an object name changes at the origin, the cache will remain unaware and continue to deliver the old object. In the worst case, when the cache only has a partial object, it may attempt to combine its stale version with whatever exists at the origin. Use object names wisely!
One thing to note is that Pelican should be thought of as a tool that works with federated *objects* as opposed to *files*. The reason for this is that calling something a file carries with it the connotation that the file is mutable, i.e., its contents can change without requiring a new name. Objects in a Pelican federation, however, should be treated as immutable, especially in any case where objects are pulled through a cache (which will be the case for almost all files in the OSDF). This is because the underlying cache mechanism, powered by XRootD, will deliver whatever object it already has access to; if an object name changes at the origin, the cache will remain unaware and continue to deliver the old object. In the worst case, when the cache only has a partial object, it may attempt to combine its stale version with whatever exists at the origin. Use object names wisely!

## Before Starting

Expand Down Expand Up @@ -32,7 +32,7 @@ Objects in Pelican belong to *federations*, which are aggregations of data that
**Note:** All object paths in a federation begin with a preceding `/`, and no relative paths are allowed.

**Origins:**
All objects in a federation live in some *origin*. Origins act like a flexible plug mechanism that exposes different type of storage backends to the federation. For example, the POSIX filesystem on most Linux computers is one type of storage backend an origin can expose to the federation. Other types of backends include S3 or HTTP servers, and Pelican plans to add many more. In most cases, a user does not need to know the particular backend used to store the object to download it from the federation.
All objects in a federation live in some *origin*. Origins act like a flexible plugin mechanism that exposes different type of storage backends to the federation. For example, the POSIX filesystem on most Linux computers is one type of storage backend an origin can expose to the federation. Other types of backends include S3 or HTTP servers, and Pelican plans to add many more. In most cases, a user does not need to know the particular backend used to store the object to download it from the federation.

**Namespace Prefixes:**
Each origin supports one or more *namespace prefixes*, which are analogous to the folders or directories from your computer that you use to organize files. In the example object from the OSDF mentioned earlier, the namespace prefix is `/osgconnect/public/`, and the actual object is named `osg/testfile.txt`.
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/grafana.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ PELICAN_MONITORING_PROMQLAUTHORIZATION=false pelican origin serve

Once you configured the authentication either in Grafana or in Pelican, click **Save & Test** to see if the connection can be established.

# Build Monitroing Dashbord
# Build Monitoring Dashboard

With Grafana connected to the Pelican Prometheus instance, you are able to build visualization with the metrics Pelican collects. This section describes how to get started with a template dashboard configuration for a _Pelican origin server_. For a detailed guide on how to create a Grafana dashboard, refer to the [Grafana documentation](https://grafana.com/docs/grafana/latest/dashboards/build-dashboards/create-dashboard/).

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/install/alpine.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ You can install Pelican by downloading an `.apk` package or by downloading a bin

1. Navigate to [Pelican download page](../install.mdx) and select the Pelican APK you want to install.

2. In **Operating System** section, select **Linux**. In **Architechtures** section, select **AMD64** (Intel/AMD) or **ARM64** (ARM) depending on the architecture of your machine.
2. In **Operating System** section, select **Linux**. In **Architectures** section, select **AMD64** (Intel/AMD) or **ARM64** (ARM) depending on the architecture of your machine.

3. In the list of download candidates, copy the link to `pelican_x.x.x_p1_aarch64.apk` if you select **AARCH64** (ARM), or `pelican_x.x.x_p1_x86_64.apk` if you select **X84_64** (Intel/AMD). Where `x.x.x` is the version number.

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/install/debian.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ You can install Pelican by downloading a `.deb` package or by downloading a bina

1. Navigate to [Pelican download page](../install.mdx) and select the Pelican DEB you want to install.

2. In **Operating System** section, select **Linux**. In **Architechtures** section, select **AMD64** (Intel/AMD) or **ARM64** (ARM) depending on the architecture of your machine.
2. In **Operating System** section, select **Linux**. In **Architectures** section, select **AMD64** (Intel/AMD) or **ARM64** (ARM) depending on the architecture of your machine.

3. In the list of download candidates, copy the link to `pelican-x.x.x-1_arm64.deb` if you select **ARM64** (ARM), or `pelican-x.x.x-1.amd64.deb` if you select **AMD64** (Intel/AMD). Where `x.x.x` is the version number.

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/install/macos.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This document explains how to install Pelican on macOS.

1. Navigate to [Pelican download page](../install.mdx) and select the Pelican macOS binary you want to install.

2. In **Operating System** section, select **macOS**. In **Architechtures** section, select **X84_64** (Intel) or **ARM64** (ARM) depending on the architecture of your machine.
2. In **Operating System** section, select **macOS**. In **Architectures** section, select **X84_64** (Intel) or **ARM64** (ARM) depending on the architecture of your machine.

3. In the list of candidates, copy the link to `pelican_Darwin_arm64.tar.gz` if you select **ARM64** (ARM), or `pelican_Darwin_x86_64.tar.gz` if you select **X84_64** (Intel).

Expand Down
4 changes: 2 additions & 2 deletions docs/pages/serving_a_federation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ A federation in Pelican refers to an instance of a data sharing ecosystem where
allow such an exchange of data to work, Pelican has two top-level *central server components* to coordinate origins and caches in the
federation, direct client requests to the proper storage server, and manage namespace registration. They are the *director* and the *registry*.
A Pelican federation requires both a *director* and a *registry* to be set up first before any origin or cache server can join
the federation or any client can access objects in the federaiton.
the federation or any client can access objects in the federation.

## Before Starting

Expand All @@ -30,7 +30,7 @@ For Pelican registry to work, you need to obtain a client id and associated clie

* **`Client Name`**: a human-readable name of your service. For example: Pelican Data Federation
* **`Callback URLs`**: fill in `https://<hostname>:<server_port>/api/v1.0/auth/oauth/callback` where `<hostname>:<server_port>` is your server's public endpoint. For example, `https://example-origin.org:8444/api/v1.0/auth/oauth/callback`
* **`Client Type`**: select `Confedential`
* **`Client Type`**: select `Confidential`
* **`Scopes`**: select `email`, `openid`, `org.cilogon.userinfo`, and `profile`
* **`Refresh Tokens`**: select `No`

Expand Down

0 comments on commit f499b68

Please sign in to comment.