Docs & rules

apache/dolphinschedulerGitHub

This is a public, read-only report. Striff reads this repository's docs, turns each sentence that makes a claim about the code into a rule, and checks the rule against the code on the default branch. How this works

3 stale names in these docs.

devc63ecc9Last read Oct 3

Is this yours? Install to manage it

Once installed, Striff checks every pull request.

Documents
Rules
45
8
8
7
7
7
7
7
1 stale name
1
1
1
1
1
1 stale name
3
3
1
1
9
9
2
1 stale name2
3
3
16
16
3
3
25 docs
apache/dolphinschedulerOpen repository

Stale names in these docs3

Each sentence below has a stale name: a type the default branch doesn't declare, or declares somewhere else. Edit the doc so it matches the code, or bring the type back.

  • Goneorg.apache.dolphinscheduler.registry.api.RegistryFactory
    When you need to extend plugins, you only need to implement org.apache.dolphinscheduler.registry.api.RegistryFactory.

    org.apache.dolphinscheduler.registry.api declares nothing by this name. Closest name there: Registry.

    View on GitHub

  • Goneorg.apache.dolphinscheduler.registry.api.RegistryFactory
    dolphinscheduler-registry-api 定义了实现插件的标准,当你需要扩展插件的时候只需要实现 org.apache.dolphinscheduler.registry.api.RegistryFactory 即可。

    org.apache.dolphinscheduler.registry.api declares nothing by this name. Closest name there: Registry.

    View on GitHub

  • RenamedBaseHdfsConnectionParam
    DataSourceProcessor, AbstractDataSourceProcessor, BaseDataSourceParamDTO, BaseHdfsConnectionParam, and the DataSourcePluginManager that loads plugins.

    Renamed: BaseHdfsConnectionParam is now BaseHDFSConnectionParam, at dolphinscheduler-datasource-plugin/dolphinscheduler-datasource-api/src/main/java/org/apache/dolphinscheduler/plugin/datasource/api/datasource/BaseHDFSConnectionParam.java. Renamed in 7e0010d

    View on GitHub

apache/dolphinscheduler — documented rules

46 of 46 rules, printed October 14, 2026.

The sentence in your docs
Read Oct 3
Don't add dolphinscheduler-common dependencies to -base — it's kept lean on purpose (like -spi).
nothing in dolphinscheduler-extract/dolphinscheduler-extract-base may depend on dolphinscheduler-common
Broken
Read Oct 3
In additional, the AlertChannelFactory extends from PrioritySPI, this means you can set the plugin priority, when you have two plugin has the same name, you can customize the priority by override the getIdentify method.
AlertChannelFactory extends PrioritySPI
Holds
Read Oct 3
AlertChannel The interface of the alert plug-in. The alert plug-in needs to implement this interface. There is only one method process in this interface.
AlertChannel has a process method
Holds
Read Oct 3
AlertData Alarm content information, including id, title, content, log.
4 rules from this sentence
AlertData has id
Holds
AlertData has title
Holds
AlertData has content
Holds
AlertData has log
Holds
Read Oct 3
AlertInfo For alarm-related information, when the upper-level system calls an instance of the alarm plug-in, the instance of this class is passed to the specific alarm plug-in through the process method. It contains the alert content AlertData and the parameter information filled in by the front end of the called alert plug-in instance.
AlertInfo depends on AlertData
Holds
Read Oct 3
另外,AlertChannelFactory 继承自 PrioritySPI,这意味着你可以设置插件的优先级,当你有两个插件同名时,你可以通过重写 getIdentify 方法来自定义优先级。高优先级的插件会被加载,但是如果你有两个同名且优先级相同的插件,加载插件时服务器会抛出 IllegalArgumentException。
AlertChannelFactory extends PrioritySPI
Holds
Read Oct 3
@SpringBootApplication AlertServer + HA coordinator (AlertHAServer) + RPC server (AlertRpcServer) + event loop.
3 rules from this sentence
AlertServer is annotated with SpringBootApplication
Holds
AlertServer depends on AlertHAServer
Holds
AlertServer depends on AlertRpcServer
Holds
Read Oct 3
ApiApplicationServer — @SpringBootApplication.
ApiApplicationServer is annotated with SpringBootApplication
Holds
Read Oct 3
dao.entity — persistence POJOs (Command, WorkflowInstance, TaskInstance, User, Project, Tenant, DataSource, Cluster, etc.).
6 rules from this sentence
Command is in org.apache.dolphinscheduler.dao.entity
Holds
TaskInstance is in org.apache.dolphinscheduler.dao.entity
Holds
Project is in org.apache.dolphinscheduler.dao.entity
Holds
Tenant is in org.apache.dolphinscheduler.dao.entity
Holds
DataSource is in org.apache.dolphinscheduler.dao.entity
Holds
Cluster is in org.apache.dolphinscheduler.dao.entity
Holds
Read Oct 3
One per table/entity (CommandMapper, WorkflowInstanceMapper, TaskInstanceMapper, …).
3 rules from this sentence
CommandMapper is in org.apache.dolphinscheduler.dao.mapper
Holds
WorkflowInstanceMapper is in org.apache.dolphinscheduler.dao.mapper
Holds
TaskInstanceMapper is in org.apache.dolphinscheduler.dao.mapper
Holds
Read Oct 3
DataSourceChannelFactory (from dolphinscheduler-spi, loaded via PrioritySPIFactory) — creates DataSourceChannels for low-level connection handling.
DataSourceChannelFactory depends on DataSourceChannel
Holds
Read Oct 3
DbType enum lives in dolphinscheduler-spi.
DbType is in dolphinscheduler-spi
Holds
Read Oct 3
MasterServer — @SpringBootApplication, implements IStoppable.
2 rules from this sentence
MasterServer is annotated with SpringBootApplication
Holds
MasterServer implements IStoppable
Holds
Read Oct 3
MasterCoordinator extends AbstractHAServer and elects a leader via the registry.
MasterCoordinator extends AbstractHAServer
Holds
Read Oct 3
spi.plugin — PrioritySPI, SPIIdentify, PrioritySPIFactory.
3 rules from this sentence
PrioritySPI is in org.apache.dolphinscheduler.spi.plugin
Holds
SPIIdentify is in org.apache.dolphinscheduler.spi.plugin
Holds
PrioritySPIFactory is in org.apache.dolphinscheduler.spi.plugin
Holds
Read Oct 3
spi.datasource — DataSourceClient, BaseConnectionParam, DataSourceChannel, DataSourceChannelFactory.
4 rules from this sentence
DataSourceClient is in org.apache.dolphinscheduler.spi.datasource
Holds
BaseConnectionParam is in org.apache.dolphinscheduler.spi.datasource
Holds
DataSourceChannel is in org.apache.dolphinscheduler.spi.datasource
Holds
DataSourceChannelFactory is in org.apache.dolphinscheduler.spi.datasource
Holds
Read Oct 3
spi.enums — DbType, DbConnectType, Flag, ResourceType.
4 rules from this sentence
DbType is in org.apache.dolphinscheduler.spi.enums
Holds
DbConnectType is in org.apache.dolphinscheduler.spi.enums
Holds
Flag is in org.apache.dolphinscheduler.spi.enums
Holds
ResourceType is in org.apache.dolphinscheduler.spi.enums
Holds
Read Oct 3
spi.params — PluginParamsTransfer, InputParam, RadioParam, SelectParam, etc. Describe the UI form a plugin exposes to the frontend.
4 rules from this sentence
PluginParamsTransfer is in org.apache.dolphinscheduler.spi.params
Holds
InputParam is in org.apache.dolphinscheduler.spi.params
Holds
RadioParam is in org.apache.dolphinscheduler.spi.params
Holds
SelectParam is in org.apache.dolphinscheduler.spi.params
Holds
Read Oct 3
PrioritySPI — root marker interface for everything loaded via PrioritySPIFactory;
PrioritySPI is a contract
Holds
Read Oct 3
WorkerServer — @SpringBootApplication, implements IStoppable.
2 rules from this sentence
WorkerServer is annotated with SpringBootApplication
Holds
WorkerServer implements IStoppable
Holds
Read Oct 3
PhysicalTaskExecutorFactory builds a PhysicalTaskExecutor (lives in task-executor) around the task plugin (from task-plugin).
PhysicalTaskExecutorFactory depends on PhysicalTaskExecutor
Holds
46 rules from 10 docs

See these where the change is. The browser extension puts a pull request's doc findings, and a diagram of what it changed, on the GitHub page itself, so the code and what your docs say about it are side by side.