Skip to content

docs(15.9): regenerate the configuration properties page - #568

Open
marevol wants to merge 1 commit into
mainfrom
docs/regenerate-properties-159
Open

marevol wants to merge 1 commit into
mainfrom
docs/regenerate-properties-159

Conversation

@marevol

@marevol marevol commented Oct 4, 2026

Copy link
Copy Markdown
Contributor

Summary

Regenerates the 15.9 configuration properties page from fess main with tools/update_properties_doc.sh. It covers all 7 locales (.rst and .po).

  • 35 keys added during 15.9 development were missing from the page; they are now listed.
  • 3 descriptions or defaults are updated: the frontmatter example, the z_score note, and the export file list, which gains chat_log.ndjson.
  • No key is removed.

The user tag keys (user.tag.*, index.field.tag, page.tagtype.max.fetch.size, online.help.name.tagtype, and tag in index.export.exclude.fields) are deliberately left out. They are added by #567, which documents that feature, so either PR can be merged first. The second one needs the page regenerated from main again.

Verification

  • tools/gen_properties_doc.py --check passes.
  • The tools unit tests pass.
  • check_headings.py reports no issues for 15.9.
  • docutils parses all 7 pages.

Regenerated from the current fess main fess_config.properties with
tools/update_properties_doc.sh. Descriptions stay English, as before.

Added (35): api.search.export, api.search.export.max.size,
api.search.export.fields, api.search.export.rate.limit.per.minute,
crawler.document.file.owner.enabled,
crawler.document.file.last.modifier.enabled, crawler.document.ocr.enabled,
crawler.document.ocr.language, crawler.document.ocr.timeout,
index.field.etag, index.field.owner, index.field.last_modifier,
logging.chat.max.queue.size, search.history.enabled, search.history.size,
related_query.generate.* (11 keys), docreport.duplicate.group.size,
docreport.duplicate.docs.size, docreport.duplicate.export.page.size,
docreport.dormant.days, rag.chat.log.enabled,
rag.chat.query.regeneration.max.count, rag.chat.document.max.parts,
rag.chat.response.language, theme.repositories,
theme.index.frame.ancestors

Removed: none.
Changed: the frontmatter description gains a frontmatter.title example;
the z_score normalization description notes the arithmetic_mean
restriction; the export file list default gains chat_log.ndjson.

The user tag keys (user.tag.*, index.field.tag, page.tagtype.max.fetch.size,
online.help.name.tagtype, and tag in index.export.exclude.fields) are
intentionally left out; they are documented separately.
@marevol marevol self-assigned this Oct 4, 2026
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