Merge EE docs #3759

andreyaksenov · 2023-10-06T08:57:38Z

Moved Enterprise documentation from a separate repo to the doc repo:
https://docs.d.tarantool.io/en/doc/merge-ee-docs/enterprise/

Note that this still PR doesn't include reference for closed source modules. A related issue will be fixed lately: https://github.com/tarantool/enterprise_doc/issues/245.

PR for redirects is in the tarantool.io repo: https://github.com/tarantool/tarantool.io/pull/1453. Should be merged AFTER this PR.

p7nov

LGTM 👍
I've got one general comment: let's maybe check and fix product names and abbreviations across the documentation?

Tarantool Enterprise Edition or Tarantool EE instead of Tarantool Enterprise
Tarantool Community Edition instead of open-source Tarantool and similar names.

p7nov · 2023-10-12T08:17:17Z

And what about site header menu items that lead to old location of EE docs? Both site header menu and documentation header menu.

andreyaksenov · 2023-10-12T08:21:44Z

And what about site header menu items that lead to old location of EE docs? Both site header menu and documentation header menu.

Here is the PR with redirects (still in progress): https://github.com/tarantool/tarantool.io/pull/1453. So, /enterprise_doc/ should be redirected to a new section.
I think, we can leave old EE links in Documentation drop-downs as is and update them later when restructuring docs.

p7nov · 2023-10-12T08:25:42Z

And what about site header menu items that lead to old location of EE docs? Both site header menu and documentation header menu.

Here is the PR with redirects (still in progress): tarantool/tarantool.io#1453. So, /enterprise_doc/ should be redirected to a new section. I think, we can leave old EE links in Documentation drop-downs as is and update them later when restructuring docs.

I'd ask devX team about updating the links to decrease the number of redirected requests. They can cause unnecessary load on the website.

andreyaksenov · 2023-10-12T09:49:22Z

I'd ask devX team about updating the links to decrease the number of redirected requests.

Fixed:
https://github.com/tarantool/tarantool.io/pull/1453/commits/e6f3342a356e7ad55b2f4381f56de8e2e7ef7744

xuniq

LGTM.

p7nov

Thanks for this impressive work!
Please find my notes about the wording and naming in comments.

p7nov · 2023-10-13T04:18:30Z

doc/book/admin/access_control.rst

@@ -90,7 +90,7 @@ There are two functions for managing passwords in Tarantool:

 *   :doc:`/reference/reference_lua/box_schema/user_password` returns a hash of a user's password.

-Tarantool Enterprise also allows you to improve database security by enforcing the use of strong passwords, setting up a maximum password age, and so on. Learn more from the `Access control <https://www.tarantool.io/en/enterprise_doc/security/#access-control>`__ section.
+Tarantool Enterprise Edition also allows you to improve database security by enforcing the use of strong passwords, setting up a maximum password age, and so on. Learn more from the :ref:`Access control <enterprise-access-control>` section.


Minor: Learn more from ... Access control ... - we're already in a section with this name :)

I hope, these section will be merged at some point )

p7nov · 2023-10-13T04:21:14Z

doc/enterprise/audit.rst

+Encryption of external iproto traffic
+-------------------------------------
+
+Tarantool Enterprise Edition uses the


Suggested change

Tarantool Enterprise Edition uses the

Tarantool uses the

Any Tarantool does this.

p7nov · 2023-10-13T04:24:13Z

doc/enterprise/audit.rst

+Security audit
+==============
+
+This document will help you audit the security of a Tarantool Enterprise Edition's cluster.


