Skip to content

Make documentation more friendly for new users #1078

@vankoven

Description

@vankoven

Configuration file format is not going to be stabilised until 1.0 or higher versions, but our wiki pages can fit only master release. We need to update the documentation and add the following:

  • Add 'Available from: VERSION' to all directives to indicate which minimal version must be used for the directive. E.g. directive vhost was introduced in 0.6 release, but not accessible in 0.5 release.

  • Deprecated directives and behaviour. As long as some directives are added, others are removed. E.g. http_sched_rules directive is deprecated and replaced by http_chain in 0.6 release.

  • Specify the scope for every directive. E.g. cache_bypass may be listed out of any directive blocks, inside vhost block and inside location block.

  • Add configuration examples for common presets or common use cases for every directive. Especially implicit diractives.

  • Move to per-release documentation if documentation is too complicated due to tons of new and deprecated directives, too different use cases and it's worth to form unique documentation for every release. Exact implementation is TBD

Metadata

Metadata

Assignees

No one assigned

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions