[
https://issues.apache.org/jira/browse/SOLR-10296?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16001527#comment-16001527
]
Hoss Man commented on SOLR-10296:
---------------------------------
Checkpoint: Cassandra and I (mostly cassandra) have been working on a lot of
this since friday morning.
Here's where "things left todo" stand AFAICT....
* we've manually added some TODO comments to the source where we punted on
decisisons while working through the docs - those are going to need some
discussion
* there was a conveniently timed PDF plugin update over the weekend that solved
a lot of the table issues for us so that the formatting is fine for now -- but
one thing we still need to address is the column widths so that the tables are
readable
** we also need to remove the automatically generated TODO comments saying that
those tables need fixed
* the "hard coded" table of contents should have all been cleaned up, but
there's a new issue in SOLR-10612 about some auto-generated TOC cleanup we want
to do
* I think cassandra still needs to commit some of the non-image attachments
(ie: SVGs) from cwiki?
* links should all be fixed - so we should be free and clear to bulk remove the
OLD_CONFLUENCE_ID comments in all the source files
* I think we still need to audit the list of pages mentioned here for BR
cleanup: https://github.com/ctargett/refguide-asciidoc-poc/issues/31
* excerpt / excerpt-include decisions
* i'd like to sanity check the output of this grep command to make sure we
don't have any code blocks that are going to be syntax highlighted in a totally
nonsense manner...{code}
grep -A4 '\[source,.*\]' src/*.adoc
{code}
> Convert existing Ref Guide and post-conversion cleanup
> ------------------------------------------------------
>
> Key: SOLR-10296
> URL: https://issues.apache.org/jira/browse/SOLR-10296
> Project: Solr
> Issue Type: Sub-task
> Security Level: Public(Default Security Level. Issues are Public)
> Components: documentation
> Reporter: Cassandra Targett
>
> We have developed several tools and scripts for converting the Ref Guide out
> of Confluence which get us most of the way to a fully converted set of pages.
> However, we already know that there are several issues that could not be
> automated.
> From https://github.com/ctargett/refguide-asciidoc-poc/issues/27, we have
> this list:
> * The conversion process will insert TODOs for several items that we thought
> might be problematic during conversion; these need to be reviewed and
> resolved. Some of these items are also covered in the below topics.
> * Block elements in tables. The current version of the PDF creation tool we
> are using does not handle those properly (see
> https://github.com/ctargett/refguide-asciidoc-poc/issues/13). In some cases,
> we should remove the table entirely and present the content in a new way
> (using, most often, [labled
> lists|http://asciidoctor.org/docs/user-manual/#labeled-list] instead).
> * Review and (usually) remove huge Tables of Contents from the top of pages.
> The current design of the online version will automatically create a TOC for
> the page, we don't need another one and in some cases this TOC was
> hand-created so can't be removed via conversion.
> * Non-image attachments. Some SVG files will be converted to images, but they
> should not be treated as images.
> * Failed link conversions. Despite my best attempts, many dummy URLs are
> treated by Confluence as real URLs (meaning, dummy URLs like
> {{http://<host>:<port>/solr}} are coded in Confluence's XHTML with <a> tags).
> These will be converted as URLs but will throw errors during the conversion
> process. In some cases, the URLs aren't just these example URLs but are
> indicative of a real problem that needs to be resolved.
> * Spurious <br/> tags. Some API pages have a list of available calls
> structured as a list but without being a real ordered or unordered list.
> These will convert badly. The issue
> https://github.com/ctargett/refguide-asciidoc-poc/issues/31 has a list of
> pages where this might be a problem.
> * Appropriate Lead Paragraphs. The stylesheet for HTML pages will make the
> first paragraph of every HTML page a slightly larger font, by way of
> introduction. In many cases, the first paragraph is not really ready for that
> sort of treatment and should be revised to be a more succinct introduction to
> the feature or further contents of the page.
> More problems may be added to this issue as items that specifically need to
> be cleaned up.
--
This message was sent by Atlassian JIRA
(v6.3.15#6346)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
