devel Charm Docs are out of date and examples do not work

Bug #1604586 reported by Jeff Lane 
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Canonical Juju
Fix Released
High
Unassigned

Bug Description

I'm trying to learn how to write a charm, and right off the bat, the docs are out of date for devel and do not work.

For instance:

https://jujucharms.com/docs/devel/authors-charm-writing

States at the top that "Juju 2.0 is currently in beta which is updated frequently. We don’t recommend using it for production deployments."

And that's fine, I want to write it for juju 2.0.

But the docs are based on precise (I want to write for xenial as it's Juju 2.0) and the first instructions don't work. The example says:

Create a bare bones charm with Charm Tools

Using the charm tools plugin, we can create the directory structure we need for our charm quickly and easily:

juju charm create vanilla

But that command fails:
ubuntu@home:~/development/charms/xenial$ juju charm create vanilla
error: unrecognized command: charm create

one must now use charm-create, but that creates an entirely different filesystem than what the example tells me to expect.

Anyway, the docs seem to be written for an older version of Juju than 2.0, even though I am reading the devel level docs for 2.0, and are highly confusing.

Jeff Lane  (bladernr)
summary: - Charm Docs are out of date and don't work
+ devel Charm Docs are out of date and examples do not work
Revision history for this message
Richard Harding (rharding) wrote :

https://jujucharms.com/docs/devel/developer-getting-started is the getting starting guide in the 2.0 docs. The authors-charm-writing

We'll be pulling the other page when the 2.0 docs are setup as the default which is in progress atm.

Changed in juju-core:
status: New → In Progress
assignee: nobody → Richard Harding (rharding)
affects: juju-core → juju
Curtis Hovey (sinzui)
Changed in juju:
importance: Undecided → High
Changed in juju:
status: In Progress → Triaged
assignee: Richard Harding (rharding) → nobody
milestone: none → 2.1.0
Revision history for this message
Anastasia (anastasia-macmood) wrote :

This has been fixed with recent Juju 2.x releases.

Changed in juju:
status: Triaged → Fix Committed
Curtis Hovey (sinzui)
Changed in juju:
status: Fix Committed → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.