----- Original Message -----
From: "Nick Coghlan" <ncoghlan(a)redhat.com>
To: beaker-devel(a)lists.fedorahosted.org
Sent: Friday, October 25, 2013 10:26:16 AM
Subject: Re: [Beaker-devel] Current state of Beah's development and release process
On 10/23/2013 10:00 AM, Amit Saha wrote:
> Sounds fairly good to me. Are we also looking at *adding* additional
> documentation
> incrementally over time?
For beah? Maybe - we still have a few bugs for aspects of the harness
that aren't currently well documented.
I started the process of moving the Beah docs from beaker's repository to Beah's
and reorganizing the existing Beah docs.
The patch is here [1]. A new docs sub-directory is created under which Beah's current
and future docs will live. The existing docs which have been moved from the top-level
to this directory are in plain text format. New docs which have been written or moved
from beaker's repo are in reStructuredText. I believe we will want to publish all
docs
as HTML files? If yes, what path do we go down? Create a sphinx project? That said, the
TODO
and README files will need some reformatting so that we have a consistent format across
all the files.
Regarding the contents, the README files can be worked upon to create a fairly usable
user
guide and the TODO file is a good place to start as far as a roadmap is concerned.
Regarding publishing the contents (as hinted by Nick earlier), a "related
projects" page
will be setup on
beaker-project.org which will link to beah's docs and git repository
(and
over time will include other projects). How do we want to manage Beah's docs here? Do
we go down
the path of git submodules or is that too overly complicated for what we want here?
[1]
http://gerrit.beaker-project.org/#/c/2431/
Best,
Amit.
> Also, is there any way someone could independently use Beah outside of
> Beaker?
> Do we also envision and document such possible use cases in the
> documentation
> of the "related projects" ?
I don't think so (certainly not initially). There are better options
(like autotest or STAF) for Beaker independent test harnesses, and for
beaker-system-scan the intent is to push a lot of the elements of
broader interest down into lshw.
Cheers,
Nick.
--
Nick Coghlan
Red Hat Infrastructure Engineering & Development, Brisbane
Testing Solutions Team Lead
Beaker Development Lead (
http://beaker-project.org/)
_______________________________________________
Beaker-devel mailing list
Beaker-devel(a)lists.fedorahosted.org
https://lists.fedorahosted.org/mailman/listinfo/beaker-devel
--
Amit Saha <
http://echorand.me>
Infrastructure Engineering and Development
Red Hat, Inc.