Code review comment for lp:~fginther/ubuntu-ci-services-itself/usage-doc-updates

Revision history for this message
Francis Ginther (fginther) wrote :

> On Thu, Mar 13, 2014 at 5:24 PM, Francis Ginther <
> <email address hidden>> wrote:
>
> > +* Download a source package of interest
> > +
> > +.. code-block:: none
> > +
> > + apt-get download <package_name>
> > +
> >
>
> This only works if the user is on saucy I believe. Are we guaranteed that
> all users will be on saucy?

Correct. There are some deeper assumptions in setting up an environment for creating source packages. I'm now considering removing this. If I can't concisely describe the setup in a handful of steps, then it really doesn't belong in this document. Better documentation for generating source packages exists elsewhere, I should just link to that.

> +Ubuntu CI Engine requests, known as tickets, are created through a command
> > line
> > +interface.
> > +
> > +.. code-block:: none
> > +
> > + python ubuntu-ci create_ticket -t "Ticket name" -d "Ticket description"
> > -b 123 -o <email address hidden> -a "foo,bar" -r "baz" -s
> > /full/path/to/_source.changes -s /full/path/to/_source.changes
> >
> >
> If the CLI is actually packaged, I don't believe they would need the
> 'python' portion of the command. How are we handling the ~/.ubuntu-ci
> requirement? Unless it's shipped and ready to go with the package, we need
> to document something about it.

Good point. I need to mention the ~/.ubuntu-ci file because it's not part of the package and needs to be configured based on the deployed system the user is interacting with.

« Back to merge proposal