Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
836 commits
Select commit Hold shift + click to select a range
0fabdc1
Update altinity-kb-who-ate-my-memory.md
filimonov Mar 6, 2025
93c94fd
Added article about using istio and the clickhouse operator
CaptTofu Mar 6, 2025
cf8d750
Updated CTAs
DougTidwell Mar 18, 2025
6e988c0
Merge pull request #135 from Altinity/sphoorti
DougTidwell Mar 18, 2025
6c7391d
Added multiple pass parsing to dynamic JSONs
lesandie Mar 21, 2025
d093d1f
Updated JSON example
lesandie Mar 21, 2025
855a0eb
Added some useful info from Misha
CaptTofu Mar 6, 2025
7a6cbef
Updated GitHub links in header and footer
DougTidwell Mar 26, 2025
6b66e31
Merge pull request #136 from Altinity/april
DougTidwell Mar 26, 2025
a1b5f93
A/B tests of the same query
BorisTyshkevich Mar 28, 2025
def1539
Update jsonextract-to-parse-many-attributes-at-a-time.md
lesandie Apr 1, 2025
4fb3bd8
Update background_message_broker_schedule_pool_size.md
filimonov Apr 7, 2025
33ee241
Update background_message_broker_schedule_pool_size.md
filimonov Apr 7, 2025
3b6158c
SEO improvements to make content easier to find
DougTidwell Apr 9, 2025
4b5b316
Merge pull request #137 from Altinity/april
DougTidwell Apr 9, 2025
1314950
executable dictionary as a cron task (#138)
lesandie Apr 11, 2025
9733902
Update detached-parts.md
CaptTofu Apr 18, 2025
6dc3f69
@CaptTofu has signed the CLA in Altinity/altinityknowledgebase#134
github-actions[bot] Apr 18, 2025
2e8a36a
Update who-ate-my-cpu.md
den-crane Apr 27, 2025
6461ae4
Update altinity-kb-system-tables-eat-my-disk.md
den-crane Apr 28, 2025
86cce12
Update altinity-kb-system-tables-eat-my-disk.md
den-crane May 3, 2025
06b4062
Update debug-hang.md
filimonov May 5, 2025
346c007
Merge pull request #134 from CaptTofu/useful-info-from-misha
DougTidwell May 12, 2025
aea7cfc
Merge pull request #133 from CaptTofu/istio-kb
DougTidwell May 12, 2025
e0b1053
Update altinity-kb-istio-user-issue-k8s.md
DougTidwell May 12, 2025
42d67fb
Update connection-issues-distributed-parts.md
DougTidwell May 12, 2025
ca4001c
DROP DETACHED PARTITION ALL
BorisTyshkevich May 13, 2025
315a74f
typo
BorisTyshkevich May 13, 2025
1a8dae4
typo
BorisTyshkevich May 13, 2025
a40590e
typo
BorisTyshkevich May 13, 2025
a63760d
Update altinity-kb-adjusting-librdkafka-settings.md
lesandie May 15, 2025
236f589
Update _index.md
filimonov May 19, 2025
9db6d5f
Update projections-examples.md
BorisTyshkevich May 19, 2025
53deb20
Update projections-examples.md
BorisTyshkevich May 19, 2025
f878ed9
Update altinity-kb-kafka-mv-consuming.md
BorisTyshkevich May 20, 2025
bea457a
Update altinity-kb-kafka-mv-consuming.md
BorisTyshkevich May 20, 2025
cfc192a
Update altinity-kb-kafka-mv-consuming.md
BorisTyshkevich May 20, 2025
8ffb088
Update idempotent_inserts_mv.md
BorisTyshkevich May 23, 2025
4037d7c
Update _index.md
filimonov May 27, 2025
ef41de5
Update _index.md
filimonov May 27, 2025
aa184c4
Update jsonextract-to-parse-many-attributes-at-a-time.md
lesandie May 29, 2025
4ed678b
Update altinity-kb-kafka-mv-consuming.md
BorisTyshkevich May 29, 2025
d16c89e
Update altinity-kb-who-ate-my-memory.md
BorisTyshkevich Jun 16, 2025
c3a7b91
Update altinity-kb-system-tables-eat-my-disk.md
den-crane Jun 20, 2025
ec88396
Fix username recovery-after-complete-data-loss.md
Jun 23, 2025
dba84af
@mkmkme has signed the CLA in Altinity/altinityknowledgebase#139
github-actions[bot] Jun 23, 2025
793abd5
Merge pull request #139 from mkmkme/patch-1
SaltTan Jun 23, 2025
1863dd9
Update information about clickhouse-backup Atomic support
Slach Jun 26, 2025
978868a
where clause analisys
BorisTyshkevich Jul 14, 2025
8e9f5d9
more examples and links
BorisTyshkevich Jul 14, 2025
fe1e8f7
fixes
BorisTyshkevich Jul 14, 2025
204c05a
pro/cons
BorisTyshkevich Jul 17, 2025
55acbdc
Update altinity-kb-database-size-table-column-size.md
filimonov Jul 18, 2025
6257774
Too fast inserts
BorisTyshkevich Jul 21, 2025
6b56854
style
BorisTyshkevich Jul 21, 2025
53d8138
Too fast inserts
BorisTyshkevich Jul 21, 2025
fb239e0
Update useful-setting-to-turn-on.md (#140)
jus1096 Jul 22, 2025
6c6e3dc
Create clean-up-orphaned-objects-on-s3.md.md
BorisTyshkevich Jul 23, 2025
e9e3dc2
Update clean-up-orphaned-objects-on-s3.md.md
BorisTyshkevich Jul 23, 2025
db41911
Update clean-up-orphaned-objects-on-s3.md.md
BorisTyshkevich Jul 23, 2025
aa77753
Update clean-up-orphaned-objects-on-s3.md.md
BorisTyshkevich Jul 24, 2025
c93e189
Update ingestion-rate-part_log.md
BorisTyshkevich Jul 28, 2025
c7d3fb1
Added ClickSuite migration tool
lesandie Aug 2, 2025
449798d
clarification of using MATERIALIZE TTL IN PARTITION
lesandie Aug 7, 2025
c6f4d07
final supports Additional Skip Indexes
BorisTyshkevich Aug 7, 2025
6db71db
Update altinity-kb-final-clause-speed.md
BorisTyshkevich Aug 7, 2025
5239ef4
Update altinity-kb-final-clause-speed.md
BorisTyshkevich Aug 7, 2025
dccebb2
added max_block_size tuning and explanation
lesandie Aug 15, 2025
b27bab1
Update async inserts article (#141)
joshleecreates Aug 18, 2025
361de7a
Added REO pixel code
DougTidwell Aug 19, 2025
1a85eca
Merge pull request #142 from Altinity/august
DougTidwell Aug 19, 2025
ae91e74
Added Project Antalya link to right nav
DougTidwell Aug 20, 2025
480e262
Merge pull request #143 from Altinity/august
DougTidwell Aug 20, 2025
7570949
Update altinity-kb-memory-overcommit.md
lesandie Aug 29, 2025
00ae212
Create jemalloc_heap_profiling.md
UnamedRus Sep 1, 2025
3bbbc60
Update jemalloc_heap_profiling.md
UnamedRus Sep 1, 2025
e38d66f
Create client-timeouts.md
BorisTyshkevich Sep 2, 2025
3fc9d6d
Update client-timeouts.md
BorisTyshkevich Sep 2, 2025
b3f21a0
Update client-timeouts.md
BorisTyshkevich Sep 2, 2025
ccb5980
Update projections-examples.md
BorisTyshkevich Sep 2, 2025
36e0d87
Update projections-examples.md
BorisTyshkevich Sep 2, 2025
fa49341
Update best-schema-for-storing-many-metrics-registered-from-the-singl…
BorisTyshkevich Sep 19, 2025
50ed0bc
Update add_remove_replica.md
lesandie Sep 23, 2025
1d251c3
added Copying Multi-Terabyte Live ClickHouse to Another Server
BorisTyshkevich Sep 29, 2025
79b609c
Update rsync.md
BorisTyshkevich Sep 29, 2025
dc907c2
Update rsync.md
BorisTyshkevich Sep 29, 2025
a301db7
Update rsync.md
BorisTyshkevich Sep 29, 2025
0d4ea87
Update rsync.md
BorisTyshkevich Sep 30, 2025
31678d5
Update rsync.md
BorisTyshkevich Sep 30, 2025
54c0be6
add about DETACHED
BorisTyshkevich Oct 1, 2025
3ebaea7
headers formatting
BorisTyshkevich Oct 1, 2025
e24133f
Update altinity-kb-check-replication-ddl-queue.md
BorisTyshkevich Oct 1, 2025
e284b3c
Update altinity-kb-check-replication-ddl-queue.md
BorisTyshkevich Oct 1, 2025
80f2919
dll queue moved to other article
BorisTyshkevich Oct 1, 2025
4ce52a7
moved section from replication problems
BorisTyshkevich Oct 1, 2025
466d6a1
Update altinity-kb-check-replication-ddl-queue.md
BorisTyshkevich Oct 1, 2025
7323801
Fix broken flyway link
klaporte Oct 8, 2025
58a9170
@klaporte has signed the CLA in Altinity/altinityknowledgebase#144
github-actions[bot] Oct 8, 2025
ebd1a05
Merge pull request #144 from klaporte/patch-1
UnamedRus Oct 10, 2025
7b012ec
Enhance clickhouse-backup schema migration commands
lesandie Oct 22, 2025
d1c5eb3
remove clickhouse-copier section
BorisTyshkevich Oct 23, 2025
a49409e
Update altinity-kb-who-ate-my-memory.md
SaltTan Oct 23, 2025
fbf2c73
Clarify instructions for removing cluster replicas
lesandie Oct 24, 2025
84135f2
Create metric_log_ram.md
filimonov Nov 10, 2025
4add229
Update metric_log_ram.md
filimonov Nov 10, 2025
f07b6b6
Fix grammar and clarity in pick-keys.md
BorisTyshkevich Nov 12, 2025
e3204a5
@jaitaiwan has signed the CLA in Altinity/altinityknowledgebase#145
github-actions[bot] Nov 17, 2025
3f54786
Update Kafka error handling documentation
lesandie Nov 19, 2025
3aacc6d
Enhance executable dictionary documentation
lesandie Nov 19, 2025
19b8822
Update detached-parts.md
BorisTyshkevich Nov 25, 2025
622d496
Enhance documentation on detached parts in ClickHouse
BorisTyshkevich Nov 26, 2025
7f5a466
Update pick-keys.md
BorisTyshkevich Dec 1, 2025
e488178
RO replicas recovery improvement (#146)
lesandie Dec 9, 2025
46c82a0
Update altinity-kb-memory-configuration-settings.md
filimonov Dec 29, 2025
7fe1301
Update metric_log_ram.md
filimonov Dec 30, 2025
17460fa
Revise ClickHouse and Zookeeper monitoring metrics
BorisTyshkevich Jan 6, 2026
a4a6446
Add documentation for Kafka engine virtual columns
lesandie Jan 7, 2026
24bce66
Include Kafka subsettings example in documentation
lesandie Jan 7, 2026
1f50105
Fix SQL code block formatting in documentation
lesandie Jan 7, 2026
97d5152
Improve clarity on TTL application and settings
lesandie Jan 14, 2026
fc40ddd
Clarify SYSTEM RESTORE REPLICA command usage
BorisTyshkevich Jan 15, 2026
0003443
Update rsync.md
BorisTyshkevich Jan 15, 2026
955bacb
Enhance notes for restoring replicas with ON CLUSTER
BorisTyshkevich Jan 15, 2026
11ca25d
Configure memory settings for ClickHouse merges
lesandie Jan 20, 2026
a98d262
Update altinity-kb-who-ate-my-memory.md
SaltTan Jan 23, 2026
a1e10d6
Update add_remove_replica.md
anselmodadams Jan 29, 2026
9db2db6
Added Clarity tracking code
DougTidwell Jan 30, 2026
50966d4
Merge pull request #148 from Altinity/august
DougTidwell Jan 30, 2026
1a91abf
Update altinity-kb-aggressive_merges.md
SaltTan Feb 3, 2026
58507c5
Fixed smart quotes inserted by Google into the Clarity tracking script
DougTidwell Feb 4, 2026
ac7a51a
Merge pull request #150 from Altinity/august
DougTidwell Feb 4, 2026
7fe7ec1
Added ClickHouse TTLs in Practice eBook link to left nav
DougTidwell Feb 5, 2026
467b20b
Merge pull request #151 from Altinity/august
DougTidwell Feb 5, 2026
fe72c62
Update altinity-kb-system-tables-eat-my-disk.md
den-crane Feb 8, 2026
cc77b72
corrected detached parts kb article with new sections and information…
lesandie Feb 17, 2026
3b28e04
Update hardware-requirements.md
anselmodadams Feb 17, 2026
c3dce4e
updated navbar fixes
mcknightd Feb 18, 2026
d4d705a
Merge pull request #157 from fosforus/main
DougTidwell Feb 18, 2026
6307209
Fixed broken Project Antalya link in top nav
DougTidwell Feb 18, 2026
ae765fb
Merge pull request #158 from DougTidwell/february
DougTidwell Feb 18, 2026
f2a04ab
Updated syntax for who ate my memory
DougTidwell Feb 23, 2026
abfc7f5
Merge pull request #159 from DougTidwell/february
DougTidwell Feb 23, 2026
7840c77
Added explanations for multiple Useful Queries pages, fixed some non-…
capgar Feb 25, 2026
09ef969
@capgar has signed the CLA in Altinity/altinityknowledgebase#160
github-actions[bot] Feb 26, 2026
e57ce86
Merge pull request #160 from capgar/kbase_queries
SaltTan Feb 27, 2026
d8583ce
Update rsync.md
UnamedRus Mar 2, 2026
36c0656
Improve detached parts KB for 23.10+ behavior and safe cleanup recipes
bvt123 Mar 2, 2026
d747af2
Create users_in_keeper.md
filimonov Mar 4, 2026
458d2cc
Update users_in_keeper.md
filimonov Mar 4, 2026
df7d488
Create keeper-dependent-features.md
filimonov Mar 4, 2026
4a0050c
Update users_in_keeper.md
filimonov Mar 4, 2026
1e0906b
Update users_in_keeper.md
filimonov Mar 4, 2026
36c33d1
Update users_in_keeper.md
filimonov Mar 5, 2026
6a9d32d
Update users_in_keeper.md
filimonov Mar 5, 2026
64b441b
Update users_in_keeper.md
filimonov Mar 5, 2026
bc4b328
Update users_in_keeper.md
filimonov Mar 5, 2026
f6125ad
Update users_in_keeper.md
filimonov Mar 5, 2026
9b564ff
Update users_in_keeper.md
filimonov Mar 5, 2026
ae2f486
Updated the nav bar for the mobile site
DougTidwell Mar 5, 2026
dbf081f
Merge pull request #166 from DougTidwell/february
DougTidwell Mar 5, 2026
fffb090
Added Diego's notes on DROP DETACHED to the "How ALTERs work in Click…
DougTidwell Mar 5, 2026
38a47d0
Merge pull request #167 from DougTidwell/february
DougTidwell Mar 5, 2026
8dd4bbc
Remove warning alert about column materialization
lesandie Mar 6, 2026
557b739
Updated the useful-queries query_log page
capgar Mar 11, 2026
fde5b9e
Restructure Kafka KB sections and refresh named-collection guidance
lesandie Mar 12, 2026
496a04b
Stop tracking AGENTS.md
lesandie Mar 12, 2026
cd5fea6
Create AGENTS.md with editing guidelines for KB
lesandie Mar 12, 2026
9eb8daf
Merge branch 'main' into kafka_update
lesandie Mar 12, 2026
712acbe
Update AGENTS.md
realyota Mar 12, 2026
7296178
kb: tighten monitoring article checks
realyota Mar 12, 2026
d6c0647
Improve FINAL clause speed article with recent version changes
bvt123 Mar 17, 2026
4d71c69
Merge pull request #172 from Altinity/improve-final-clause-speed-article
BorisTyshkevich Mar 17, 2026
6680d8b
Fix formatting and update rsync instructions
BorisTyshkevich Mar 17, 2026
5dd6cab
Minor changes to main index, webinar link added to right nav
DougTidwell Mar 17, 2026
d3075a6
Merge pull request #173 from DougTidwell/february
DougTidwell Mar 17, 2026
67832a5
Revise final clause notes and add references
BorisTyshkevich Mar 18, 2026
70c0fd2
Revise FINAL processing documentation with settings update
BorisTyshkevich Mar 18, 2026
57381bc
Add desharding migration article
bvt123 Mar 19, 2026
69e328d
Detached parts update (#163)
lesandie Mar 20, 2026
f7aaadd
Merge pull request #170 from capgar/ca_query_log
SaltTan Mar 24, 2026
49c228c
Expand aggressive merges guidance
bvt123 Mar 24, 2026
5c945b5
Revise resource allocation details for ClickHouse merges
BorisTyshkevich Mar 24, 2026
be0daf8
Add case for Numeric values. Redo example to work without external UDF
shacuros Mar 25, 2026
6f37e0a
@shacuros has signed the CLA in Altinity/altinityknowledgebase#174
github-actions[bot] Mar 25, 2026
51c71e6
Update uniqExact-to-uniq-combined.md
shacuros Mar 25, 2026
0cfaf30
Update content/en/altinity-kb-setup-and-maintenance/users_in_keeper.md
filimonov Mar 25, 2026
67eafbe
Update content/en/altinity-kb-setup-and-maintenance/users_in_keeper.md
filimonov Mar 25, 2026
9bcf691
Apply suggestions from code review
filimonov Mar 25, 2026
c66714d
Merge pull request #164 from Altinity/filimonov-patch-1
filimonov Mar 25, 2026
0dcbefd
Merge pull request #174 from shacuros/migrate_uniqExact
shacuros Mar 26, 2026
9860ab5
Changes for clickhouse-keeper article
realyota Mar 10, 2026
ddf2092
Update content/en/altinity-kb-setup-and-maintenance/altinity-kb-zooke…
realyota Mar 27, 2026
82ac9ba
Changes to Keeper article
realyota Mar 27, 2026
98d8e61
Add multidisk-jbod-balancing.md
eyyu Mar 28, 2026
6854cfe
@eyyu has signed the CLA in Altinity/altinityknowledgebase#175
github-actions[bot] Mar 28, 2026
8069ff3
@Maksim-Burtsev has signed the CLA in Altinity/altinityknowledgebase#176
github-actions[bot] Mar 30, 2026
719853c
Merge pull request #169 from realyota/mbak_kb_changes
SaltTan Mar 31, 2026
9b08d9a
Update altinity-kb-system-tables-eat-my-disk.md
SaltTan Mar 31, 2026
20bf5f7
Update clickhouse-keeper.md
SaltTan Mar 31, 2026
d93628c
Changes to clickhouse-keeper.md: add embedded keeper section
realyota Mar 31, 2026
81d4afa
Changes to clickhouse-keeper.md: add embedded keeper section
realyota Mar 31, 2026
02a1cf5
Merge branch 'mbak_kb_changes' of github.com:realyota/altinityknowled…
realyota Mar 31, 2026
918de6f
Merge pull request #177 from realyota/mbak_kb_changes
SaltTan Mar 31, 2026
235acd1
Link to demo page added to right nav
DougTidwell Mar 31, 2026
76cd8d5
Merge pull request #178 from DougTidwell/february
DougTidwell Mar 31, 2026
1bc1704
Update content/en/altinity-kb-setup-and-maintenance/multidisk-jbod-ba…
eyyu Apr 2, 2026
6cd6d38
Refine Round Robin description in multidisk balancing
eyyu Apr 2, 2026
2d1e5d4
Merge remote-tracking branch 'origin' into kafka_update
lesandie Apr 6, 2026
c29af8c
make it better
bvt123 Apr 6, 2026
cfa7f1b
Merge remote-tracking branch 'origin/main'
bvt123 Apr 6, 2026
fb8ee79
Update row-level-deduplication.md
SaltTan Apr 8, 2026
d77fa13
Detail query usage
eyyu Apr 9, 2026
69b86fc
Merge pull request #175 from Altinity/multidisk-config
SaltTan Apr 9, 2026
508e31a
Merge remote-tracking branch 'origin' into kafka_update
lesandie Apr 10, 2026
a24444d
Updates for Marketing tracking
DougTidwell Apr 21, 2026
fdf3eaa
Merge pull request #179 from DougTidwell/february
DougTidwell Apr 21, 2026
93da33a
Merge pull request #171 from Altinity/kafka_update
BorisTyshkevich Apr 23, 2026
63db6d0
Revise error handling documentation for Kafka integration
lesandie Apr 29, 2026
b4d2132
Updates to generate site summaries for LLMs
DougTidwell Apr 29, 2026
b932ee7
Merge pull request #180 from DougTidwell/february
DougTidwell Apr 29, 2026
2800f28
Update altinity-kb-system-tables-eat-my-disk.md
den-crane Apr 29, 2026
37be41b
Merge branch 'Altinity:main' into kb/altinity-kb-monitoring-review
realyota May 4, 2026
438aae7
Update altinity-kb-monitoring.md
realyota May 6, 2026
ee28c80
Update add_remove_replica.md
DougTidwell May 7, 2026
9ee0f6b
Update add_remove_replica.md
DougTidwell May 7, 2026
8ff22e3
Merge pull request #183 from DougTidwell/main
Slach May 7, 2026
0d6f9e0
Param name fixed
dyadyatriple May 24, 2026
af9b15e
@dyadyatriple has signed the CLA in Altinity/altinityknowledgebase#186
github-actions[bot] May 28, 2026
bd7546c
Merge pull request #186 from dyadyatriple/patch-1
SaltTan May 28, 2026
8918a5c
Merge branch 'Altinity:main' into kb/altinity-kb-monitoring-review
realyota Jun 4, 2026
361a2da
add PyClickHouseMigrator to schema migration tools (#176)
Maksim-Burtsev Jun 4, 2026
2e9e674
Changes after review
realyota Jun 4, 2026
0ee122d
Update content/en/altinity-kb-setup-and-maintenance/keeper-dependent-…
filimonov Jun 8, 2026
c88d3a7
Update content/en/altinity-kb-setup-and-maintenance/keeper-dependent-…
filimonov Jun 8, 2026
6a0a872
Update content/en/altinity-kb-setup-and-maintenance/keeper-dependent-…
filimonov Jun 8, 2026
695c8f6
Update content/en/altinity-kb-setup-and-maintenance/keeper-dependent-…
filimonov Jun 8, 2026
a38f280
Update content/en/altinity-kb-setup-and-maintenance/keeper-dependent-…
filimonov Jun 8, 2026
f882edf
Merge pull request #165 from Altinity/filimonov-patch-2
filimonov Jun 15, 2026
012eb64
Merge pull request #181 from realyota/kb/altinity-kb-monitoring-review
filimonov Jun 24, 2026
4007c43
Update clickhouse-keeper.md
filimonov Jul 9, 2026
c45f665
@VighneshPath has signed the CLA in Altinity/altinityknowledgebase#187
github-actions[bot] Jul 17, 2026
b09e3d2
Adds node rebuild section to add/remove replica
VighneshPath Aug 7, 2026
f005fc1
Merge pull request #188 from Altinity/add-node-rebuild-to-add-remove-…
VighneshPath Aug 8, 2026
71100c5
Add article: exporting query and session logs to files, S3, or HTTP
BorisTyshkevich Aug 25, 2026
af28030
Merge pull request #189 from Altinity/kb/export-system-logs
BorisTyshkevich Aug 25, 2026
8e60d02
Simplify export-system-logs article
BorisTyshkevich Aug 25, 2026
678db6c
Merge pull request #190 from Altinity/kb/export-system-logs-simplify
BorisTyshkevich Aug 25, 2026
55983e8
Make the repo self-onboarding for Claude Code and Codex
BorisTyshkevich Aug 25, 2026
11d1d99
Add review questions to AGENTS.md
BorisTyshkevich Aug 25, 2026
909c91f
Merge pull request #191 from Altinity/chore/agent-onboarding
BorisTyshkevich Aug 25, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
55 changes: 55 additions & 0 deletions .claude/skills/altinity-kb-article-writer/SKILL.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
---
name: altinity-kb-article-writer
description: Write new Altinity Knowledge Base articles in the repository's established style, including section selection, target markdown file path, Hugo frontmatter, and full draft content. Use when asked to create or draft KB articles for ClickHouse topics in this repository.
---

# Altinity KB Article Writer

Write a complete KB-ready draft that matches this repository's style.

## Use this workflow

1. Identify article intent from the prompt:
- Problem statement or topic
- Target audience (operator, developer, data engineer, mixed)
- Desired depth (`quick how-to`, `troubleshooting`, `deep explanation`)
- Environment constraints (Cloud, Kubernetes, replication, version constraints)

2. Select the best section using `references/section-map.md`.

3. Propose the destination path in this format:
- `content/en/<section>/<slug>.md`

4. Build frontmatter using the defaults in `references/kb-style-guide.md`:
- Required: `title`, `linkTitle`, `description`
- Optional: `keywords`, `weight` (only when explicitly needed for ordering)

5. Draft the article using `references/article-template.md` and style rules:
- Short practical intro
- Clear `##` and `###` headings
- Language-tagged code fences (`sql`, `bash`, `yaml`, `xml`, etc.)
- Actionable examples and caveats
- Related resources at the end

6. Run a self-review using `references/qa-checklist.md`.

7. Return output in this order:
- Suggested path
- Full markdown (frontmatter + body)
- QA checklist result (pass/fail bullets)
- If section routing is ambiguous, include one alternative path

## Authoring rules

- Prefer practical, operator-useful guidance over theory.
- Use concise technical English.
- Preserve ClickHouse naming and SQL syntax exactly.
- Do not add uncommon frontmatter fields (`alias`, `manualLink`, redirects) unless explicitly requested.
- Avoid unsupported claims; if unsure, state assumptions.

## File and slug rules

- Use lowercase kebab-case slugs.
- Prefer `altinity-kb-<topic>.md` in sections where that convention is common.
- If a likely collision exists, append a disambiguator (for example `-v2` or `-on-kubernetes`).

4 changes: 4 additions & 0 deletions .claude/skills/altinity-kb-article-writer/agents/openai.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
interface:
display_name: "Altinity KB Article Writer"
short_description: "Draft KB articles in local Altinity style"
default_prompt: "Use $altinity-kb-article-writer to draft a new KB article with section path, frontmatter, and full markdown in this repository style."
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# KB Article Template

Use this template as the baseline shape, then adjust to topic.

```markdown
---
title: "<Human title>"
linkTitle: "<Navigation title>"
description: >
<One sentence summary of the page purpose.>
keywords:
- <optional-keyword-1>
- <optional-keyword-2>
---

<Short practical intro: what this solves, when to use it.>

## Problem

<Describe symptom, failure mode, or task objective.>

## Solution

<Explain approach and why it works.>

### Step 1: <Name>

```sql
-- or bash/yaml/etc
```

<Explain expected output or interpretation.>

### Step 2: <Name>

```sql
-- or bash/yaml/etc
```

<Explain expected output or interpretation.>

## Validation

<How to confirm the fix/design works. Include checks and thresholds if relevant.>

## Caveats

- <Version caveat>
- <Performance caveat>
- <Operational caveat>

## Related resources

- [<Internal KB link>](</altinity-kb-.../>)
- [<Official docs link>](https://clickhouse.com/docs/)
```

## Minimal variant

For short pages (for example function or setting notes), keep:
- frontmatter
- short intro
- one or two focused sections
- at least one example block

Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
# Altinity KB Style Guide (Repository Baseline)

This guide captures the dominant style used under `content/en/**` in this repository.

## Frontmatter defaults for normal KB pages

Use:

```yaml
---
title: "Page title"
linkTitle: "Left nav title"
description: >
One-sentence summary.
---
```

Optional:
- `keywords`: list of 2-5 useful search terms
- `weight`: only if explicit ordering in section navigation is needed

Avoid unless explicitly requested:
- `manualLink`, `alias`/`aliases`, redirect `type`/`target`, `draft`

## Content structure

- Start with a short practical intro (1-3 paragraphs).
- Use `##` for major sections and `###` for subsections.
- Keep sections task-oriented:
- Context/problem
- Steps or examples
- Validation or expected outcome
- Caveats / edge cases

## Code and command blocks

- Use fenced blocks with language tags:
- `sql`, `bash`, `yaml`, `xml`, `json`, `text`
- Keep runnable snippets minimal and focused.
- Prefer realistic table/settings names.

## Length

KB articles are short. Median is ~430 words; 90% are under 1100.

- Target under 1000 words; over 1500 needs a clear reason.
- Cut mechanism write-ups, source-code walkthroughs, stack traces, and evidence
tables — those belong in the PR description. Give the operational rule and its
version scope, not the derivation.

See the length budget in `AGENTS.md` for the authoritative wording.

## Writing tone

- Technical and direct.
- Emphasize actionable guidance for operators and engineers.
- Prefer concrete examples over abstract descriptions.
- Use concise English; avoid marketing wording.

## Links

- Add internal KB links when relevant.
- Add official external links for docs/blog/release notes.
- End with a "Related resources" section when useful.

## Filename and slug

- Lowercase kebab-case filename.
- Prefer `altinity-kb-<topic>.md` where section convention suggests it.
- Place in best-fit section under `content/en`.

Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# QA Checklist for Generated KB Articles

Run this checklist before returning output.

This checklist covers mechanical correctness only. Also answer the **Review
questions** in `AGENTS.md` — they cover whether the reader needs the content, how
you know the examples work, and whether the article actually solves the problem
end-to-end. A draft can pass every box below and still be the wrong article.

## Metadata

- [ ] Path is under `content/en/<section>/`.
- [ ] Filename uses lowercase kebab-case.
- [ ] Frontmatter has `title`, `linkTitle`, `description`.
- [ ] Optional fields are justified (`keywords`, `weight`).
- [ ] Uncommon fields are not present unless requested.

## Structure and readability

- [ ] Intro clearly states problem and scope.
- [ ] Headings are logical (`##` then `###`).
- [ ] Steps or examples are easy to follow.
- [ ] Caveats or assumptions are explicit.

## Technical quality

- [ ] SQL/commands are syntactically plausible.
- [ ] Code fences include language tags.
- [ ] Version-sensitive behavior is called out if relevant.
- [ ] No unsupported claims are presented as facts.

## Linking

- [ ] Includes relevant internal KB links when possible.
- [ ] Includes high-quality official external references when useful.

## Final output contract

- [ ] Output includes suggested path.
- [ ] Output includes full markdown draft.
- [ ] Output includes brief QA result (`PASS` or `FAIL` with reasons).
- [ ] If routing was ambiguous, one alternative path is included.

Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Section Map for `content/en`

Select the section that best matches the user topic.

## Primary routing rules

- `altinity-kb-queries-and-syntax`
- SQL syntax, query behavior, joins, window functions, TTL syntax, query semantics
- `altinity-kb-setup-and-maintenance`
- Operational troubleshooting, replication operations, backup/restore, upgrades in practice, cluster setup
- `altinity-kb-schema-design`
- `ORDER BY`, `PARTITION BY`, materialized views, table modeling, codecs, LowCardinality design
- `altinity-kb-integrations`
- Kafka, MySQL, Spark, BI tools, external systems and connectors
- `altinity-kb-useful-queries`
- Reusable diagnostics queries against `system.*` and operational SQL snippets
- `altinity-kb-dictionaries`
- External dictionaries, layouts, dictionary performance and configuration
- `altinity-kb-functions`
- Function behavior, function-specific examples, expression patterns
- `engines`
- Engine internals and engine-specific behavior (MergeTree family, Atomic, etc.)
- `altinity-kb-kubernetes`
- Altinity Operator, Kubernetes deployment and networking issues
- `upgrade`
- Upgrade strategy, compatibility notes, known upgrade pitfalls

## Tie-break rules

1. If article is mostly query text and reusable snippets, prefer `altinity-kb-useful-queries`.
2. If article is mostly conceptual SQL behavior, prefer `altinity-kb-queries-and-syntax`.
3. If topic is schema/key design, prefer `altinity-kb-schema-design`.
4. If issue is runtime operations and incidents, prefer `altinity-kb-setup-and-maintenance`.
5. If still ambiguous, choose the section with the highest overlap and provide one alternative path.

## Path format

Use:
- `content/en/<section>/<slug>.md`

Where:
- `<slug>` is lowercase kebab-case
- Prefix with `altinity-kb-` when it fits section naming patterns

Examples:
- `content/en/altinity-kb-useful-queries/altinity-kb-find-heavy-merges.md`
- `content/en/altinity-kb-schema-design/altinity-kb-choosing-order-by-for-events.md`

2 changes: 1 addition & 1 deletion .github/workflows/cla.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ jobs:
- name: "CLA Assistant"
if: (github.event.comment.body == 'recheck' || github.event.comment.body == 'I have read the CLA Document and I hereby sign the CLA') || github.event_name == 'pull_request_target'
# Beta Release
uses: cla-assistant/github-action@v2.1.3-beta
uses: cla-assistant/github-action@v2.4.0
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
# the below token should have repo scope and must be manually added by you in the repository's secret
Expand Down
18 changes: 9 additions & 9 deletions .github/workflows/gh-pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,36 +8,36 @@ on:

jobs:
deploy:
runs-on: ubuntu-20.04
runs-on: ubuntu-22.04
steps:
- name: Git checkout
uses: actions/checkout@v2
uses: actions/checkout@v4
with:
submodules: true # Fetch Hugo themes (true OR recursive)
fetch-depth: 0 # Fetch all history for .GitInfo and .Lastmod
ref: main

- name: Setup Hugo
uses: peaceiris/actions-hugo@v2
uses: peaceiris/actions-hugo@v3
with:
hugo-version: 'latest'
hugo-version: '0.128.2'
extended: true

- name: Cache Hugo modules
uses: actions/cache@v2
uses: actions/cache@v4
with:
path: /tmp/hugo_cache
key: ${{ runner.os }}-hugomod-${{ hashFiles('**/go.sum') }}
restore-keys: |
${{ runner.os }}-hugomod-

- name: Setup Node
uses: actions/setup-node@v3
uses: actions/setup-node@v4
with:
node-version: '14'
node-version: '20'

- name: Cache dependencies
uses: actions/cache@v2
uses: actions/cache@v4
with:
path: ~/.npm
key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
Expand All @@ -51,7 +51,7 @@ jobs:
# run: hugo --gc

- name: Deploy
uses: peaceiris/actions-gh-pages@v3
uses: peaceiris/actions-gh-pages@v4
if: github.ref == 'refs/heads/main'
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
Expand Down
8 changes: 8 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
docs/
*.DS_Store*
node_modules/
.vscode/*
yarn.lock
.hugo_build.lock
/.idea/.gitignore
/.idea/altinityknowledgebase.iml
/resources/_gen/assets/scss/scss/main.scss_3f90599f3717b4a4920df16fdcadce3d.content
/resources/_gen/assets/scss/scss/main.scss_3f90599f3717b4a4920df16fdcadce3d.json
/.idea/modules.xml
/.idea/vcs.xml
/.idea/inspectionProfiles/Project_Default.xml
Loading