Skip to content

Commit e814109

Browse files
committed
fail script on build. Specify in style gudie that paths are relative to root of repo.
1 parent e199af1 commit e814109

File tree

3 files changed

+10
-1
lines changed

3 files changed

+10
-1
lines changed

contribute/style-guide.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,8 @@ Code will be inserted here
145145
\```
146146
```
147147

148+
**File paths are relative to the root of the docs repository**
149+
148150
You should commit the code inserted to the snippet as we want people (or LLMs)
149151
reading the markdown to be able to see the code. The advantage of importing code
150152
to snippets this way is that you can test your snippets externally or store them

plugins/code-import-plugin.js

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,6 +109,7 @@ function codeImportPlugin(context, options) {
109109
importedContent = extractSnippet(rawContent, snippetId);
110110
} catch (urlError) {
111111
console.warn(`Could not fetch URL ${url} in ${filePath}: ${urlError.message}`);
112+
process.exit(1);
112113
continue; // Skip this replacement if URL fetch fails
113114
}
114115
}
@@ -123,6 +124,7 @@ function codeImportPlugin(context, options) {
123124

124125
} catch (error) {
125126
console.warn(`Could not process ${param} in ${filePath}: ${error.message}`);
127+
process.exit(1);
126128
}
127129
}
128130

@@ -135,6 +137,7 @@ function codeImportPlugin(context, options) {
135137
}
136138
} catch (error) {
137139
console.warn(`Error processing file ${filePath}: ${error.message}`);
140+
process.exit(1);
138141
}
139142
}
140143

@@ -151,6 +154,7 @@ function codeImportPlugin(context, options) {
151154
console.log(`Processed code imports in: ${path.relative(context.siteDir, file.path)}`);
152155
} catch (error) {
153156
console.error(`Error writing processed file ${file.path}: ${error.message}`);
157+
process.exit(1);
154158
}
155159
}
156160
}

scripts/aspell-dict-file.txt

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1102,4 +1102,7 @@ explorative
11021102
--docs/integrations/data-ingestion/clickpipes/postgres/faq.md--
11031103
ReceiveMessage
11041104
--docs/integrations/data-ingestion/clickpipes/postgres/postgres_generated_columns.md--
1105-
RelationMessage
1105+
RelationMessage
1106+
--docs/use-cases/observability/clickstack/deployment/hyperdx-clickhouse-cloud.md--
1107+
clickstack
1108+
otel

0 commit comments

Comments
 (0)