diff --git a/automod/cachestore/doc.go b/automod/cachestore/doc.go new file mode 100644 index 00000000..246b0baa --- /dev/null +++ b/automod/cachestore/doc.go @@ -0,0 +1,6 @@ +// Automod component for caching arbitary data (as JSON strings) with a fixed TTL and purging. +// +// Includes an interface and implementations using redis and in-process memory. +// +// This is used by the rules engine to cache things like account metadata, improving latency and reducing load on authoritative backend systems. +package cachestore diff --git a/automod/capture/doc.go b/automod/capture/doc.go new file mode 100644 index 00000000..51449697 --- /dev/null +++ b/automod/capture/doc.go @@ -0,0 +1,4 @@ +// Automod development helpers for fetching and saving snapshots of real-world content and metadata. +// +// NOTE: real-world content is sensitive, even if it is abusive. +package capture diff --git a/automod/countstore/doc.go b/automod/countstore/doc.go new file mode 100644 index 00000000..0bc66d4b --- /dev/null +++ b/automod/countstore/doc.go @@ -0,0 +1,2 @@ +// Interface for fast atomic counters, and separate implmentations using redis and in-process memory. +package countstore diff --git a/automod/engine/doc.go b/automod/engine/doc.go new file mode 100644 index 00000000..ef01f380 --- /dev/null +++ b/automod/engine/doc.go @@ -0,0 +1,2 @@ +// Core automod rules engine implementation and related types +package engine diff --git a/automod/flagstore/doc.go b/automod/flagstore/doc.go new file mode 100644 index 00000000..597d7450 --- /dev/null +++ b/automod/flagstore/doc.go @@ -0,0 +1,2 @@ +// Interface for storing "flags", a form of private automod metadata. +package flagstore diff --git a/automod/rules/doc.go b/automod/rules/doc.go new file mode 100644 index 00000000..95fa57de --- /dev/null +++ b/automod/rules/doc.go @@ -0,0 +1,2 @@ +// Example automod rules and helpers. +package rules diff --git a/automod/setstore/doc.go b/automod/setstore/doc.go new file mode 100644 index 00000000..df1c0067 --- /dev/null +++ b/automod/setstore/doc.go @@ -0,0 +1,2 @@ +// Interface for simple sets of strings, with fast inclusion checks. +package setstore