Skip to content

Commit e593ff0

Browse files
committed
Small touchups
1 parent 0c617c5 commit e593ff0

File tree

2 files changed

+12
-5
lines changed

2 files changed

+12
-5
lines changed

docs/building-blocks/link-catalog.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ The Link Catalog contains:
3232
* Metadata about each Link Index:
3333
* Last updated timestamp
3434
* Commit SHA that produced the Link Index
35+
* ETAG of the Link Index file
3536
* URL to the Link Index file
3637

3738
## Maintenance
@@ -52,17 +53,16 @@ This process ensures the catalog stays in sync with published Link Index files w
5253
When running `docs-builder assembler clone` or `docs-builder assembler build`:
5354

5455
1. The assembler fetches the Link Catalog
55-
2. It determines which repositories and versions to clone/build based on the site configuration
56+
2. It determines which repositories and versions to clone/build based on the [site configuration](../configure/site/index.md)
5657
3. It uses the commit SHAs from the catalog to clone specific versions
57-
4. It falls back to the last known good commit if a repository's current state has build failures
5858

5959
### By documentation builds
6060

6161
During a documentation build:
6262

6363
1. `docs-builder` fetches the Link Catalog
6464
2. It determines which Link Index files to download for cross-repository validation
65-
3. It validates all crosslinks against the appropriate Link Index files
65+
3. It validates all cross-links against the appropriate Link Index files
6666

6767
## Benefits
6868

docs/building-blocks/link-service.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,20 @@ navigation_title: Link Service
44

55
# Link Service
66

7-
The **Link Service** is the central location where all [Link Index](link-index.md) files are published and stored.
7+
The **Link Service** is the central location that stores:
8+
9+
* All [Link Index](link-index.md) files for all the repositories and branches that are published.
10+
* The [Link Catalog](link-catalog.md), a single JSON file that contains references to all the `Link Index` files.
11+
12+
We only have one link service today for all public documentation.
13+
14+
* https://elastic-docs-link-index.s3.us-east-2.amazonaws.com/
815

916
## Architecture
1017

1118
The Link Service is implemented as:
1219

13-
* **Storage** - An S3 bucket containing all Link Index files
20+
* **Storage** - An S3 bucket
1421
* **CDN** - CloudFront fronting the S3 bucket for fast global access
1522
* **Access** - Publicly accessible for read operations
1623

0 commit comments

Comments
 (0)