docs(15.9): document installing plugins from the command line - #531
Merged
Conversation
The plugin guide only covered the admin UI, so nothing said how to pin a plugin version. Without one, bin/fess-setup asks the repository for the newest version built for this Fess, which makes a build step such as a Dockerfile install something different on each run. Adds a section to admin/plugin-guide.rst in all seven languages of the 15.9 tree covering `install plugin <name>[:<version>]`: the colon form, how it relates to --version, that plugins are released separately so each needs its own version, that the previous version is deleted after the new one is installed, and that a version that does not exist exits 1. This describes codelibs/fess#3432, which is not merged yet.
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.
Problem
admin/plugin-guide.rstonly covers the admin UI, so nothing in the docs sayshow to install a plugin at a chosen version. Without one,
bin/fess-setupasksthe repository for the newest version built for this Fess, so a build step such
as a Dockerfile installs something different on each run.
Change
A new section, Installing from the Command Line, in the 15.9 tree of all
seven languages (ja / en / de / es / fr / ko / zh-cn). It covers:
bin/fess-setup install plugin <name>and what happens without a version<name>:<version>rather than a single shared value
--versionas the default for the names that carry noneinstalled, and that a version that does not exist exits 1, so a Dockerfile
fails rather than carrying on with the plugin missing
The section sits at the same level as the existing management section; the
admin UI text is unchanged.
Verification
Each file parsed with docutils (
doctitle_xform=False, the|Fess|substitution supplied as the build's
rst_prologdoes) and compared againstthe same file on
master:The remaining messages are the too-short heading underlines already in these
files and are left alone. The new headings' underlines are generated from the
display width, so CJK titles are not short. The resulting tree puts the new
section as a sibling of the management section in every language.