Possessive looks incorrect here. If Tarantool Enterprise Edition is a product name, then it should be in the simple form, just as Tarantool cluster, GridGain cluster (not Tarantool's cluster).

p7nov · 2023-10-13T04:25:44Z

doc/enterprise/audit_log.rst

+Audit module
+============
+
+The Tarantool audit module available in Tarantool Enterprise Edition writes messages that record Tarantool events in plain text, CSV, or JSON format.


Suggested change

The Tarantool audit module available in Tarantool Enterprise Edition writes messages that record Tarantool events in plain text, CSV, or JSON format.

The audit module available in Tarantool Enterprise Edition writes messages that record Tarantool events in plain text, CSV, or JSON format.

p7nov · 2023-10-13T04:30:42Z

doc/enterprise/changelog.rst

+Versioning policy
+-----------------
+
+A Tarantool Enterprise Edition's SDK version consists of two parts:


Not sure about this wording - Tarantool Enterprise Edition's SDK. Sounds a bit unnatural to me.
The old Tarantool Enterprise SDK sound better – it's not the same product (Tarantool EE), but a toolkit for creating application to work with it. Better to check with PMs.

p7nov · 2023-10-13T04:33:07Z

doc/reference/reference_rock/index.rst

@@ -18,4 +18,4 @@ This reference covers third-party Lua modules for Tarantool.
    other

 For Tarantool Enterprise modules, see the
-`Tarantool Enterprise documentation <https://www.tarantool.io/en/enterprise_doc/rocksref/>`_.
+:ref:`Tarantool Enterprise Edition <enterprise-rocks>` documentation.


Suggested change

:ref:`Tarantool Enterprise Edition <enterprise-rocks>` documentation.

:ref:`Tarantool EE <enterprise-rocks>` documentation.

Since we've already mentioned Enterprise explicitly in this sentence.

p7nov · 2023-10-13T04:33:22Z

doc/reference/reference_rock/other.rst

@@ -10,4 +10,4 @@ that is hosted externally -- mostly on GitHub pages or in READMEs:
 *   `tracing <https://github.com/tarantool/tracing/>`_

 For Tarantool Enterprise modules, see the
-`Tarantool Enterprise documentation <https://www.tarantool.io/en/enterprise_doc/rocksref/>`_.
+:ref:`Tarantool Enterprise Edition <enterprise-rocks>` documentation.


Suggested change

:ref:`Tarantool Enterprise Edition <enterprise-rocks>` documentation.

:ref:`Tarantool EE <enterprise-rocks>` documentation.

p7nov · 2023-10-13T05:16:31Z

doc/enterprise/read_views/c_api.rst

@@ -0,0 +1,274 @@
+.. _read_views_c_api:
+
+C API


Perhaps we need more specific names for C API and Lua API pages. Now they appear first in search results for "C API" and "Lua API" queries across all Tarantool docs, which doesn't seem right.

Definitely. Will rename to Read views: Lua API and Read views: C API for now. But, I hope they will be moved to box reference at some moment.

andreyaksenov force-pushed the merge-ee-docs branch 2 times, most recently from 71ffc47 to 98cee5c Compare October 6, 2023 12:00

andreyaksenov linked an issue Oct 6, 2023 that may be closed by this pull request

[Epic] Merging CE and EE documentation #3547

Closed

19 tasks

andreyaksenov force-pushed the merge-ee-docs branch 27 times, most recently from 0ee50d9 to 68401a0 Compare October 11, 2023 08:39

andreyaksenov marked this pull request as ready for review October 11, 2023 09:49

andreyaksenov requested review from p7nov and xuniq October 11, 2023 09:49

andreyaksenov force-pushed the merge-ee-docs branch 3 times, most recently from 6edef13 to 22e22ba Compare October 11, 2023 12:23

p7nov reviewed Oct 12, 2023

View reviewed changes

andreyaksenov force-pushed the merge-ee-docs branch from 7eeb2cd to c25377f Compare October 12, 2023 12:55

andreyaksenov requested a review from lastoCHka42 October 12, 2023 13:45

xuniq reviewed Oct 12, 2023

View reviewed changes

andreyaksenov force-pushed the merge-ee-docs branch 2 times, most recently from f83bb93 to 047096c Compare October 12, 2023 15:11

p7nov approved these changes Oct 13, 2023

View reviewed changes

p7nov reviewed Oct 13, 2023

View reviewed changes

andreyaksenov force-pushed the merge-ee-docs branch from 047096c to 7302bec Compare October 13, 2023 07:28

lastoCHka42 approved these changes Oct 16, 2023

View reviewed changes

andreyaksenov added 3 commits October 16, 2023 15:06

Merge EE docs

69f1896

Merge EE docs - update naming

9ca335d

Merge EE docs - update changelogs

fac4159

andreyaksenov force-pushed the merge-ee-docs branch from a8b2774 to fac4159 Compare October 16, 2023 12:06

andreyaksenov merged commit 0423ded into latest Oct 16, 2023

andreyaksenov deleted the merge-ee-docs branch October 16, 2023 12:08

	The Tarantool audit module available in Tarantool Enterprise Edition writes messages that record Tarantool events in plain text, CSV, or JSON format.
	The audit module available in Tarantool Enterprise Edition writes messages that record Tarantool events in plain text, CSV, or JSON format.

	:ref:`Tarantool Enterprise Edition <enterprise-rocks>` documentation.
	:ref:`Tarantool EE <enterprise-rocks>` documentation.

Merge EE docs #3759

Merge EE docs #3759

Uh oh!

Conversation

andreyaksenov commented Oct 6, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

p7nov left a comment

Choose a reason for hiding this comment

Uh oh!

p7nov commented Oct 12, 2023

Uh oh!

andreyaksenov commented Oct 12, 2023

Uh oh!

p7nov commented Oct 12, 2023

Uh oh!

andreyaksenov commented Oct 12, 2023

Uh oh!

xuniq left a comment

Choose a reason for hiding this comment

Uh oh!

p7nov left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

andreyaksenov commented Oct 6, 2023 •

edited

Loading