docs: modernize README and tutorials - #60
Merged
Merged
Conversation
- Requirements/Installation: reflect the tested Ruby 3.2-4.0 / Fluentd 1.x and
fluent-package (the td-agent successor); drop the `-v 1.0.3` and td-agent2/3
install lines.
- Tutorials: update Fluentd v0.12-era config to v1 syntax (`@type`, `<buffer>`
section); fix the dead raw2.github.com URL; fix `<match replicator.*>` which
cannot match the multi-level tag (-> `replicator.**`); fix the single-plugin
tag comment that wrongly referenced the manager table.
- Document the nested-document (`${...}` sub-query) feature; mention composite
primary keys, json_columns, and enable_retry/retry_interval where relevant.
- Output example log path -> /var/log/fluent; dev-container
`bundle install --path` -> `bundle config set --local path`.
- Remove the completed "string type of primary_key" TODO; fix typos (comming,
millons, follwing, "It is a example") and assorted grammar.
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Bring back the "what the inserted row looks like" table that the previous commit dropped. Converted from raw HTML to Markdown and updated to the current settings schema, including json_columns, enable_retry, and retry_interval and showing which columns fall back to their defaults. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Rewrite s.summary to match the README overview: fix the "comming" typo and the broken grammar, and drop the never-realized "support replicate to another RDB/noSQL" claim. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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
Docs-only refresh of
README.md,Tutorial-mysql_replicator.md, andTutorial-mysql_replicator_multi.md. They had drifted to Fluentd v0.12 / td-agentera content.
Stale → fixed
Wrong / broken
type,buffer_type/buffer_path)→ updated to v1 (
@type,<buffer>section).Tutorial-mysql_replicator_multi.mdlinked a deadraw2.github.comURL→
raw.githubusercontent.com.<match replicator.*>, which cannot match themulti-level tag
replicator.myweb.search_test...→replicator.**.${primary_key}comment wrongly pointed at themanager table (that's the multi plugin) → corrected.
-v 1.0.3and referenced EOL td-agent2/td-agent3→ RubyGems +
fluent-gem(fluent-package).the tested Ruby 3.2–4.0 / Fluentd 1.x / fluent-package v6 LTS / ES 6–9.
Missing docs
${...}sub-query) feature (only a vagueone-liner before; also reflects the Issue with mysql_replicator #4/fix: only run nested sub-query for SELECT templates with ${...} (#4) #52
${...}-required behavior).json_columns, andenable_retry/retry_intervalin the multi tutorial.Cosmetic
comming,millons,follwing, "It is a example", and grammar.bundle install --path(deprecated) →bundle config set --local path vendor/bundle && bundle install./var/log/td-agent/→/var/log/fluent/.No code changes.
🤖 Generated with Claude Code