Closed hoavt closed 5 years ago
@hoavt It should be detailed, rather than listed. Specifies the function of each major configure.
@hoavt we can create example
directory, and put config.example.yaml
in it.
@hoavt It should be detailed, rather than listed. Specifies the function of each major configure.
Their function are mentioned in the configuration file. Why do we need to rewrite them anymore? When we have any changes in the config file, we don;t need to change the README file anymore.
it's expected that users should know how to use by referring docs, not the source code. Docs should explain in more details for what and why, which param is required, which is optional, what is the default value, etc.
examples are expected for different config types: variables, plugins, default and nodes, etc.
@hieptranquoc Please review, and add more examples for "default" and "variables". Moreover, which params need to be explained more, please help me to explain them. which param is required, which is optional...
@hieptranquoc Please review the new commit.
@hieptranquoc please review.
need to split the examples into the following example configs:
how to run and expected outcome and behavior should be explained.
connect #12
@hieptranquoc Please review this pr.