Skip to content

📖 Docs: The Full Configuration Examples Need to be Added to the Plugin Documentations #941

@daniel-hutao

Description

@daniel-hutao

What should be changed?

A long time ago, we had only one configuration file, in a format that probably looked like below:

tools:
  foo: bar

So at that time, the configuration examples given in our plugin documentations are the same as above.

But now the configuration file has been split into 3 parts: core config, var config and tools config. So when a user opens one of our plugin documents and sees the example like below, he won't know how to apply it.

image

I think all the plugin documentations about the configuration examples should be changed to like below:

---
# core config
varFile: "" # If not empty, use the specified external variables config file
toolFile: "" # If not empty, use the specified external tools config file
state: # state config, backend can be local or s3
  backend: local
  options:
    stateFile: devstream.state

---
# variables config
foo: bar

---
# plugins config
tools:
  - name: foo
    instanceID: default
    options:
      fkk: [[ foo ]]

Please read the documents below.

Metadata

Metadata

Assignees

Labels

bugSomething isn't workingdocumentationImprovements or additions to documentation

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions