Skip to content

Commit 8c6717d

Browse files
authored
Revert "Update UI: Add breadcrumbs to search results (#626)" (#627)
This reverts commit b9ca3cc.
1 parent b9ca3cc commit 8c6717d

File tree

6 files changed

+12
-108
lines changed

6 files changed

+12
-108
lines changed

Makefile

+1-2
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,8 @@ build-prod: build-ui
1212
build-ui:
1313
node_modules/.bin/gulp --cwd ui bundle
1414

15-
# build the search index and add pagefind files to the output.
1615
build-search-index:
17-
npm run build-search-index
16+
npx pagefind --site build/site
1817

1918
serve:
2019
python3 -m http.server -d build/site

README.adoc

+5-12
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,7 @@
44
This is the main repository for the documentation of the Stackable platform.
55
Have a look at the https://docs.stackable.tech/[live version] and the current https://docs.stackable.tech/home/nightly/[nightly live version].
66

7-
The documentation is built with https://antora.org[Antora].
8-
This repository hosts the Antora playbook file as well as platform documentation.
9-
Other Stackable repos contain 'docs' directories which are pulled in by this repo.
7+
The documentation is built with https://antora.org[Antora]. This repository hosts the Antora playbook file as well as platform documentation. Other Stackable repos contain 'docs' directories which are pulled in by this repo.
108

119
== Repository structure
1210

@@ -27,23 +25,18 @@ $ npm ci
2725
$ make
2826
----
2927

30-
NOTE: Antora caches the external content repos in the cache directory (configured to be `./cache`)
31-
It will _not_ automatically update those.
32-
Use the `--fetch` flag (`make ANTORAFLAGS=--fetch`) to update all sources, or use `make clean` to delete the `cache` and `build` directory.
28+
NOTE: Antora caches the external content repos in the cache directory (configured to be `./cache`). It will _not_ automatically update those. Use the `--fetch` flag (`make ANTORAFLAGS=--fetch`) to update all sources, or use `make clean` to delete the `cache` and `build` directory.
3329

3430
== Production deployment
3531

3632
The documentation is deployed by Netlify on a regular basis or when something is pushed to the `main` branch.
3733
To trigger an out of band deployment, use the _Build and deploy production site_ GitHub action (internal contributors only).
3834

39-
Regular (nightly) deployments are run to pick up changes in the operator repositories.
40-
These repositories are not watched by Netlify and thus any changes to the documentation there would be ignored.
35+
Regular (nightly) deployments are run to pick up changes in the operator repositories. These repositories are not watched by Netlify and thus any changes to the documentation there would be ignored.
4136

4237
=== Netlify configuration
4338

44-
Netlify is configured with the link:netlify.toml[`netlify.toml`] file inside of the documentation repo.
45-
In there, the command `make netlify-build` is configured as the build command.
46-
Further documentation of the build process can then be found in the link:Makefile[`Makefile`].
39+
Netlify is configured with the link:netlify.toml[`netlify.toml`] file inside of the documentation repo. In there, the command `make netlify-build` is configured as the build command. Further documentation of the build process can then be found in the link:Makefile[`Makefile`].
4740

4841
The build process creates a static site in `build/site` which is then published (as it is configured in the `netlify.toml`).
4942

@@ -65,7 +58,7 @@ NOTE: Antora does not recognize git submodules as git repositories
6558

6659
The design & layout comes from our https://github.com/stackabletech/documentation-ui[UI repository].
6760

68-
`LIVERELOAD=true gulp` may be used to recreate the built documentation after each edit.
61+
`LIVERELOAD=true gulp` may be used to recreate the built documentation after each edit. The 'live reload' feature does not work over gitpod currently due to https://github.com/schickling/gulp-webserver/pull/126
6962

7063
== More useful links
7164

modules/contributor/pages/docs/overview.adoc

+1-4
Original file line numberDiff line numberDiff line change
@@ -43,16 +43,13 @@ The reference is found at https://crds.stackable.tech/ and generated from the ht
4343

4444
The xref:docs/style-guide.adoc[] contains all the information about the writing style, formatting style, naming documents and more.
4545

46-
== Technical bits: Antora, Netlify, Pagefind
46+
== Technical bits: Antora, Netlify
4747

4848
{antora-docs}[Antora] uses a {antora-playbook}[playbook] to build the documentation.
4949
It pulls information from all the individual operators, so their documentation can live in the same repository.
5050
Antora builds a static website which we serve over {netlify}[Netlify].
5151
The web template of the documentation is also custom made and is developed in the https://github.com/stackabletech/documentation-ui[documentation-ui] repository.
5252

53-
For search, we use https://pagefind.app/[pagefind] - a static search.
54-
The search index is generated as part of the build process and no external index is queried during search.
55-
5653
For Antora, the https://antora.zulipchat.com/[Antora Zulip chatroom] is a good place to get help (besides the documentation)!
5754

5855
Building the documentation and also the deployment process on Netlify are documented in the https://github.com/stackabletech/documentation/blob/main/README.adoc[README] file of the documentation repository.

package-lock.json

+2-83
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

+2-6
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,13 @@
11
{
22
"devDependencies": {
33
"@antora/cli": "^3.1.7",
4-
"@antora/site-generator": "^3.1.7",
5-
"pagefind": "^1.1.0"
4+
"@antora/site-generator": "^3.1.7"
65
},
76
"dependencies": {
87
"@antora/lunr-extension": "^1.0.0-alpha.8",
98
"@asciidoctor/tabs": "^1.0.0-beta.6"
109
},
1110
"workspaces": [
1211
"ui"
13-
],
14-
"scripts": {
15-
"build-search-index": "npx pagefind --site build/site"
16-
}
12+
]
1713
}

0 commit comments

Comments
 (0)