[docs] restructure releases section (#11621)

(With a LOT of broken-link fixes, too)
yugabyte · Mar 3, 2022 · 3a82b2b · 3a82b2b
1 parent 31e154c
commit 3a82b2b
Show file tree

Hide file tree

Showing 372 changed files with 4,695 additions and 5,271 deletions.
diff --git a/docs/config.yaml b/docs/config.yaml
@@ -3,7 +3,6 @@ baseurl: https://docs.yugabyte.com
 languageCode: en-us
 title: YugabyteDB Docs
 metadataformat: yaml
-canonifyurls: false
 googleAnalytics: UA-104956980-3
 pygmentsCodefences: true
 pygmentsStyle: "pygments"

diff --git a/docs/content/latest/_index.html b/docs/content/latest/_index.html
@@ -7,12 +7,6 @@
 weight: 1
 ---
 
-{{< note title="New release versioning" >}}
-
-Starting with v2.2.0, Yugabyte release versions follow a [new release versioning convention](/latest/releases/versioning). The latest release series, denoted by `MAJOR.ODD`, incrementally introduces new features and changes and is intended for development and testing only. Patch releases, denoted by `MAJOR.ODD.PATCH` versioning, can include new features and changes that might break backwards compatibility. For more information, see [Releases overview](/latest/releases/releases-overview).
-
-{{< /note >}}
-
 <div class="row">
 
   <div class="col-12 col-md-6">
@@ -136,7 +130,7 @@
   </div>
 
    <div class="col-12 col-md-6">
-    <a class="section-link icon-offset" href="integrations/apache-kafka">
+    <a class="section-link icon-offset" href="integrations/apache-kafka/">
       <div class="head">
         <img class="icon" src="/images/section_icons/develop/ecosystem-integrations.png" aria-hidden="true" />
         <div class="title">Integrations</div>
@@ -308,7 +302,7 @@
   </div> -->
 
   <div class="col-12 col-md-6">
-    <a class="section-link icon-offset" href="/latest/contribute/">
+    <a class="section-link icon-offset" href="contribute/">
       <div class="head">
         <img class="icon" src="/images/section_icons/index/introduction.png" aria-hidden="true" />
         <div class="title">Get involved</div>

diff --git a/docs/content/latest/admin/_index.md b/docs/content/latest/admin/_index.md
@@ -15,7 +15,7 @@ menu:
 
 {{< note title="Note" >}}
 
-Information about configuring the [YB-Master](../reference/configuration/yb-master) and [YB-TServer](../reference/configuration/yb-tserver) services is in the [Configuration](../reference/configuration/) section.
+Information about configuring the [YB-Master](../reference/configuration/yb-master/) and [YB-TServer](../reference/configuration/yb-tserver/) services is in the [Configuration](../reference/configuration/) section.
 
 {{< /note >}}
 

diff --git a/docs/content/latest/admin/yb-admin.md b/docs/content/latest/admin/yb-admin.md
@@ -1755,7 +1755,7 @@ The time needed to complete a data move depends on the following:
 
 {{< /note >}}
 
-For an example of performing a data move and the use of this command, refer to [Change cluster configuration](../../manage/change-cluster-config).
+For an example of performing a data move and the use of this command, refer to [Change cluster configuration](../../manage/change-cluster-config/).
 
 **Example**
 

diff --git a/docs/content/latest/admin/yb-ctl.md b/docs/content/latest/admin/yb-ctl.md
@@ -146,7 +146,7 @@ For details and examples, see [Create a local cluster with custom flags](#create
 
 **Example**
 
-To enable [YSQL authentication](../../secure/enable-authentication/ysql), you can use the `--tserver_flags` flag to add the `yb-tserver` [`--ysql_enable-auth`](../yb-tserver/#ysql-enable-auth) flag to the `yb-ctl create | start | restart` commands.
+To enable [YSQL authentication](../../secure/enable-authentication/ysql/), you can use the `--tserver_flags` flag to add the `yb-tserver` [`--ysql_enable-auth`](../yb-tserver/#ysql-enable-auth) flag to the `yb-ctl create | start | restart` commands.
 
 ```sh
 $./bin/yb-ctl create --tserver_flags "ysql_enable_auth=true"
@@ -487,7 +487,7 @@ $ ./bin/yb-ctl restart
 - Restart with cloud, region and zone flags
 
 ```sh
-$ ./bin/yb-ctl restart --placement_info "cloud1.region1.zone1" 
+$ ./bin/yb-ctl restart --placement_info "cloud1.region1.zone1"
 ```
 
 ### Restart with custom flags
@@ -536,7 +536,7 @@ $ ./bin/yb-ctl wipe_restart
 #### Wipe and restart with placement info flags
 
 ```sh
-$ ./bin/yb-ctl wipe_restart --placement_info "cloud1.region1.zone1" 
+$ ./bin/yb-ctl wipe_restart --placement_info "cloud1.region1.zone1"
 ```
 
 #### Wipe and restart with custom flags

diff --git a/docs/content/latest/admin/yb-ts-cli.md b/docs/content/latest/admin/yb-ts-cli.md
@@ -12,7 +12,7 @@ isTocNested: true
 showAsideToc: true
 ---
 
-`yb-ts-cli` is a command line tool that can be used to perform an operation on a particular tablet server (`yb-tserver`). Some of the commands perform operations similar to [`yb-admin` commands](../yb-admin). The `yb-admin` commands focus on cluster administration, the `yb-ts-cli` commands apply to specific YB-TServer nodes.
+`yb-ts-cli` is a command line tool that can be used to perform an operation on a particular tablet server (`yb-tserver`). Some of the commands perform operations similar to [`yb-admin` commands](../yb-admin/). The `yb-admin` commands focus on cluster administration, the `yb-ts-cli` commands apply to specific YB-TServer nodes.
 
 `yb-ts-cli` is a binary file installed with YugabyteDB and is located in the `bin` directory of the YugabyteDB home directory.
 

diff --git a/docs/content/latest/admin/ysql-dump.md b/docs/content/latest/admin/ysql-dump.md
@@ -15,7 +15,7 @@ showAsideToc: true
 
 `ysql_dump` is a utility for backing up a YugabyteDB database into a plain-text, SQL script file. `ysql_dump` makes consistent backups, even if the database is being used concurrently. `ysql_dump` does not block other users accessing the database (readers or writers).
 
-`ysql_dump` only dumps a single database. To backup global objects that are common to all databases in a cluster, such as roles, use [`ysql_dumpall`](../ysql-dumpall).
+`ysql_dump` only dumps a single database. To backup global objects that are common to all databases in a cluster, such as roles, use [`ysql_dumpall`](../ysql-dumpall/).
 
 Dumps are output in plain-text, SQL script files. Script dumps are plain-text files containing the SQL statements required to reconstruct the database to the state it was in at the time it was saved. To restore from such a script, import it using the [`ysqlsh \i`](../ysqlsh/#-i-filename-include-filename) command. Script files can be used to reconstruct the database even on other machines and other architectures; with some modifications, even on other SQL database products.
 
@@ -295,7 +295,7 @@ This utility also uses the environment variables supported by `libpq`.
 
 ## Diagnostics
 
-`ysql_dump` internally executes `SELECT` statements. If you have problems running `ysql_dump`, make sure you are able to select information from the database using, for example, [`ysqlsh`](../ysqlsh). Also, any default connection settings and environment variables used by the `libpq` front-end library will apply.
+`ysql_dump` internally executes `SELECT` statements. If you have problems running `ysql_dump`, make sure you are able to select information from the database using, for example, [`ysqlsh`](../ysqlsh/). Also, any default connection settings and environment variables used by the `libpq` front-end library will apply.
 
 The database activity of `ysql_dump` is normally collected by the statistics collector. If this is undesirable, you can set parameter `track_counts` to `false` using `PGOPTIONS` or the [`ALTER USER`](../../api/ysql/the-sql-language/statements/dcl_alter_user) statement.
 
@@ -351,5 +351,5 @@ $ ysql_dump -T 'ts_*' mydb > objects_mydb.sql
 
 ## See also
 
-- [ysql_dumpall](../ysql-dumpall)
-- [ysqlsh](../ysqlsh)
+- [ysql_dumpall](../ysql-dumpall/)
+- [ysqlsh](../ysqlsh/)
diff --git a/docs/content/latest/admin/ysql-dumpall.md b/docs/content/latest/admin/ysql-dumpall.md
@@ -13,7 +13,7 @@ isTocNested: true
 showAsideToc: true
 ---
 
-`ysql_dumpall` is a utility for writing out (“dumping”) all YugabyteDB databases of a cluster into one plain-text, SQL script file. The script file contains SQL statements that can be used as input to `ysqlsh` to restore the databases. It does this by calling [`ysql_dump`](../ysql-dump) for each database in the YugabyteDB cluster. `ysql_dumpall` also dumps global objects that are common to all databases, such as database roles. (`ysql_dump` does not export roles.)
+`ysql_dumpall` is a utility for writing out (“dumping”) all YugabyteDB databases of a cluster into one plain-text, SQL script file. The script file contains SQL statements that can be used as input to `ysqlsh` to restore the databases. It does this by calling [`ysql_dump`](../ysql-dump/) for each database in the YugabyteDB cluster. `ysql_dumpall` also dumps global objects that are common to all databases, such as database roles. (`ysql_dump` does not export roles.)
 
 Because `ysql_dumpall` reads tables from all databases, you will most likely have to connect as a database superuser in order to produce a complete dump. Also, you will need superuser privileges to execute the saved script in order to be allowed to add roles and create databases.
 
@@ -76,7 +76,7 @@ Specify the superuser username to use when disabling triggers. This is relevant
 
 #### -v, --verbose
 
-Specifies verbose mode. This will cause `ysql_dumpall` to output start and stop times to the dump file, and progress messages to standard error. It will also enable verbose output in [`ysql_dump`](../ysql-dump).
+Specifies verbose mode. This will cause `ysql_dumpall` to output start and stop times to the dump file, and progress messages to standard error. It will also enable verbose output in [`ysql_dump`](../ysql-dump/).
 
 #### --version, -V
 
@@ -216,7 +216,7 @@ This utility also uses the environment variables supported by `libpq`.
 
 ## Notes
 
-- Since `ysql_dumpall` calls [`ysql_dump`](../ysql-dump) internally, some diagnostic messages will refer to `ysql_dump`.
+- Since `ysql_dumpall` calls [`ysql_dump`](../ysql-dump/) internally, some diagnostic messages will refer to `ysql_dump`.
 - The [`-c|--clean`](#c-clean) option can be useful even when your intention is to restore the dump script into a fresh cluster. Use of `-c|--clean` authorizes the script to drop and recreate the built-in `yugabyte`, `postgres`, and `template1` databases, ensuring that those databases will retain the same properties (for instance, locale and encoding) that they had in the source cluster. Without the option, those databases will retain their existing database-level properties, as well as any pre-existing contents.
 - Once restored, it is wise to run `ANALYZE` on each database so the optimizer has useful statistics. You can also run `vacuumdb -a -z` to analyze all databases.
 - The dump script should not be expected to run completely without errors. In particular, because the script will issue `CREATE ROLE` statements for every role existing in the source cluster, it is certain to get a `role already exists` error for the bootstrap superuser, unless the destination cluster was initialized with a different bootstrap superuser name. This error is harmless and should be ignored. Use of the [`-c|--clean`](#c-clean) option is likely to produce additional harmless error messages about non-existent objects, although you can minimize those by adding [`--if-exists`](#if-exists).
@@ -239,5 +239,5 @@ It is not important to which database you connect here since the script file cre
 
 ## See Also
 
-- [ysql_dump](../ysql-dump)
-- [ysqlsh](../ysqlsh)
+- [ysql_dump](../ysql-dump/)
+- [ysqlsh](../ysqlsh/)
diff --git a/docs/content/latest/admin/ysqlsh.md b/docs/content/latest/admin/ysqlsh.md
@@ -44,7 +44,7 @@ If you prefer, you can install a standalone version using any of the following m
 - Using a shell script:
 
     ```sh
-    wget -q -O - https://downloads.yugabyte.com/get_clients.sh | sh 
+    wget -q -O - https://downloads.yugabyte.com/get_clients.sh | sh
     yugabyte*/bin/ysqlsh
     ```
 
@@ -264,9 +264,9 @@ Set the record separator for unaligned output to a zero byte. This is useful for
 
 ##### -1, --single-transaction
 
-This option can only be used in combination with one or more `-c` and/or `-f` options. It causes `ysqlsh` to issue a [`BEGIN`](../../api/ysql/the-sql-language/statements/txn_begin) statement before the first such option and a [`COMMIT`](../../api/ysql/the-sql-language/statements/txn_commit) statement after the last one, thereby wrapping all the commands into a single transaction. This ensures that either all the commands complete successfully, or no changes are applied.
+This option can only be used in combination with one or more `-c` and/or `-f` options. It causes `ysqlsh` to issue a [`BEGIN`](../../api/ysql/the-sql-language/statements/txn_begin/) statement before the first such option and a [`COMMIT`](../../api/ysql/the-sql-language/statements/txn_commit) statement after the last one, thereby wrapping all the commands into a single transaction. This ensures that either all the commands complete successfully, or no changes are applied.
 
-If the statements themselves contain [`BEGIN`](../../api/ysql/the-sql-language/statements/txn_begin), [`COMMIT`](../../api/ysql/the-sql-language/statements/txn_commit), or [`ROLLBACK`](../../api/ysql/the-sql-language/statements/txn_rollback), this option will not have the desired effects. Also, if an individual statement cannot be executed inside a transaction block, specifying this option will cause the whole transaction to fail.
+If the statements themselves contain [`BEGIN`](../../api/ysql/the-sql-language/statements/txn_begin/), [`COMMIT`](../../api/ysql/the-sql-language/statements/txn_commit), or [`ROLLBACK`](../../api/ysql/the-sql-language/statements/txn_rollback), this option will not have the desired effects. Also, if an individual statement cannot be executed inside a transaction block, specifying this option will cause the whole transaction to fail.
 
 ##### -?, --help[=*topic*]
 
@@ -1150,7 +1150,7 @@ The specially treated variables are:
 
 ##### AUTOCOMMIT
 
-When `on` (the default), each SQL statement is automatically committed upon successful completion. To postpone commit in this mode, you must enter a [`BEGIN`](../../api/ysql/the-sql-language/statements/txn_begin) or [`START TRANSACTION`](../../api/ysql/the-sql-language/statements/) SQL statement. When `off` or unset, SQL statements are not committed until you explicitly issue `COMMIT` or `END` statements. The autocommit-off mode works by issuing an implicit `BEGIN` for you, just before any statement that is not already in a transaction block and is not itself a `BEGIN` or other transaction-control statement, nor a statement that cannot be executed inside a transaction block (such as `VACUUM`).
+When `on` (the default), each SQL statement is automatically committed upon successful completion. To postpone commit in this mode, you must enter a [`BEGIN`](../../api/ysql/the-sql-language/statements/txn_begin/) or [`START TRANSACTION`](../../api/ysql/the-sql-language/statements/) SQL statement. When `off` or unset, SQL statements are not committed until you explicitly issue `COMMIT` or `END` statements. The autocommit-off mode works by issuing an implicit `BEGIN` for you, just before any statement that is not already in a transaction block and is not itself a `BEGIN` or other transaction-control statement, nor a statement that cannot be executed inside a transaction block (such as `VACUUM`).
 
 {{< note title="Note" >}}
 
@@ -1186,7 +1186,7 @@ The current client character set encoding. This is set every time you connect to
 
 ##### FETCH_COUNT
 
-If this variable is set to an integer value greater than `0` (zero), the results of [`SELECT`](../../api/ysql/the-sql-language/statements/dml_select) queries are fetched and displayed in groups of that many rows, rather than the default behavior of collecting the entire result set before display. Therefore, only a limited amount of memory is used, regardless of the size of the result set. Settings of `100` to `1000` are commonly used when enabling this feature. Keep in mind that when using this feature, a query might fail after having already displayed some rows.
+If this variable is set to an integer value greater than `0` (zero), the results of [`SELECT`](../../api/ysql/the-sql-language/statements/dml_select/) queries are fetched and displayed in groups of that many rows, rather than the default behavior of collecting the entire result set before display. Therefore, only a limited amount of memory is used, regardless of the size of the result set. Settings of `100` to `1000` are commonly used when enabling this feature. Keep in mind that when using this feature, a query might fail after having already displayed some rows.
 
 {{< note title="Tip" >}}
 
@@ -1349,7 +1349,7 @@ The port number at which the database server is listening.
 
 ##### %n
 
-The database session user name. (The expansion of this value might change during a database session as the result of the [`SET SESSION AUTHORIZATION`](../../api/ysql/the-sql-language/statements/dcl_set_session_authorization) statement.)
+The database session user name. (The expansion of this value might change during a database session as the result of the [`SET SESSION AUTHORIZATION`](../../api/ysql/the-sql-language/statements/dcl_set_session_authorization/) statement.)
 
 ##### %/
 
@@ -1361,7 +1361,7 @@ Like `%/`, but the output is `~` (tilde) if the database is your default databas
 
 ##### %#
 
-If the session user is a database superuser, then a `#`, otherwise a `>`. (The expansion of this value might change during a database session as the result of the [`SET SESSION AUTHORIZATION`](../../api/ysql/the-sql-language/statements/dcl_set_session_authorization) statement.)
+If the session user is a database superuser, then a `#`, otherwise a `>`. (The expansion of this value might change during a database session as the result of the [`SET SESSION AUTHORIZATION`](../../api/ysql/the-sql-language/statements/dcl_set_session_authorization/) statement.)
 
 ##### %p
 
@@ -1516,7 +1516,7 @@ testdb=> \d my_table
  Column |  Type   | Collation | Nullable | Default
 --------+---------+-----------+----------+---------
  first  | integer |           | not null | 0
- second | text    |           |          | 
+ second | text    |           |          |
 ```
 
 Now you change the prompt to something more interesting:
@@ -1611,7 +1611,7 @@ When suitable, query results can be shown in a crosstab representation with the
 
 ```plpgsql
 testdb=> SELECT first, second, first > 2 AS gt2 FROM my_table;
- first | second | gt2 
+ first | second | gt2
 -------+--------+-----
      1 | one    | f
      2 | two    | f
@@ -1620,11 +1620,11 @@ testdb=> SELECT first, second, first > 2 AS gt2 FROM my_table;
 (4 rows)
 
 testdb=> \crosstabview first second
- first | one | two | three | four 
+ first | one | two | three | four
 -------+-----+-----+-------+------
-     1 | f   |     |       | 
-     2 |     | f   |       | 
-     3 |     |     | t     | 
+     1 | f   |     |       |
+     2 |     | f   |       |
+     3 |     |     | t     |
      4 |     |     |       | t
 (4 rows)
 ```
@@ -1636,7 +1636,7 @@ testdb=> SELECT t1.first as "A", t2.first+100 AS "B", t1.first*(t2.first+100) as
 testdb(> row_number() over(order by t2.first) AS ord
 testdb(> FROM my_table t1 CROSS JOIN my_table t2 ORDER BY 1 DESC
 testdb(> \crosstabview "A" "B" "AxB" ord
- A | 101 | 102 | 103 | 104 
+ A | 101 | 102 | 103 | 104
 ---+-----+-----+-----+-----
  4 | 404 | 408 | 412 | 416
  3 | 303 | 306 | 309 | 312