Commit Graph

10 Commits

Author SHA1 Message Date
John Russell
da89330823 IMPALA-4431: [DOCS] Document max_audit_event_log_files startup option
Change-Id: I6777624e2139fdc062efaa778063e89e7d6d5772
Reviewed-on: http://gerrit.cloudera.org:8080/7369
Reviewed-by: Tim Armstrong <tarmstrong@cloudera.com>
Tested-by: Impala Public Jenkins
2017-07-07 05:48:21 +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
7683838707 [DOCS] 'CM' cleanup for logging page
An ID contained 'cm' so it could show up in grep reports.
Revise the ID, and associated <keydef> tag.

Change-Id: I05c56eb4c98338200ec58098709855ed847c219d
Reviewed-on: http://gerrit.cloudera.org:8080/6370
Reviewed-by: Ambreen Kazi <ambreen.kazi@cloudera.com>
Reviewed-by: John Russell <jrussell@cloudera.com>
Tested-by: Impala Public Jenkins
2017-03-13 21:58:42 +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
Laurel Hale
b48bdaa9b7 IMPALA-3401 [DOCS] Phase 5 of "Cloudera Manager" removal.
Most of these fixes entailed hiding the
paragraph where there are mentions of CM and
writing a replacement paragraph for the upstream
docs. This removes the CM references from the
rendered docs. A subsequent cleanup project will
remove occurrences of CM from the XML. This patch
includes fixes to files in response to John
Russell's first set of review comments.

Change-Id: I4967fae275a8822274aece14a15107237445aba5
Reviewed-on: http://gerrit.cloudera.org:8080/6070
Reviewed-by: John Russell <jrussell@cloudera.com>
Tested-by: Impala Public Jenkins
2017-03-02 23:01:10 +00:00
John Russell
8b417c6921 IMPALA-3401: [DOCS] Remove blocks of content devoted to CM
Change-Id: I07d56463939fe152c1c6124cc0ad5591337bad6b
Reviewed-on: http://gerrit.cloudera.org:8080/6179
Reviewed-by: Ambreen Kazi <ambreen.kazi@cloudera.com>
Tested-by: Impala Public Jenkins
Reviewed-by: John Russell <jrussell@cloudera.com>
2017-03-01 22:49:32 +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
John Russell
c4ee03a7e5 IMPALA-3401: Suppress blocks of content devoted to Cloudera Manager.
Initial experiment to see how the doc looks & builds when the biggest,
most obvious pieces of Cloudera Manager-related content are suppressed:
- Primarily entire subtopics.
- In some cases, individual notes, paragraphs, and list items.
- Also the CM reference in the reused "cancel" text which showed up
  many times throughout the SQL syntax section.

Just hiding in the output for now, rather than removing from source,
because we might find there's generic material we need to hoist out of
the CM-related subtopics.

Was planning to use audience="hidden" to hide, but since that CR hasn't
landed in master yet, still using audience="Cloudera" for the moment,
and will switch attribute values later.
A little rewording of titles and suppressing smaller elements such as
paragraphs where the CM aspect didn't apply to the entire subtopic.

Change-Id: Ic799f77bc758a1cf40c53fa412bf02d852901a69
Reviewed-on: http://gerrit.cloudera.org:8080/5607
Reviewed-by: Jim Apple <jbapple-impala@apache.org>
Tested-by: John Russell <jrussell@cloudera.com>
2017-01-05 23:55:45 +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