Re: [jira] [Commented] (JENA-1755) Improve documentation of Query Builders

[Andy Seaborne]

On 11/09/2019 19:42, Claude Warren wrote:

I was just speaking to infra about this. Will write more in depth later.
But we should think about how we want to work.

I favor adding the specific docs to src/site and working from there but I
am certain there are lots of opinions here.

I don't know what that means. Could you expand that a bit please?

    Andy

Claude

On Wed, Sep 11, 2019, 08:35 Andy Seaborne (Jira) <j...@apache.org> wrote:

     [
https://issues.apache.org/jira/browse/JENA-1755?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16927696#comment-16927696
]

Andy Seaborne commented on JENA-1755:
-------------------------------------

And we need to think about migrating to e.g. Jekyll.

I think that new services from INFRA means we can setup a job to automate
the website staging.

[
https://cwiki.apache.org/confluence/display/INFRA/.asf.yaml+features+for+git+repositories
]

"automate web site builds using pelican (and other systems)"

I haven't had time to dig into the details.

Improve documentation of Query Builders
---------------------------------------

                 Key: JENA-1755
                 URL: https://issues.apache.org/jira/browse/JENA-1755
             Project: Apache Jena
          Issue Type: Improvement
            Reporter: Jan Martin Keil
            Priority: Major

As discussed in JENA-1751, I propose to improve the documentation of the

query builders:

{quote}Unfortunately, I did not find (and I think there isn't) any

documentation or tutorial about the query builders explaining more than the
very basics. Also the JavaDoc (which is to the best of my knowledge nowhere
linked on [https://jena.apache.org/]), is, in my experience, not helpful
and makes it often necessary to look into the code to understand what is
needed and maybe find out how to get it. If I did not miss a comprehensive
documentation somewhere, I think it would be worth, to improve
documentation. Even a few words at the builder classes (mentioning e.g.
ExprFactory) and small examples at the more complicated methods would help
a lot.

{quote}

--
This message was sent by Atlassian Jira
(v8.3.2#803003)