[
https://issues.apache.org/jira/browse/PDFBOX-3030?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15018437#comment-15018437
]
John Hewson commented on PDFBOX-3030:
-------------------------------------
Some thoughts on this:
- I'd rather not see this in the 2.0 migration guide, because that gives the
impression that this is somehow a 2.0 issue, but it affects 1.8 too. We could
add a new Troubleshooting page for this and the other frequent pitfalls (JPEG
2000, JBIG2, applet security, font cache).
- Don't use alert-warning in the middle of text, it's for banners at the top
off pages only.
- Please include the "This is an unreleased development preview and may change
without notice." warning banner at the top of all the new 2.0 pages: Migration
Guide, Cookbook, Command Line tools. With RC's now released its important to
manage expectations.
- Add anchors for each of the headings in the migration guide so we can link
directly to them from emails, etc.
- Make sure that Getting Started and Dependencies are the first two items under
"2.0.0. (trunk)" in the tree - these are the first thing that new (and
therefore the most confused) users want.
> Enhance documentation for PDFBox 2.0.0
> --------------------------------------
>
> Key: PDFBOX-3030
> URL: https://issues.apache.org/jira/browse/PDFBOX-3030
> Project: PDFBox
> Issue Type: Task
> Components: Documentation
> Affects Versions: 2.0.0
> Reporter: Maruan Sahyoun
> Assignee: Maruan Sahyoun
> Attachments: TGH-16862c48-6b0b-410e-8fc6-b1d9f4418ecc.htm
>
>
> Task to track enhancements to the documentation or website as part of PDFBox
> 2.0.0
> - update javadoc (current as of writing)
> - migration guide
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
