Skip to content

Improve Documentation on JSON String Format for Job Configuration #313

@grasmarcussanti129

Description

@grasmarcussanti129

Issue

The README mentions that a job should be presented as a JSON string representation but does not provide a clear example of how to format it correctly. Clear examples are essential for users to implement the configuration accurately.

Suggested Improvement

Add a detailed example in the documentation that illustrates the expected JSON string format for different scenarios. For example:

'{ "php": "7.4", "extensions": ["mbstring", "curl"], "ini": ["memory_limit=-1"], "dependencies": "latest" }'

Benefit

This enhancement will help new users to quickly grasp how to configure their jobs, reducing the risk of misconfigurations and improving user experience.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions