Skip to content

Commit 56ee703

Browse files
jjasgharjjasghar
committed
Fixing links per #39
I think this fixes a ton of: jjasghar/link-verifier-llm-d.ai#6 Signed-off-by: JJ Asghar <[email protected]>
1 parent 45b6cab commit 56ee703

File tree

3 files changed

+26
-11
lines changed

3 files changed

+26
-11
lines changed

‎remote-content/remote-sources/guide-inference-scheduling.js‎

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/**
22
* Guide Inference Scheduling Remote Content
3-
*
3+
*
44
* Downloads the inference scheduling README.md file from the llm-d-infra repository
55
* and transforms it into docs/guide/Installation/inference-scheduling.md
66
*/
@@ -15,11 +15,11 @@ export default [
1515
sourceBaseUrl: 'https://raw.githubusercontent.com/llm-d-incubation/llm-d-infra/main/',
1616
outDir: 'docs/guide/Installation',
1717
documents: ['quickstart/examples/inference-scheduling/README.md'],
18-
18+
1919
// Plugin behavior
2020
noRuntimeDownloads: false, // Download automatically when building
2121
performCleanup: true, // Clean up files after build
22-
22+
2323
// Transform the content for this specific document
2424
modifyContent(filename, content) {
2525
if (filename === 'quickstart/examples/inference-scheduling/README.md') {
@@ -42,17 +42,23 @@ export default [
4242
.replace(/<(http[s]?:\/\/[^>]+)>/g, '`$1`')
4343
// Fix specific broken links to point to repository
4444
.replace(/\[gke\.md\]\(gke\.md\)/g, '[gke.md](https://github.com/llm-d-incubation/llm-d-infra/blob/main/quickstart/examples/inference-scheduling/gke.md)')
45-
.replace(/\[Temporary Istio Workaround\]\(\.\.\/\.\.\/\.\.\/istio-workaround\.md\)/g, '[Temporary Istio Workaround](https://github.com/llm-d-incubation/llm-d-infra/blob/main/quickstart/istio-workaround.md)')
45+
.replace(/\[Temporary\ Istio \Workaround\]\(\.\.\/\.\.\/\.\.\/istio-workaround\.md\)/g, '[Temporary Istio Workaround](https://github.com/llm-d-incubation/llm-d-infra/blob/main/quickstart/istio-workaround.md)')
4646
// Fix broken external references
4747
.replace(/\]\(\.\.\/\.\.\/precise-prefix-cache-aware\)/g, '](https://github.com/llm-d-incubation/llm-d-infra/tree/main/quickstart/examples/precise-prefix-cache-aware)')
4848
// Fix file references to point to repository
4949
.replace(/\]\(([^)]+\.(yaml|sh))\)/g, '](https://github.com/llm-d-incubation/llm-d-infra/blob/main/quickstart/examples/inference-scheduling/$1)')
5050
.replace(/\]\(\.\.\/\.\.\/\.\.\/([^)]+\.sh)\)/g, '](https://github.com/llm-d-incubation/llm-d-infra/blob/main/quickstart/$1)')
5151
// Convert other relative markdown links to repository links
5252
.replace(/\]\(([^)]+\.md)\)/g, '](https://github.com/llm-d-incubation/llm-d-infra/blob/main/quickstart/examples/inference-scheduling/$1)')
53+
// fixing install-deps.sh
54+
.replace(/\[install\-deps\.sh\]\(\.\.\/\.\.\/install\-deps\.sh\)/g, '[install-deps.sh](https://github.com/llm-d-incubation/llm-d-infra/blob/main/quickstart/install-deps.sh)')
55+
// fixing gke.md
56+
.replace(/\[gke\.md\]\(\.\/gke\.md\)/g, '[gke.md](https://github.com/llm-d-incubation/llm-d-infra/blob/main/quickstart/examples/inference-scheduling/gke.md)')
57+
// fixing architecture.md
58+
.replace(/\[scheduling configuration\]\(https\:\/\/github\.com\/llm\-d\/llm\-d\-inference\-scheduler\/blob\/main\/docs\/architecture\.md\)/g, '[scheduling configuration](https://github.com/llm-d/llm-d-inference-scheduler/blob/main/docs/architecture.md)')
5359
});
5460
}
5561
return undefined;
5662
},
5763
},
58-
];
64+
];

