Commit Graph

16 Commits

Author SHA1 Message Date
Jim Apple
edc70c1661 Impala is graduating; remove outdated references to incubation
Change-Id: I4e6080a2b196926e46b1e641f6530ba1fa9bd444
Reviewed-on: http://gerrit.cloudera.org:8080/8577
Reviewed-by: Sailesh Mukil <sailesh@cloudera.com>
Tested-by: Impala Public Jenkins
2017-11-16 22:31:38 +00:00
John Russell
d565386b24 [DOCS] Fill in release note subtopics for Apache Impala 2.10
Primarily just pointing to the list of issues in the changelog.
Those cover the different use cases for the different parts
of the release notes -- fixed issues, new features, and
incompatible changes.

Change-Id: Ide38c1e1c64dac287b180b39ebb8e7735d457ce3
Reviewed-on: http://gerrit.cloudera.org:8080/7958
Reviewed-by: Michael Brown <mikeb@cloudera.com>
Tested-by: Impala Public Jenkins
2017-09-26 18:44:19 +00:00
John Russell
4b54df8cd3 IMPALA-4803: [DOCS] 2.9 release notes placeholder
Change-Id: I636a6f2dcd0555ab9b46304e3a7298c598a511da
Reviewed-on: http://gerrit.cloudera.org:8080/6964
Reviewed-by: Michael Brown <mikeb@cloudera.com>
Tested-by: Impala Public Jenkins
2017-05-23 22:55:52 +00:00
John Russell
68f32e52bc IMPALA-4643: [DOCS] Change URLs / set up keydefs for JIRA reports
In addition to switching URLs for individual JIRAs
to point to issues.apache.org, also construct alternative
URLs for JIRA reports (usually 1 per release, summarizing
the issues fixed in that release).

There is some inconsistency in which releases have associated
JIRA reports. For releases where we never published a link to
a JIRA report, I added a <keydef> tag that could be used to
construct a report in future, but didn't fill in any URL.

Some releases do have a link to a JIRA report in the release
notes, however the report is empty. Possibly there was some
strangeness around the release process for those, or there
could be some missing info in the JIRA system. I just
transcribed the links in those cases and didn't try to
reconstruct the history to debug the empty reports.

Change-Id: I007e634f9da57289674683dd5bf64e3e3ca8f525
Reviewed-on: http://gerrit.cloudera.org:8080/6515
Reviewed-by: Laurel Hale <laurel@cloudera.com>
Reviewed-by: Michael Brown <mikeb@cloudera.com>
Tested-by: Impala Public Jenkins
2017-04-06 16:56:41 +00:00
John Russell
5deec604de IMPALA-4643: [DOCS] Rewrite issues.cloudera.org URLs
Update all URLs in *keydefs* file that point to
issues.cloudera.org.

