-
Notifications
You must be signed in to change notification settings - Fork 31
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
0.3.0 release documentation #376
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Check out what you get with the site when you run hugo server
, it'll make my comments about the weight and slugs make more sense.
|
||
## Release Date | ||
|
||
Unreleased, scheduled for the week of 10/17/2016. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
let's use ISO8601 syntax throughout for clarity. 2016-10-17
main: | ||
parent: "release-notes" | ||
identifier: 0.2.0 | ||
weight: 80 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
probably don't need a weight here or in the other one. We're fine with sorting by reverse publish date.
@@ -0,0 +1,44 @@ | |||
--- | |||
title: "0.2.0" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
looks like we need a "slug" field here too since it has a dot. slug: "0-2-0"
will do the trick
@@ -0,0 +1,58 @@ | |||
--- | |||
title: "0.3.0" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
slug: "0-3-0"
menu: | ||
main: | ||
identifier: release-notes | ||
weight: 20 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This probably should go below the module reference. What do you think?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit picks! 🐞
|
||
### Module Improvements | ||
|
||
RPM package install/uninstall support has been added via [\#373](https://github.com/asteris-llc/converge/pull/373). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
what's the backslash here?
wait queries, named locks, and the ability to use lists and maps in parameters. The internal API has | ||
also been simplified to make it easier for programmers to create new modules. | ||
|
||
### Module Improvements |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"RPM Resource" would be a better subhead
|
||
#### Node Metadata | ||
|
||
Initial support for adding metadata to graph nodes was added via [\#369](https://github.com/asteris-llc/converge/pull/369). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this is not a user facing change yet. It will be in the next release when we get better errors, names, etc out of it. But maybe it shouldn't be in the release notes?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll remove it.
|
||
Initial support for adding metadata to graph nodes was added via [\#369](https://github.com/asteris-llc/converge/pull/369). | ||
|
||
#### Conditional Waits |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
waits are not conditional, unless they're in a switch
|
||
## Examples | ||
## Examples/Documentation |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
passive voice should be fixed in this section
...
I mean, paragraphs in this section should be in the active voice.
555ebcf
to
4d57855
Compare
#### Task Groups | ||
|
||
Tasks can be assigned to a group to force multiple tasks to run | ||
one at a time instead of in parallel. Locks are added as a node in the graph and released |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this is slightly out of date with the latest implementation. locks are no longer nodes in the graph; instead we just ensure all nodes in the group are dependent on another node in the group.
Before 0.3.0 release tag:
cmd/version.go