Uploaded image for project: 'IMPALA'
  1. IMPALA
  2. IMPALA-5140

clean up markdown, make slight improvements to doc building howto

    Details

    • Type: Improvement
    • Status: Resolved
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: Impala 2.9.0
    • Fix Version/s: Impala 2.9.0
    • Component/s: Docs
    • Labels:

      Description

      I was trying to build our docs and had trouble. I went looking for docs-for-docs and noticed some improvements that could be made. This Jira is about fixing them.

        Activity

        Hide
        mikesbrown Michael Brown added a comment -
        commit 75cca8a90b05b733653e31fe0791791c5616d78e
        Author: Michael Brown <mikeb@cloudera.com>
        Date:   Tue Mar 21 13:10:51 2017 -0700
        
            IMPALA-5140: improve docs building guidelines
        
            Move docs/generatingImpalaDoc.md to docs/README.md. This will
            automatically render the document inline at places like:
        
            https://github.com/apache/incubator-impala/tree/master/docs
        
            under the directory listing.
        
            Fix existing markdown which wasn't always rendering properly. Remove
            unneeded HTML and backslashes. Add a mention of make, and add one
            troubleshooting tip. Wrap most lines at 90 chars. This does not change
            how Github renders the markdown, and it makes reading the source easier
            as well.
        
            Explain how to get dita into PATH.
        
            Emphasize make and remove some of the dita advanced usage.
        
            Change-Id: I71ae79ecd346045697fe225140ee9a317c5a337f
            Reviewed-on: http://gerrit.cloudera.org:8080/6512
            Reviewed-by: Jim Apple <jbapple-impala@apache.org>
            Tested-by: Michael Brown <mikeb@cloudera.com>
        
        Show
        mikesbrown Michael Brown added a comment - commit 75cca8a90b05b733653e31fe0791791c5616d78e Author: Michael Brown <mikeb@cloudera.com> Date: Tue Mar 21 13:10:51 2017 -0700 IMPALA-5140: improve docs building guidelines Move docs/generatingImpalaDoc.md to docs/README.md. This will automatically render the document inline at places like: https://github.com/apache/incubator-impala/tree/master/docs under the directory listing. Fix existing markdown which wasn't always rendering properly. Remove unneeded HTML and backslashes. Add a mention of make, and add one troubleshooting tip. Wrap most lines at 90 chars. This does not change how Github renders the markdown, and it makes reading the source easier as well. Explain how to get dita into PATH. Emphasize make and remove some of the dita advanced usage. Change-Id: I71ae79ecd346045697fe225140ee9a317c5a337f Reviewed-on: http://gerrit.cloudera.org:8080/6512 Reviewed-by: Jim Apple <jbapple-impala@apache.org> Tested-by: Michael Brown <mikeb@cloudera.com>

          People

          • Assignee:
            mikesbrown Michael Brown
            Reporter:
            mikesbrown Michael Brown
          • Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development