forked from lance-format/lance
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathclean-full-website.sh
More file actions
executable file
·179 lines (136 loc) · 5.95 KB
/
clean-full-website.sh
File metadata and controls
executable file
·179 lines (136 loc) · 5.95 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
#!/usr/bin/env bash
set -euo pipefail
script_dir=$(cd -- "$(dirname -- "${BASH_SOURCE[0]}")" && pwd)
repo_root=$(cd -- "$script_dir/.." && pwd)
docs_src="$script_dir/src"
rm -rf "$docs_src/format/catalog"
rm -rf "$docs_src/format/namespace"
rm -f "$docs_src/format/layout.png"
rm -f "$docs_src/format/overview.png"
rm -f "$docs_src/format/java-sdk-example.png"
rm -rf "$docs_src/integrations/huggingface"
rm -rf "$docs_src/integrations/duckdb"
rm -rf "$docs_src/integrations/spark"
rm -rf "$docs_src/integrations/ray"
rm -rf "$docs_src/integrations/trino"
rm -f "$docs_src/community/project-specific/.pages"
rm -rf "$docs_src/community/project-specific/lance"
rm -f "$docs_src/community/project-specific/namespace.md"
rm -f "$docs_src/community/project-specific/namespace-impls.md"
rm -f "$docs_src/community/project-specific/ray.md"
rm -f "$docs_src/community/project-specific/spark.md"
rm -f "$docs_src/community/project-specific/trino.md"
cat > "$docs_src/format/.pages" <<'EOF'
nav:
- Overview: index.md
- File Format: file
- Table Format: table
- Index Formats: index
- Catalog Specs: catalog
- Namespace Client Spec: namespace
EOF
cat > "$docs_src/integrations/.pages" <<'EOF'
nav:
- Overview: index.md
- Apache DataFusion: datafusion.md
- PostgreSQL: https://github.com/lancedb/pglance
- PyTorch: pytorch.md
- Tensorflow: tensorflow.md
EOF
mkdir -p "$docs_src/format/catalog/dir"
mkdir -p "$docs_src/format/catalog/rest"
mkdir -p "$docs_src/format/namespace/operations/models"
mkdir -p "$docs_src/format/namespace/supported-catalogs"
cat > "$docs_src/format/catalog/.pages" <<'EOF'
title: Catalog Specs
nav:
- Overview: index.md
- Directory Catalog: dir
- REST Catalog: rest
EOF
cat > "$docs_src/format/catalog/index.md" <<'EOF'
# Catalog Specs
This section describes how Lance catalogs organize, discover, and coordinate Lance tables.
When a local `lance-namespace` checkout with split catalog docs is available, `docs/make-full-website.sh` replaces these placeholders with the latest source content.
See also:
- [Directory Catalog](dir/index.md)
- [REST Catalog](rest/index.md)
- [Namespace Client Spec](../namespace/index.md)
EOF
cat > "$docs_src/format/catalog/dir/index.md" <<'EOF'
# Directory Catalog
The Directory Catalog is the storage-native catalog format for Lance.
This placeholder page keeps the local website buildable when external catalog docs are not available.
Run `docs/make-full-website.sh` with `LANCE_NAMESPACE_REPO` pointing at a split `lance-namespace` checkout to populate the full specification.
EOF
cat > "$docs_src/format/catalog/rest/index.md" <<'EOF'
# REST Catalog
The REST Catalog is the service-oriented catalog specification for Lance.
This placeholder page keeps the local website buildable when external catalog docs are not available.
Run `docs/make-full-website.sh` with `LANCE_NAMESPACE_REPO` pointing at a split `lance-namespace` checkout to populate the full specification.
EOF
cat > "$docs_src/format/namespace/.pages" <<'EOF'
title: Namespace Client Spec
nav:
- Overview: index.md
- Objects & Relationships: object-relationship.md
- Operations: operations
- Supported Catalogs: supported-catalogs
EOF
cat > "$docs_src/format/namespace/index.md" <<'EOF'
# Namespace Client Spec
The Lance Namespace Client Spec defines the interface that engines and tools use to discover tables, resolve locations, and coordinate table operations through catalogs.
When a local `lance-namespace` checkout with split namespace docs is available, `docs/make-full-website.sh` replaces these placeholders with the latest source content.
See also:
- [Objects & Relationships](object-relationship.md)
- [Operations](operations/index.md)
- [Supported Catalogs](supported-catalogs/index.md)
EOF
cat > "$docs_src/format/namespace/object-relationship.md" <<'EOF'
# Objects & Relationships
This placeholder page keeps the local website buildable when external namespace docs are not available.
Run `docs/make-full-website.sh` with `LANCE_NAMESPACE_REPO` pointing at a split `lance-namespace` checkout to populate the full object model description.
EOF
cat > "$docs_src/format/namespace/operations/.pages" <<'EOF'
title: Operations
nav:
- Overview: index.md
- Models: models
EOF
cat > "$docs_src/format/namespace/operations/index.md" <<'EOF'
# Operations
This placeholder page keeps the local website buildable when external namespace docs are not available.
Run `docs/make-full-website.sh` with `LANCE_NAMESPACE_REPO` pointing at a split `lance-namespace` checkout to populate the operation reference.
EOF
cat > "$docs_src/format/namespace/operations/models/.pages" <<'EOF'
title: Models
EOF
cat > "$docs_src/format/namespace/operations/models/index.md" <<'EOF'
# Operation Models
This placeholder page keeps the local website buildable when external namespace docs are not available.
EOF
cat > "$docs_src/format/namespace/supported-catalogs/.pages" <<'EOF'
title: Supported Catalogs
nav:
- Overview: index.md
- Lance Directory Catalog: lance-dir.md
- Lance REST Catalog: lance-rest.md
- Template: template.md
EOF
cat > "$docs_src/format/namespace/supported-catalogs/index.md" <<'EOF'
# Supported Catalogs
This placeholder page keeps the local website buildable when external namespace docs are not available.
Run `docs/make-full-website.sh` with `LANCE_NAMESPACE_REPO` and `LANCE_NAMESPACE_IMPLS_REPO` set to local checkouts to populate the full integration catalog list.
EOF
cat > "$docs_src/format/namespace/supported-catalogs/lance-dir.md" <<'EOF'
# Lance Directory Catalog
This placeholder page keeps the local website buildable when external namespace docs are not available.
EOF
cat > "$docs_src/format/namespace/supported-catalogs/lance-rest.md" <<'EOF'
# Lance REST Catalog
This placeholder page keeps the local website buildable when external namespace docs are not available.
EOF
cat > "$docs_src/format/namespace/supported-catalogs/template.md" <<'EOF'
# Template
This placeholder page keeps the local website buildable when external namespace docs are not available.
EOF