You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@kudu.apache.org by "Bankim Bhavsar (Code Review)" <ge...@cloudera.org> on 2021/05/16 04:57:48 UTC

[kudu-CR](branch-1.15.x) [docs][site] Add a note about Kudu version to doc pages.

Bankim Bhavsar has uploaded this change for review. ( http://gerrit.cloudera.org:8080/17456


Change subject: [docs][site] Add a note about Kudu version to doc pages.
......................................................................

[docs][site] Add a note about Kudu version to doc pages.

Kudu documentation is specific to a Kudu version and we release
updated docs for every release. However we don't make it explicit that
the documentation applies to a specific version of Kudu.

This change basically adds a note about the Kudu version to most
docs by including a common file named top.adoc. This include
file can be used in future for other cases where a snippet needs
to be added in multiple files.

The docs that were left out didn't seem to be version specific and
hence didn't include the version note.

This'll apply the note to docs created henceforth for new releases and
existing docs won't get the update. In order to update the existing
docs for prior releases we'll have to update them manually.

Screenshots:
https://drive.google.com/file/d/1Tbbmbkj8KkCbtktSPsShUOHrox9PP39j/view
https://drive.google.com/file/d/11gyYJgR3jhHqKX6mXpvW9GGfnhb9b4_7/view

Upcoming change updates the landing page of releases linking the
versioned docs.

Change-Id: Ie391f32dd27b3464569d12b5b553c4ab84a95130
Reviewed-on: http://gerrit.cloudera.org:8080/17438
Tested-by: Kudu Jenkins
Reviewed-by: Grant Henke <gr...@apache.org>
(cherry picked from commit 163799c385a1e69d281d8c33de9fdccc64bf4b6d)
---
M docs/administration.adoc
M docs/background_tasks.adoc
M docs/command_line_tools_reference.adoc
M docs/configuration.adoc
M docs/configuration_reference.adoc
M docs/hive_metastore.adoc
M docs/installation.adoc
M docs/known_issues.adoc
M docs/metrics_reference.adoc
M docs/schema_design.adoc
M docs/security.adoc
M docs/support/scripts/make_docs.sh
M docs/support/scripts/make_site.sh
A docs/top.adoc
M docs/transaction_semantics.adoc
M docs/troubleshooting.adoc
16 files changed, 79 insertions(+), 3 deletions(-)



  git pull ssh://gerrit.cloudera.org:29418/kudu refs/changes/56/17456/1
-- 
To view, visit http://gerrit.cloudera.org:8080/17456
To unsubscribe, visit http://gerrit.cloudera.org:8080/settings

Gerrit-Project: kudu
Gerrit-Branch: branch-1.15.x
Gerrit-MessageType: newchange
Gerrit-Change-Id: Ie391f32dd27b3464569d12b5b553c4ab84a95130
Gerrit-Change-Number: 17456
Gerrit-PatchSet: 1
Gerrit-Owner: Bankim Bhavsar <ba...@cloudera.com>

[kudu-CR](branch-1.15.x) [docs][site] Add a note about Kudu version to doc pages.

Posted by "Alexey Serbin (Code Review)" <ge...@cloudera.org>.
Alexey Serbin has posted comments on this change. ( http://gerrit.cloudera.org:8080/17456 )

Change subject: [docs][site] Add a note about Kudu version to doc pages.
......................................................................


Patch Set 1: Code-Review+2


-- 
To view, visit http://gerrit.cloudera.org:8080/17456
To unsubscribe, visit http://gerrit.cloudera.org:8080/settings

Gerrit-Project: kudu
Gerrit-Branch: branch-1.15.x
Gerrit-MessageType: comment
Gerrit-Change-Id: Ie391f32dd27b3464569d12b5b553c4ab84a95130
Gerrit-Change-Number: 17456
Gerrit-PatchSet: 1
Gerrit-Owner: Bankim Bhavsar <ba...@cloudera.com>
Gerrit-Reviewer: Alexey Serbin <as...@cloudera.com>
Gerrit-Reviewer: Bankim Bhavsar <ba...@cloudera.com>
Gerrit-Reviewer: Grant Henke <gr...@apache.org>
Gerrit-Reviewer: Kudu Jenkins (120)
Gerrit-Comment-Date: Mon, 17 May 2021 23:47:04 +0000
Gerrit-HasComments: No

[kudu-CR](branch-1.15.x) [docs][site] Add a note about Kudu version to doc pages.

Posted by "Bankim Bhavsar (Code Review)" <ge...@cloudera.org>.
Bankim Bhavsar has submitted this change and it was merged. ( http://gerrit.cloudera.org:8080/17456 )

Change subject: [docs][site] Add a note about Kudu version to doc pages.
......................................................................

[docs][site] Add a note about Kudu version to doc pages.

Kudu documentation is specific to a Kudu version and we release
updated docs for every release. However we don't make it explicit that
the documentation applies to a specific version of Kudu.

This change basically adds a note about the Kudu version to most
docs by including a common file named top.adoc. This include
file can be used in future for other cases where a snippet needs
to be added in multiple files.

The docs that were left out didn't seem to be version specific and
hence didn't include the version note.

This'll apply the note to docs created henceforth for new releases and
existing docs won't get the update. In order to update the existing
docs for prior releases we'll have to update them manually.

Screenshots:
https://drive.google.com/file/d/1Tbbmbkj8KkCbtktSPsShUOHrox9PP39j/view
https://drive.google.com/file/d/11gyYJgR3jhHqKX6mXpvW9GGfnhb9b4_7/view

Upcoming change updates the landing page of releases linking the
versioned docs.

Change-Id: Ie391f32dd27b3464569d12b5b553c4ab84a95130
Reviewed-on: http://gerrit.cloudera.org:8080/17438
Tested-by: Kudu Jenkins
Reviewed-by: Grant Henke <gr...@apache.org>
(cherry picked from commit 163799c385a1e69d281d8c33de9fdccc64bf4b6d)
Reviewed-on: http://gerrit.cloudera.org:8080/17456
Reviewed-by: Alexey Serbin <as...@cloudera.com>
---
M docs/administration.adoc
M docs/background_tasks.adoc
M docs/command_line_tools_reference.adoc
M docs/configuration.adoc
M docs/configuration_reference.adoc
M docs/hive_metastore.adoc
M docs/installation.adoc
M docs/known_issues.adoc
M docs/metrics_reference.adoc
M docs/schema_design.adoc
M docs/security.adoc
M docs/support/scripts/make_docs.sh
M docs/support/scripts/make_site.sh
A docs/top.adoc
M docs/transaction_semantics.adoc
M docs/troubleshooting.adoc
16 files changed, 79 insertions(+), 3 deletions(-)

Approvals:
  Kudu Jenkins: Verified
  Alexey Serbin: Looks good to me, approved

-- 
To view, visit http://gerrit.cloudera.org:8080/17456
To unsubscribe, visit http://gerrit.cloudera.org:8080/settings

Gerrit-Project: kudu
Gerrit-Branch: branch-1.15.x
Gerrit-MessageType: merged
Gerrit-Change-Id: Ie391f32dd27b3464569d12b5b553c4ab84a95130
Gerrit-Change-Number: 17456
Gerrit-PatchSet: 2
Gerrit-Owner: Bankim Bhavsar <ba...@cloudera.com>
Gerrit-Reviewer: Alexey Serbin <as...@cloudera.com>
Gerrit-Reviewer: Bankim Bhavsar <ba...@cloudera.com>
Gerrit-Reviewer: Grant Henke <gr...@apache.org>
Gerrit-Reviewer: Kudu Jenkins (120)