hbase-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Misty Stanley-Jones (JIRA)" <j...@apache.org>
Subject [jira] [Updated] (HBASE-11155) Fix Validation Errors in Ref Guide
Date Thu, 15 May 2014 03:16:36 GMT

     [ https://issues.apache.org/jira/browse/HBASE-11155?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]

Misty Stanley-Jones updated HBASE-11155:
----------------------------------------

    Attachment: HBASE-11155.patch

I apologize in advance but this one is a bit ugly. Every change I made was for the sake of
DTD validity. Most of them are boring and cumulative and do not change the presentation of
the content much if at all. Here are some notable exceptions:

1. The Coprocessors chapter was duplicated in chapter 11 and 18 of the output. I removed the
latter instance.

2. The output generated by the hbase-default.xml had no fallback content, which caused local
validation to fail. I created fallback content which should never display on the site, but
is part of the xi:include in the configuration.xml chapter.

3. In #2 above, I had to add a bunch of IDs that are referenced various places in the guide
and break if the hbase-default.xml content is not present. This is a bad hack and will need
to be maintained if other references to content in that file are added. A better option would
be to have the Jenkins job commit a built hbase-default.xml file from its output and use that
as fallback content. I await guidance.

4. In a few places, I had to add IDs or delete xrefs to IDs that were broken. We can put them
back as demand requires. They were already broken and nobody squawked.

I tested building with this patch applied and it didn't break anything. Despite the length
it does only represent work done for this JIRA.

> Fix Validation Errors in Ref Guide
> ----------------------------------
>
>                 Key: HBASE-11155
>                 URL: https://issues.apache.org/jira/browse/HBASE-11155
>             Project: HBase
>          Issue Type: Bug
>          Components: documentation
>    Affects Versions: 0.98.2
>            Reporter: Misty Stanley-Jones
>            Assignee: Misty Stanley-Jones
>         Attachments: HBASE-11155.patch
>
>
> Before I do serious documentation work, I have to fix all of the validation errors that
are somehow not causing the Ref Guide to break the builds. I will attach one patch per file
-- that's the easiest way I know how to do it. I will try not to make any content changes,
only validation changes.



--
This message was sent by Atlassian JIRA
(v6.2#6252)

Mime
View raw message