Skip to content

Commit ed1f144

Browse files
committed
website: updates
1 parent b1e8029 commit ed1f144

File tree

3 files changed

+49
-28
lines changed

3 files changed

+49
-28
lines changed

website/docs/maintainer/index.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -407,6 +407,13 @@ caffeinate ssh xbbla32
407407
<PlatformDockerBuild platform="linux-arm"/>
408408

409409

410+
### Update the durations of the development builds
411+
412+
In `website/docs/maintainer/_development-durations.mdx`, update
413+
the durations of the builds.
414+
415+
Commit with the message _**website: update development durations**_.
416+
410417
### Update the trees in the Install Guide page
411418

412419
Copy the trees displayed at the end of the test builds and paste to
@@ -442,13 +449,6 @@ differences compared to the repository.
442449

443450
Commit if necessary with the message _**package.json: update executables links**_.
444451

445-
### Update the durations of the development builds
446-
447-
In `website/docs/maintainer/_development-durations.mdx`, update
448-
the durations of the builds.
449-
450-
Commit with the message _**website: update development durations**_.
451-
452452
### How to build a debug version
453453

454454
In some cases it is necessary to run a debug session with the binaries.

website/docs/user/index.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,12 +33,12 @@ import UseInTesting from './_use-in-testing.mdx';
3333
This page is intended for those who plan
3434
to use the **xPack GNU Bash** binaries in their workflows.
3535

36+
<More/>
37+
3638
<Versioning/>
3739

3840
<LibrariesAndRpath/>
3941

40-
<More/>
41-
4242
<UseInTesting/>
4343

4444

website/docusaurus.config.ts

Lines changed: 40 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -434,25 +434,46 @@ const config: Config = {
434434
theme: prismThemes.github,
435435
darkTheme: prismThemes.dracula,
436436
},
437-
// algolia: {
438-
// // https://docsearch.algolia.com/docs/docsearch-v3/
439-
// appId: "KIDD7R4CL1",
440-
// apiKey: "ca2ffc431941284609f2d50202fc5506",
441-
// indexName: "xpackio",
442-
443-
// // It ensures that search results are relevant to the current
444-
// // language and version. Enabled by default.
445-
// contextualSearch: false, // true,
446-
// // Optional: Replace parts of the item URLs from Algolia.
447-
// // Useful when using the same search index for multiple deployments
448-
// // using a different baseUrl. You can use regexp or string in the
449-
// // `from` param. For example: localhost:3000 vs myCompany.com/docs
450-
// // replaceSearchResultPathname: undefined,
451-
// // Optional: Algolia search parameters
452-
// searchParameters: {},
453-
// // Optional: path for search page that enabled by default (`false` to disable it)
454-
// searchPagePath: false, // 'search',
455-
// },
437+
// https://docusaurus.io/docs/search#using-algolia-docsearch
438+
// https://docsearch.algolia.com/docs/docsearch-v3/
439+
algolia: {
440+
// The application ID provided by Algolia
441+
appId: "KIDD7R4CL1",
442+
443+
// Public API key: it is safe to commit it
444+
apiKey: "ca2ffc431941284609f2d50202fc5506",
445+
446+
indexName: "xpackio",
447+
448+
// It ensures that search results are relevant to the current
449+
// language and version. Enabled by default.
450+
contextualSearch: true,
451+
452+
// Optional: Specify domains where the navigation should occur
453+
// through window.location instead on history.push. Useful when
454+
// our Algolia config crawls multiple documentation sites and
455+
// we want to navigate with window.location.href to them.
456+
// externalUrlRegex: 'external\\.com|domain\\.com',
457+
externalUrlRegex: 'xpack\\.github\\.io|xpack-dev-tools\\.github\\.io',
458+
459+
// Optional: Replace parts of the item URLs from Algolia.
460+
// Useful when using the same search index for multiple deployments
461+
// using a different baseUrl. You can use regexp or string in the
462+
// `from` param. For example: localhost:3000 vs myCompany.com/docs
463+
// replaceSearchResultPathname: {
464+
// from: '/docs/', // or as RegExp: /\/docs\//
465+
// to: '/',
466+
// },
467+
468+
// Optional: Algolia search parameters
469+
searchParameters: {},
470+
471+
// Optional: path for search page that enabled by default (`false` to disable it)
472+
searchPagePath: 'search',
473+
474+
// Optional: whether the insights feature is enabled or not on Docsearch (`false` by default)
475+
insights: false,
476+
},
456477
} satisfies Preset.ThemeConfig,
457478

458479
customFields: customFields,

0 commit comments

Comments
 (0)