Update all <xref> tags in the doc source that point
to individual JIRA issues on issues.cloudera.org.
(Leave alone links pointing to JIRA reports; those
don't seem to be redirected currently.)

Change-Id: I9ad2725e4afedddedf8ba65963b217803f532dea
Reviewed-on: http://gerrit.cloudera.org:8080/6452
Reviewed-by: Laurel Hale <laurel@cloudera.com>
Reviewed-by: Michael Brown <mikeb@cloudera.com>
Reviewed-by: John Russell <jrussell@cloudera.com>
Tested-by: Impala Public Jenkins
2017-03-21 22:01:36 +00:00
John Russell
69ba44c706 [DOCS] Rewrite github URL for timezone source file
Use the corresponding Apache github URL instead of
the Cloudera one.

Change-Id: I40bff9286d08f1de11abd9ab4b804855f0330cc2
Reviewed-on: http://gerrit.cloudera.org:8080/6438
Reviewed-by: Jim Apple <jbapple-impala@apache.org>
Reviewed-by: Laurel Hale <laurel@cloudera.com>
Tested-by: Impala Public Jenkins
2017-03-20 21:19:04 +00:00
John Russell
d4b0b56822 [DOCS] Remove obsolete commented stuff from impala_fixed_issues
The impala_fixed_issues page included commented
lists of JIRAs including URLs of non-public
Google docs prepared by the CCE team. Take 'em out.

Also in one case where 'CDH' was intentionally left in
the topic of a subtitle, 'CDH' can still be removed from
the cause/workaround text.

Change-Id: I4383811dc25ebd1c326cbd1e12a985848da3abb5
Reviewed-on: http://gerrit.cloudera.org:8080/6390
Reviewed-by: Ambreen Kazi <ambreen.kazi@cloudera.com>
Reviewed-by: John Russell <jrussell@cloudera.com>
Tested-by: Impala Public Jenkins
2017-03-14 18:22:32 +00:00
John Russell
d9602df71b IMPALA-4643: [DOCS] Phase 2 of genericizing cloudera.com links
Get rid of cloudera.com URLs within the topics/*.xml source files.

Abstract any that need to remain (e.g. blog posts) into impala_keydefs
file for easy examining and editing.

After this change, the number of source/artifact references to CDH and
Cloudera is small enough that we can enumerate exceptions and start the endgame:

Cleanup items remaining in XML source files:
grep -EiI "[^a-zA-Z]cm[^a-zA-Z]|cdh|cloudera" *.xml |
  grep -v issues.cloudera.org | wc -l
282
Cleanup items remaining in HTML output files:
grep -EiI "[^a-zA-Z]cm[^a-zA-Z]|cdh|cloudera" ../build/html/topics/*.html |
  grep -v issues.cloudera.org | wc -l
148

(These numbers will go down further when the 'installing' and 'updating'
edits land in master.)

Change-Id: I9e29c0feec7bd8e974d8a3d1eb84abe757514be7
Reviewed-on: http://gerrit.cloudera.org:8080/6345
Reviewed-by: John Russell <jrussell@cloudera.com>
Tested-by: Impala Public Jenkins
2017-03-13 23:49:56 +00:00
John Russell
0467b0d54a IMPALA-3401: [DOCS] Physically remove Cloudera Manager info
Followup from Laurel's code reviews, to physically
remove references to Cloudera Manager that were hidden.

Remove a few stray instances of Cloudera Manager that I found
still remaining in the source.

Fix up trailing spaces introduced during earlier
Cloudera Manager-related edits.

Also remove stray 'Cloudera' references, or stale/commented
Cloudera-specific info, noticed near other spots being edited.

Change-Id: Ifc4a84527ae42c39b3717190b6cf669e17fff04b
Reviewed-on: http://gerrit.cloudera.org:8080/6325
Reviewed-by: Ambreen Kazi <ambreen.kazi@cloudera.com>
Reviewed-by: John Russell <jrussell@cloudera.com>
Tested-by: Impala Public Jenkins
2017-03-09 23:27:53 +00:00
John Russell
18927ac852 [DOCS] Wide-ranging cleanup of CDH and Cloudera references
Genericize 3-part version numbers in "known issues".

Genericize CDH version numbers in 'ports' topic.

Genericize 'Cloudera' and hostnames in 'Tables' topic.

Genericize the version numbers in 'added in' blurbs.

Remove lots of CDH / Impala notices from release notes.

Remove obsolete conref'able elements that weren't
actually being called from anywhere, that contained
CDH version number wording.

Reword 'Cloudera recommends'.

Remove more hidden or commented material with
Cloudera-specific wording.

Remove obsolete CDH references from 'incompatible changes'.

Change 'cloudera' HDFS username for LOAD DATA examples.

Remove material related to big lists of CDH fixed JIRAs.
Genericize some CDH-related language.

Change-Id: Iaa5db6c20f4d010972ade4945a3ea59b32ef95de
Reviewed-on: http://gerrit.cloudera.org:8080/6267
Reviewed-by: Ambreen Kazi <ambreen.kazi@cloudera.com>
Reviewed-by: John Russell <jrussell@cloudera.com>
Tested-by: Impala Public Jenkins
2017-03-08 22:40:19 +00:00
Laurel Hale
6f837118b8 IMPALA-3401 [DOCS] Phase 6 of "Cloudera Manager" removal
Removed references to "Cloudera Manager" mostly by hiding the
paragraphs that contained the references and rewriting them
for the upstreams docs without referencing CM. This removes
the references in the rendered docs, but does not remove
them from the source XML. That part of the removal will be
done in a subsequent work item.

Change-Id: I3a5ae82ee5adfd1e2f250bc4dc26e45047dc434c
Reviewed-on: http://gerrit.cloudera.org:8080/6083
Reviewed-by: John Russell <jrussell@cloudera.com>
Tested-by: Impala Public Jenkins
2017-03-07 22:25:25 +00:00
John Russell
0ad55ba5a9 IMPALA-3402: [DOCS] Remove/reword all CDH 4 references
Along the way, remove nearby references to CDH 5
and especially the CDH version numbers in the
'Fixed Issues' titles. The fixed issues titles
are not amenable to the keydef/keyref substitution
technique because they are all 3-part numbers
like Impala 2.2.1 that don't have substitution
variables defined for them.

Change-Id: I9ffb400a244930134705b0f0039087506f5e70d3
Reviewed-on: http://gerrit.cloudera.org:8080/6146
Reviewed-by: John Russell <jrussell@cloudera.com>
Tested-by: Impala Public Jenkins
2017-03-02 21:05:01 +00:00
John Russell
1e73d7fc31 [DOCS] Construct "fixed issues" topic for 2.8 release notes
Primarily a link to the relevant JIRA report,
sorted in descending order of priority.

Change-Id: I7033c61dafb2dbaf4f05a687bed3bd53883a6ff4
Reviewed-on: http://gerrit.cloudera.org:8080/6125
Reviewed-by: John Russell <jrussell@cloudera.com>
Tested-by: Impala Public Jenkins
2017-02-24 00:11:09 +00:00
John Russell
8377b9949c Global search/replace: audience="Cloudera" -> audience="hidden".
For this change to land in master, the audience="hidden" code review
needs to be completed first. Otherwise, the doc build would still work
but the audience="hidden" content would be visible rather than hidden as
desired.

Some work happening in parallel might introduce additional instances of
audience="Cloudera". I suggest addressing those in a followup CR so this
global change can land quickly.

Since the changes apply across so many different files, but are so
narrow in scope, I suggest that the way to validate (check that no
extraneous changes were introduced accidentally) is to diff just the
changed lines:

git diff -U0 HEAD^ HEAD

In patch set 2, I updated other topics marked audience="Cloudera"
by CRs that were pushed in the meantime.

Change-Id: Ic93d89da77e1f51bbf548a522d98d0c4e2fb31c8
Reviewed-on: http://gerrit.cloudera.org:8080/5613
Reviewed-by: John Russell <jrussell@cloudera.com>
Tested-by: Impala Public Jenkins
2017-01-18 19:31:57 +00:00
Jim Apple
d484d2f684 Add Apache license header to files in doc directory
This now gives a clean RAT check with bin/check-rat-report.py, which
is one way for the Impala community to check compliance with ASF rules
on intellectual property.

Change-Id: I2ad06435f84a65ba126759e42a18fdaf52cd7036
Reviewed-on: http://gerrit.cloudera.org:8080/5232
Reviewed-by: Jim Apple <jbapple-impala@apache.org>
Tested-by: Impala Public Jenkins
Reviewed-by: John Russell <jrussell@cloudera.com>
2016-12-02 23:54:32 +00:00
Jim Apple
3be0f122a5 IMPALA-3398: Add docs to main Impala branch.
These are refugees from doc_prototype. They can be rendered with the
DITA Open Toolkit version 2.3.3 by:

/tmp/dita-ot-2.3.3/bin/dita \
  -i impala.ditamap \
  -f html5 \
  -o $(mktemp -d) \
  -filter impala_html.ditaval

Change-Id: I8861e99adc446f659a04463ca78c79200669484f
Reviewed-on: http://gerrit.cloudera.org:8080/5014
Reviewed-by: John Russell <jrussell@cloudera.com>
Tested-by: John Russell <jrussell@cloudera.com>
2016-11-17 22:38:44 +00:00