docs(15.9): Google Cloud Storage moved to the fess-lib-gcs plugin - #526
Merged
Conversation
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Depends on codelibs/fess#3424, which takes the Google Cloud Storage SDK out of the distribution. From 15.9 on,
gcs://crawling and thegcsstorage type come from thefess-lib-gcsplugin.install/upgrade.rstA 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:
gcs:is rejected as an invalid protocolstorage.type=gcsNeither fails with a missing class. The section intro moves from five changes to six.
The shipped default of
crawler.file.protocolsgcsis gone from it, so the documented default becomesfile,smb,smb1,ftp,s3ininstall/upgrade.rst,config/crawler-advanced.rst(both the property table and the configuration example) andconfig/properties.rst. The plugin addsgcsback at runtime when it is installed, throughProtocolHelper#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 ofadmin/storage-guide.rst, and the GCS bucket example ofadmin/fileconfig-guide.rst. Thegcs://entry in the crawl-path list and the GCS storage type inadmin/general-guide.rstsay the plugin is required.dev/plugin-architecture.rstThe page lists the plugin types Fess derives from the artifact prefix and was missing
fess-lib-*, whichPluginHelper.ArtifactTypehas carried since #3418.fess-lib-gcsis 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 MiB→218.9 MiBbecomes204.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-apiandwoodstox-coreeach 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.rsthas no storage server configuration section (73 lines against 97),ko/admin/fileconfig-guide.rsthas no S3/GCS crawl examples (198 against 245), andconfig/properties.rstexists 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:The new section titles carry CJK text, so their underlines were generated from
unicodedata.east_asian_widthrather than counted by hand.