We've wrapped up our second Virtual Docs sprint, this time focusing on
charms.reactive.
General topics discussed:
- Monitoring Ask Ubuntu, Reddit, etc., for charms.reactive-related
questions. As an experiment, we've created an IFTTT applet to create new
issues in Github for new questions containing "charms.reactive" posted to
Ask Ubuntu. The hope is that this will draw attention to the question, and
lead to improvements in documentation.
- A CI/CD pipeline for docs. Whenever code changes, docs are at risk of
becoming outdated. It'd be nice to see some process, for example, where the
example code embedded in docs is tested with new check-ins.
- Style guides, and applying them in a lint-like fashion.
We opened and/or commented on 7 issues:
How to debug a reactive charm -
https://github.com/juju-solutions/charms.reactive/issues/118
Better charms.reactive.cli documentation -
https://github.com/juju-solutions/charms.reactive/issues/117
Better API documentation -
https://github.com/juju-solutions/charms.reactive/issues/116
Tests of example code in docs -
https://github.com/juju-solutions/charms.reactive/issues/115
Style Guide - https://github.com/juju-solutions/charms.reactive/issues/114
README.rst is outdated -
https://github.com/juju-solutions/charms.reactive/issues/113
Getting Started needs better charms.reactive coverage -
https://github.com/juju/docs/issues/1967
And one pull request:
Refactor "state" to "flag" -
https://github.com/juju-solutions/charms.reactive/pull/112
You can watch it here: https://www.youtube.com/watch?v=rS9hxsySfNA
Join us in two weeks (time TBD) where we'll be diving into conjure-up!
On Thu, Jun 29, 2017 at 5:50 PM Adam Israel
wrote:
> Hi all,
>
> Our second Virtual Docs Sprint is tomorrow from 18-19:00 GMT (14-15:00
> EDT). This will be a bi-weekly event where developers and users of Juju can
> get together to work on documentation for it's related projects.
>
> When: Jun 30th, at 18:00 GMT (14:00 EDT)
> Where: https://www.youtube.com/watch?v=rS9hxsySfNA
> How to participate: Hang out in the #juju Freenode IRC channel
>
> Join us in the IRC channel to contribute, ask questions, or just to listen
> in on the action.
>
> Make sure to subscribe to the Juju Youtube channel so you never miss any
> of the happenings in and around Juju!
>
> https://www.youtube.com/channel/UCSsoSZBAZ3Ivlbt_fxyjIkw
> --
> Adam Israel, Software Engineer
> Canonical // Cloud DevOps // Juju // Ecosystem
>
--
Adam Israel, Software Engineer
Canonical // Cloud DevOps // Juju // Ecosystem
--
Juju-dev mailing list
Juju-dev@lists.ubuntu.com
Modify settings or unsubscribe at:
https://lists.ubuntu.com/mailman/listinfo/juju-dev
