Skip to content

Commit 0e962a9

Browse files
author
Phillip Kuznetsov
authored
Sort the Reference documentation indices (#158)
Signed-off-by: Phillip Kuznetsov <pkuznetsov@pixielabs.ai>
1 parent 0b438b4 commit 0e962a9

1 file changed

Lines changed: 24 additions & 12 deletions

File tree

gatsby-node.js

Lines changed: 24 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,15 @@ exports.createPages = ({
113113
title,
114114
description,
115115
) => {
116+
qlobjectDocs.sort((docA, docB) => {
117+
if (docA.body.name < docB.body.name) {
118+
return -1;
119+
}
120+
if (docA.body.name > docB.body.name) {
121+
return 1;
122+
}
123+
return 0;
124+
});
116125
// Create the individual pages.
117126
qlobjectDocs.forEach((doc) => createPage({
118127
path: utils.functionPageUrl(doc.body.name, catPath),
@@ -145,29 +154,21 @@ exports.createPages = ({
145154
'tracepoint-decorator',
146155
'Tracepoint Decorators',
147156
`The Decorator functions to wrap around a tracepoint function.
148-
When defining the body of the tracepoint, see Tracepoint Fields.`
149-
150-
,
157+
When defining the body of the tracepoint, see Tracepoint Fields.`,
151158
);
152159
pxlObjectDocsPages(
153160
jsonDocumentation.tracepointFieldDocs,
154161
'tracepoint-field',
155162
'Tracepoint Fields',
156-
157163
`Field accessors to use while writing a tracepoint. Must be written
158-
in a function wrapped by a Tracepoint Decorator.`
159-
160-
,
164+
in a function wrapped by a Tracepoint Decorator.`,
161165
);
162166
pxlObjectDocsPages(
163167
jsonDocumentation.compileFnDocs,
164168
'compiler-fns',
165169
'Compile Time Functions',
166-
167170
`Functions that are evaluated and usable at run time. Unlike [Execution Time Functions](/reference/pxl/udf), these are usable at compile-time
168-
meaning you can pass them as parameters to [Operators](/reference/pxl/operators) as well as [ExecTime functions](/reference/pxl/udf).`
169-
170-
,
171+
meaning you can pass them as parameters to [Operators](/reference/pxl/operators) as well as [ExecTime functions](/reference/pxl/udf).`,
171172
);
172173
pxlObjectDocsPages(
173174
jsonDocumentation.dataframeOpDocs,
@@ -182,12 +183,23 @@ exports.createPages = ({
182183
'The methods to interact with Pixie\'s OpenTelemetry exporter',
183184
);
184185

186+
const { udfDocs } = jsonDocumentation;
187+
udfDocs.udf.sort((docA, docB) => {
188+
if (docA.name < docB.name) {
189+
return -1;
190+
}
191+
if (docA.name > docB.name) {
192+
return 1;
193+
}
194+
return 0;
195+
});
196+
185197
// create udfDocs index Pages
186198
createPage({
187199
path: utils.functionPageUrl('', 'udf'),
188200
component: path.resolve('./src/templates/udfDocsIndex.tsx'),
189201
context: {
190-
data: JSON.stringify(jsonDocumentation.udfDocs),
202+
data: JSON.stringify(udfDocs),
191203
title: 'Execution Time Functions',
192204
pagePath: utils.functionPageUrl('', 'tracepoint-field'),
193205
},

0 commit comments

Comments
 (0)