cayenne-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Andrus Adamchik (JIRA)" <j...@apache.org>
Subject [jira] [Comment Edited] (CAY-1733) update docs
Date Wed, 26 Dec 2012 19:48:13 GMT

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

Andrus Adamchik edited comment on CAY-1733 at 12/26/12 7:46 PM:
----------------------------------------------------------------

I applied the latest patch (turned out the patches were against STABLE-3.1, while I was trying
to apply them to trunk). I also published 3.1 version to the live web site for http://markmail.org/message/uhxlqf6obz3gabql
, so that everyone could review it immediately. 

I have a few suggestions before we can close this Jira:

1. if possible add POM version number somewhere in the footer of both HTML and PDF (not sure
what's the best way to do variable substitution in dcobook plugin).
2. For SEO purposes would be cool to add <meta> tags to the HTML version header similar
to what we have for older docs:

E.g. http://cayenne.apache.org/docs/3.0/overview.html
<meta name="keywords" content="cayenne 3.0 documentation,...
<meta name="description" content="User documentation for Apache Cayenne version 3.0....

So hopefully if we have similar version-specific keywords in 3.1, Google and others will be
able to better identify which version of the docs a user is looking for.


Thanks!
                
      was (Author: andrus):
    I applied the latest patch (turned out the patches were against STABLE-3.1, while I was
trying to apply them to trunk). I also published 3.1 version to the live web site for http://markmail.org/message/uhxlqf6obz3gabql
, so that everyone could review it immediately. 

I have a few suggestions before we can close this Jira:

1. if possible add POM version number somewhere in the footer of both HTML and PDF (not sure
what's the best way to do variable substitution in dcobook plugin).
2. For SEO purposes would be cool to add <meta name="keywords" to the HTML version header
similar to what we have for older docs:

E.g. http://cayenne.apache.org/docs/3.0/overview.html
<meta name="keywords" content="cayenne 3.0 documentation,...

So hopefully if we have similar version-specific keywords in 3.1, Google and others will be
able to better identify which version of the docs a user is looking for.


Thanks!
                  
> update docs
> -----------
>
>                 Key: CAY-1733
>                 URL: https://issues.apache.org/jira/browse/CAY-1733
>             Project: Cayenne
>          Issue Type: Bug
>          Components: Documentation
>            Reporter: Olga Tkacheva
>            Assignee: Olga Tkacheva
>             Fix For: 3.1B2
>
>         Attachments: 0001-CAY-1733-update-docs-HTML-docs-updates.patch, 0001-CAY-1733-update-docs-HTML-docs-updates.patch,
0001-Fix-HTML.patch, 0001-Fix-PDF.patch, 0002-CAY-1733-update-docs-PDF-docs-updates.patch,
0002-Fix-PDF.patch, divs.png, Update Documents Patch.patch
>
>
> for pdf document: 
> - fix problem with tables (text goes beyond the page)
> - remove empty pages
> - add style to code 
> - update text style for document 
> for html:
> - update css, 
> - project structure (move css and image folders to index folder ( see /docs/docbook/cayenne-guide/target/site/index))

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira

Mime
View raw message