[teiid-dev] standalone-teiid.xml and docs in general
Steven Hawkins
shawkins at redhat.com
Tue Dec 20 20:59:44 EST 2011
It's not so much that the docs are referencing the config file in expecting it to be documented, rather it's the docs describe editing that file (which is clearly more difficult if all elements/attributes are not present). So what we actually need to do is modify the documentation to not reference standalone-teiid.xml at all, but rather how to make modifications through the CLI, correct?
----- Original Message -----
> Steve,
>
> It is not possible to self documenting this file, as this gets
> overwritten every time there is a configuration change. However, the
> configuration elements are forced to have description in the code,
> which
> can be seen by querying the subsystem using CLI. So, any tools
> written
> above the CLI api can get access to this information.
>
> We should remove any references in docs to see this file for
> explanations.
>
> Ramesh..
>
> On Tue, 2011-12-20 at 12:50 -0500, Steven Hawkins wrote:
> > Should the standalone-teiid.xml be self-documenting and include all
> > known elements/attributes? In carrying forward
> > https://issues.jboss.org/browse/TEIID-1873 the security doc
> > reference elements/attributes that aren't in the file.
> >
> > As we are close to our first alpha any help in updating the docs
> > would be great.
> >
> > Steve
> >
> > _______________________________________________
> > teiid-dev mailing list
> > teiid-dev at lists.jboss.org
> > https://lists.jboss.org/mailman/listinfo/teiid-dev
>
>
>
More information about the teiid-dev
mailing list