docs(15.9): document per-user tags kept in the tag_type index - #567
Merged
Merged
Conversation
This follows codelibs/fess#3551, which replaces the user tags that were labels of the kind "tag" with per-user tags in the fess_config.tag_type index, and replaces the tag documentation added in #565. - api/api-tag.rst: the new endpoints (GET/POST /api/v2/tags, PUT/DELETE /api/v2/tags/{id}, GET/POST /api/v2/documents/{docId}/tags and DELETE /api/v2/documents/{docId}/tags/{id}) with their login and CSRF requirements, examples and errors; private and shared tags; the tags of search hits, the tag facet and fields.tag filtering; the delay until the per-minute log_aggregator job applies the queued changes; and the user.tag.* settings. - admin/tagtype-guide.rst: a new page for the admin Tag screen, its fields, sharing, how changes reach documents through the queue and the tag_updater job, and notes for operators. It is listed after the label page in the administrator guide. - admin/labeltype-guide.rst: back to its content before #565, without the Kind field and the user tag section. - api/api-uiconfig.rst: features.user_tag describes the new feature. - api/admin/api-admin-tagtype.rst: a new page for /api/admin/tagtype, listed after the label type API. Updates send seq_no and primary_term from GET setting/{id}; a stale pair or a name the owner already uses fails with a validation error. - config/properties.rst and properties.po: only the rows the pull request changes are applied (user.tag.*, index.field.tag, page.tagtype.max.fetch.size, online.help.name.tagtype and the default of index.export.exclude.fields), rendered with the generator's own functions so the pages still pass --check.
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
1 participant
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.
Summary
Documents the per-user tags of codelibs/fess#3551 for 15.9. That PR keeps tags in their own
fess_config.tag_typeindex instead of labels of the kindtag. This replaces the tag documentation added in #565.All seven locales (ja, en, de, es, fr, ko, zh-cn) are updated,
15.9only.Changes
api/api-tag.rst: rewritten for the new v2 endpoints:GET/POST /api/v2/tagsPUT/DELETE /api/v2/tags/{id}GET/POST /api/v2/documents/{docId}/tagsDELETE /api/v2/documents/{docId}/tags/{id}It covers the login and CSRF requirements, examples and errors. It explains private and shared tags, the
tagsof search hits, the tag facet andfields.tagfiltering. It also covers the delay until queued changes reach documents, and theuser.tag.*settings.admin/tagtype-guide.rst(new): the admin Tag screen.tag_updaterjob).api/admin/api-admin-tagtype.rst(new): the/api/admin/tagtypeadmin API, listed next to labeltype in the index and the overview table.admin/labeltype-guide.rst: the Kind field and the user-tag section from docs(15.9): document the new 15.9 features #565 are removed, which restores the page to its content before docs(15.9): document the new 15.9 features #565.api/api-uiconfig.rst: theuser_tagflag describes the new feature.config/properties.rst/.po: rows for the newuser.tag.*,index.field.tag,page.tagtype.max.fetch.sizeandonline.help.name.tagtypekeys. Alsoindex.export.exclude.fields=cache,tag.Verification
tools/check_headings.pyandgen_properties_doc.py --checkpass.Merge after codelibs/fess#3551.