Update Docs #132
Update Docs #132
Conversation
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
|
|
||
| --- | ||
|
|
||
| ### Benefit |
| ```yaml | ||
| tasks: | ||
| greet: | ||
| help: Print a greeting |
There was a problem hiding this comment.
please add also the args section for this example
| compile: | ||
| hooks: | ||
| pre-run: | ||
| - task: clean |
There was a problem hiding this comment.
add to the example the post-run hook.
also the name of the task should be in the format <group>.<task>, when it is called inside the hooks.
| daily-clean: | ||
| task: build.clean | ||
| schedule: "0 0 * * *" | ||
| ``` |
There was a problem hiding this comment.
add some commands with the cron/scheduler
|
|
||
| If you need to deploy a project to a remote server: | ||
|
|
||
| ```yaml |
There was a problem hiding this comment.
the config file here is not necessary.
you can point just to the spec documentation, something like:
If you want more details about Remote Execution, please check the spec documentation (and the link for the documentation).
it is similar to ansible or fabric (add links to that as well)
| using YAML instead of Makefiles, it makes task definition more readable and | ||
| maintainable, improving developer productivity and CI/CD efficiency. | ||
|
|
||
| Start using Makim today to streamline your project automation! |
| ```yaml | ||
| hooks: | ||
| pre-run: | ||
| - task: <task_name> |
There was a problem hiding this comment.
add into the spec and example the entry for if
| env: | ||
| API_KEY: abc123 | ||
| ``` | ||
|
|
There was a problem hiding this comment.
add a note at the end, the value should be always a string.
if the developer needs to pass an integer, it should be between quotes.
| - 3.10 | ||
| os: | ||
| - ubuntu | ||
| - macos] |
There was a problem hiding this comment.
| - macos] | |
| - macos |
|
|
||
| ### Description | ||
|
|
||
| Defines scheduled tasks using cron syntax. |
There was a problem hiding this comment.
add a link for more details about cron syntax
There was a problem hiding this comment.
add also an explanation for the cron syntax
| host: example.com | ||
| port: 22 | ||
| ``` | ||
|
|
There was a problem hiding this comment.
add into the spec and example about the remote entry inside task.
| @@ -0,0 +1,264 @@ | |||
| # Makim Specification | |||
There was a problem hiding this comment.
it is missing more details about vars, and env-file.
also for each item/topic, state what scopes is supported by that yaml entry
Solves #80