This is an automated email from the ASF dual-hosted git repository.
jbonofre pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/polaris.git
The following commit(s) were added to refs/heads/main by this push:
new c7150090 Site: fix links in `entities.md` (#338)
c7150090 is described below
commit c71500904a610dc0345d8dcf1403e220e0769a03
Author: Robert Stupp <[email protected]>
AuthorDate: Wed Oct 2 13:11:48 2024 +0200
Site: fix links in `entities.md` (#338)
---
site/content/in-dev/unreleased/entities.md | 22 +++++++++++-----------
site/layouts/shortcodes/github-polaris.html | 27 +++++++++++++++++++++++++++
2 files changed, 38 insertions(+), 11 deletions(-)
diff --git a/site/content/in-dev/unreleased/entities.md
b/site/content/in-dev/unreleased/entities.md
index 4439493b..0e02c6a8 100644
--- a/site/content/in-dev/unreleased/entities.md
+++ b/site/content/in-dev/unreleased/entities.md
@@ -28,13 +28,13 @@ This page documents various entities that can be managed in
Apache Polaris (Incu
A catalog is a top-level entity in Polaris that may contain other entities
like [namespaces](#namespace) and [tables](#table). These map directly to
[Apache Iceberg catalogs](https://iceberg.apache.org/concepts/catalog/).
-For information on managing catalogs with the REST API or for more information
on what data can be associated with a catalog, see [the API
docs](../regtests/client/python/docs/CreateCatalogRequest.md).
+For information on managing catalogs with the REST API or for more information
on what data can be associated with a catalog, see [the API docs]({{%
github-polaris "regtests/client/python/docs/CreateCatalogRequest.md" %}}).
### Storage Type
All catalogs in Polaris are associated with a _storage type_. Valid Storage
Types are `S3`, `Azure`, and `GCS`. The `FILE` type is also additionally
available for testing. Each of these types relates to a different storage
provider where data within the catalog may reside. Depending on the storage
type, various other configurations may be set for a catalog including
credentials to be used when accessing data inside the catalog.
-For details on how to use Storage Types in the REST API, see [the API
docs](../regtests/client/python/docs/StorageConfigInfo.md).
+For details on how to use Storage Types in the REST API, see [the API
docs]({{% github-polaris "regtests/client/python/docs/StorageConfigInfo.md"
%}}).
## Namespace
@@ -42,32 +42,32 @@ A namespace is a logical entity that resides within a
[catalog](#catalog) and ca
In Polaris, namespaces can be nested. For example, `a.b.c.d.e.f.g` is a valid
namespace. `b` is said to reside within `a`, and so on.
-For information on managing namespaces with the REST API or for more
information on what data can be associated with a namespace, see [the API
docs](../regtests/client/python/docs/CreateNamespaceRequest.md).
+For information on managing namespaces with the REST API or for more
information on what data can be associated with a namespace, see [the API
docs]({{% github-polaris
"regtests/client/python/docs/CreateNamespaceRequest.md" %}}).
## Table
Polaris tables are entities that map to [Apache Iceberg
tables](https://iceberg.apache.org/docs/nightly/configuration/).
-For information on managing tables with the REST API or for more information
on what data can be associated with a table, see [the API
docs](../regtests/client/python/docs/CreateTableRequest.md).
+For information on managing tables with the REST API or for more information
on what data can be associated with a table, see [the API docs]({{%
github-polaris "regtests/client/python/docs/CreateTableRequest.md" %}}).
## View
Polaris views are entities that map to [Apache Iceberg
views](https://iceberg.apache.org/view-spec/).
-For information on managing views with the REST API or for more information on
what data can be associated with a view, see [the API
docs](../regtests/client/python/docs/CreateViewRequest.md).
+For information on managing views with the REST API or for more information on
what data can be associated with a view, see [the API docs]({{% github-polaris
"regtests/client/python/docs/CreateViewRequest.md" %}}).
## Principal
Polaris principals are unique identities that can be used to represent users
or services. Each principal may have one or more [principal
roles](#principal-role) assigned to it for the purpose of accessing catalogs
and the entities within them.
-For information on managing principals with the REST API or for more
information on what data can be associated with a principal, see [the API
docs](../regtests/client/python/docs/CreatePrincipalRequest.md).
+For information on managing principals with the REST API or for more
information on what data can be associated with a principal, see [the API
docs]({{% github-polaris
"regtests/client/python/docs/CreatePrincipalRequest.md" %}}).
## Principal Role
Polaris principal roles are labels that may be granted to
[principals](#principal). Each principal may have one or more principal roles,
and the same principal role may be granted to multiple principals. Principal
roles may be assigned based on the persona or responsibilities of a given
principal, or on how that principal will need to access different entities
within Polaris.
-For information on managing principal roles with the REST API or for more
information on what data can be associated with a principal role, see [the API
docs](../regtests/client/python/docs/CreatePrincipalRoleRequest.md).
+For information on managing principal roles with the REST API or for more
information on what data can be associated with a principal role, see [the API
docs]({{% github-polaris
"regtests/client/python/docs/CreatePrincipalRoleRequest.md" %}}).
## Catalog Role
@@ -83,7 +83,7 @@ Polaris privileges are granted to [catalog
roles](#catalog-role) in order to gra
A privilege can be scoped to any entity inside a catalog, including the
catalog itself.
For a list of supported privileges for each privilege class, see the API docs:
-* [Table Privileges](../regtests/client/python/docs/TablePrivilege.md)
-* [View Privileges](../regtests/client/python/docs/ViewPrivilege.md)
-* [Namespace Privileges](../regtests/client/python/docs/NamespacePrivilege.md)
-* [Catalog Privileges](../regtests/client/python/docs/CatalogPrivilege.md)
+* [Table Privileges]({{% github-polaris
"regtests/client/python/docs/TablePrivilege.md" %}})
+* [View Privileges]({{% github-polaris
"regtests/client/python/docs/ViewPrivilege.md" %}})
+* [Namespace Privileges]({{% github-polaris
"regtests/client/python/docs/NamespacePrivilege.md" %}})
+* [Catalog Privileges]({{% github-polaris
"regtests/client/python/docs/CatalogPrivilege.md" %}})
diff --git a/site/layouts/shortcodes/github-polaris.html
b/site/layouts/shortcodes/github-polaris.html
new file mode 100644
index 00000000..a155e59d
--- /dev/null
+++ b/site/layouts/shortcodes/github-polaris.html
@@ -0,0 +1,27 @@
+{{/*
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+*/}}
+
+{{- $ver := partial "releaseVersion.html" . -}}
+{{- $path := ( .Get 0 ) -}}
+{{- $url := "" -}}
+{{- if eq $ver "[unreleased]" -}}
+{{- printf "https://github.com/apache/polaris/blob/main/%s"; $path }}
+{{- else -}}
+{{- printf "https://github.com/apache/polaris/blob/polaris-%s/%s"; $path }}
+{{- end -}}