‎remote-content/remote-sources/guide-prerequisites.js‎

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/**
22
* Guide Prerequisites Remote Content
3-
*
3+
*
44
* Downloads the quickstart README.md file from the llm-d-infra repository
55
* and transforms it into docs/guide/Installation/prerequisites.md
66
*/
@@ -15,11 +15,11 @@ export default [
1515
sourceBaseUrl: 'https://raw.githubusercontent.com/llm-d-incubation/llm-d-infra/main/',
1616
outDir: 'docs/guide/Installation',
1717
documents: ['quickstart/README.md'],
18-
18+
1919
// Plugin behavior
2020
noRuntimeDownloads: false, // Download automatically when building
2121
performCleanup: true, // Clean up files after build
22-
22+
2323
// Transform the content for this specific document
2424
modifyContent(filename, content) {
2525
if (filename === 'quickstart/README.md') {
@@ -48,9 +48,18 @@ export default [
4848
.replace(/#openshift-and-grafana/g, '#install-on-openshift')
4949
// Fix relative path references to files
5050
.replace(/\]\(grafana\/dashboards\/([^)]+)\)/g, '](https://github.com/llm-d-incubation/llm-d-infra/blob/main/quickstart/grafana/dashboards/$1)')
51+
// Fix grafana-setup.md
52+
.replace(/\[Grafana\ setup\ guide\]\(\.\/grafana\-setup\.md\)/g, '[Grafana setup guide](https://github.com/llm-d-incubation/llm-d-infra/blob/main/quickstart/docs/monitoring/grafana-setup.md)')
53+
// Fix grafana dashboards
54+
.replace(/\[llm\-d dashboard\]\(\.\/grafana\/dashboards\/llm\-\d\-dashboard\.json\)/g, '[llm-d dashboard](https://raw.githubusercontent.com/llm-d-incubation/llm-d-infra/refs/heads/main/quickstart/docs/monitoring/grafana/dashboards/llm-d-dashboard.json)')
55+
// Fix inference gateway
56+
.replace(/\[inference\-gateway\ dashboard\]\(https\:\/\/github\.com\/kubernetes\-sigs\/gateway\-api\-inference\-extension\/blob\/main\/tools\/dashboards\/inference\_gateway\.json\)/g, '[inference-gateway dashboard](https://raw.githubusercontent.com/kubernetes-sigs/gateway-api-inference-extension/refs/heads/main/tools/dashboards/inference_gateway.json)')
57+
// Fix install-deps.sh
58+
.replace(/\[Grafana\ setup\ guide\]\(\.\/grafana\-setup\.md\)/g, '[Grafana setup guide](https://github.com/llm-d-incubation/llm-d-infra/blob/main/quickstart/docs/monitoring/grafana-setup.md)')
59+
5160
});
5261
}
5362
return undefined;
5463
},
5564
},
56-
];
65+
];

‎src/components/Install/index.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ export default function Install() {
3434
alt="2. "
3535
src={require('/docs/assets/counting-02.png').default}
3636
></img>
37-
<a className="link" href="docs/guide/Installation/quickstart#install">
37+
<a className="link" href="docs/guide/Installation/prerequisites">
3838
Run the Quickstart
3939
</a>
4040
</h3>
@@ -46,7 +46,7 @@ export default function Install() {
4646
alt="3. "
4747
src={require('/docs/assets/counting-03.png').default}
4848
></img>
49-
<a className="link" href="docs/guide/Installation/quickstart#examples">Explore llm-d!</a></h3>
49+
<a className="link" href="docs/guide/Installation/prerequisites#examples">Explore llm-d!</a></h3>
5050
{/* -------------------------------------------------------------------------- */}
5151
<a className="static-button install-button button-link" href="docs/guide">
5252
Complete install methods here

0 commit comments

Comments
 (0)