Skip to content

docs(15.9): Google Cloud Storage moved to the fess-lib-gcs plugin - #526

Merged
marevol merged 1 commit into
masterfrom
docs/gcs-plugin-15.9
Sep 9, 2026
Merged

docs(15.9): Google Cloud Storage moved to the fess-lib-gcs plugin#526
marevol merged 1 commit into
masterfrom
docs/gcs-plugin-15.9

Conversation

@marevol

@marevol marevol commented Sep 9, 2026

Copy link
Copy Markdown
Contributor

Depends on codelibs/fess#3424, which takes the Google Cloud Storage SDK out of the distribution. From 15.9 on, gcs:// crawling and the gcs storage type come from the fess-lib-gcs plugin.

install/upgrade.rst

A sixth incompatible change for 15.9, next to the other two things that left the distribution. It names the plugin, both install routes, and what an installation sees if it upgrades without installing it:

  • a file crawl configuration whose path begins with gcs: is rejected as an invalid protocol
  • the storage page reports that no client is registered for storage.type=gcs

Neither fails with a missing class. The section intro moves from five changes to six.

The shipped default of crawler.file.protocols

gcs is gone from it, so the documented default becomes file,smb,smb1,ftp,s3 in install/upgrade.rst, config/crawler-advanced.rst (both the property table and the configuration example) and config/properties.rst. The plugin adds gcs back at runtime when it is installed, through ProtocolHelper#addFileProtocol, so the effective value with the plugin is unchanged — it is the shipped value that differs.

Where GCS is configured

The same short prerequisite note goes on the three pages that tell a reader how to set GCS up: the GCS Crawler section of config/crawler-advanced.rst, the GCS Settings of admin/storage-guide.rst, and the GCS bucket example of admin/fileconfig-guide.rst. The gcs:// entry in the crawl-path list and the GCS storage type in admin/general-guide.rst say the plugin is required.

dev/plugin-architecture.rst

The page lists the plugin types Fess derives from the artifact prefix and was missing fess-lib-*, which PluginHelper.ArtifactType has carried since #3418. fess-lib-gcs is the first plugin of that type, so the row is added here rather than in a separate change.

The ZIP figure

The Node.js section's 438.5 MiB218.9 MiB becomes 204.7 MiB. The 14.2 MiB is measured, not estimated: the compressed size of the 30 archive entries the change removes, less the three older jars it puts back (grpc-api, stax2-api and woodstox-core each return to the version their remaining consumer asks for).

Coverage

All seven languages, 42 files. Three pages were left alone rather than translated as part of this change, all pre-existing gaps: ko/admin/storage-guide.rst has no storage server configuration section (73 lines against 97), ko/admin/fileconfig-guide.rst has no S3/GCS crawl examples (198 against 245), and config/properties.rst exists only in English.

Verification

Each of the 42 files was parsed with docutils before and after the edit using doctitle_xform=False, the way Sphinx parses, and the results compared:

  • no new system messages
  • no markup left unparsed in the rendered text — the check that catches CJK-adjacent inline markup, which fails silently on the start-string side
  • the same number of top-level sections, which is what catches a heading underline whose length does not match the title's display width

The new section titles carry CJK text, so their underlines were generated from unicodedata.east_asian_width rather than counted by hand.

codelibs/fess#3424 takes the Google Cloud Storage SDK out of the distribution, so gcs://
crawling and the gcs storage type now come from the fess-lib-gcs plugin. install/upgrade.rst
gains a sixth incompatible change for 15.9 naming the plugin and both ways to install it, and
the count in the section intro moves from five to six.

The shipped crawler.file.protocols loses gcs as well, so its documented default becomes
file,smb,smb1,ftp,s3 in install/upgrade.rst, config/crawler-advanced.rst (the property table
and the example) and config/properties.rst.

The pages where GCS is configured get the same short prerequisite note: the GCS Crawler
section of config/crawler-advanced.rst, the GCS Settings of admin/storage-guide.rst and the
GCS bucket example of admin/fileconfig-guide.rst. The gcs:// entry in the path list and the
GCS storage type in admin/general-guide.rst now say the plugin is required.

dev/plugin-architecture.rst lists the plugin types Fess derives from the artifact prefix and
was missing fess-lib-*, which PluginHelper.ArtifactType has carried since #3418. The new
plugin is the first of that type, so the row is added here.

The ZIP figure in the Node.js section moves from 218.9 MiB to 204.7 MiB. The 14.2 MiB
difference is measured rather than estimated: it is the compressed size of the 30 archive
entries the change removes, less the three older jars it puts back.

All seven languages. Three pages were left alone rather than translated as part of this
change: ko/admin/storage-guide.rst has no storage server configuration section,
ko/admin/fileconfig-guide.rst has no S3/GCS crawl examples, and config/properties.rst exists
only in English.

Each of the 42 files was parsed with docutils before and after the edit, with
doctitle_xform=False the way Sphinx parses: no new system messages, no markup left unparsed
in the rendered text, and the same number of top-level sections, which is what catches a
mis-sized heading underline.
@marevol marevol self-assigned this Sep 9, 2026
@marevol
marevol merged commit 8d1e4ad into master Sep 9, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant