Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs site for v2.1.0-alpha.20180730 release #3422

Merged
merged 1 commit into from
Jul 30, 2018

Conversation

jseldess
Copy link
Contributor

Raw notes. Still need to be edited.

@cockroach-teamcity
Copy link
Member

This change is Reviewable

@jseldess
Copy link
Contributor Author

@nvanbenschoten, please add any additional notes here, with linked PRs.

@nvanbenschoten
Copy link
Member

Thanks @jseldess. The one important perf improvement that I missed was.

Transactional writes are now pipelined when being replicated and when being written to disk, dramatically reducing the latency of transactions that perform multiple writes. This can be disabled using a new "kv.transaction.write_pipelining_enabled" cluster setting.

@jseldess jseldess force-pushed the v2.1-alpha.20180730-release-notes branch from eab11a3 to b20d49b Compare July 30, 2018 12:01
@jseldess jseldess changed the title [WIP] Update docs site for v2.1.0-alpha.20180730 release Update docs site for v2.1.0-alpha.20180730 release Jul 30, 2018
@jseldess jseldess force-pushed the v2.1-alpha.20180730-release-notes branch from b20d49b to 9214176 Compare July 30, 2018 12:20
### Enterprise Edition Changes

- Core dumps are now disabled and [encryption](../v2.1/encryption.html) is enabled. [#27426][#27426]
- [`CHANGEFEED`](../v2.1/change-data-capture.html)s now use an asynchronous Kafka producer, increasing throughput. [#27421][#27421]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would suggest putting the plural "s" between the brackets:

- [`CHANGEFEED`s](...) now use ...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

- The `pg_get_indexdef()` built-in function now supports 3 arguments. [#27161][#27161] {% comment %}doc{% endcomment %}
- Added `COPY` support to `IMPORT .. . PGDUMP`. [#27062][#27062] {% comment %}doc{% endcomment %}
- The new `max_row_size` option overrides default limits on line size for `IMPORT ... PGDUMP` and `PGCOPY`. [#27062][#27062] {% comment %}doc{% endcomment %}
- The `SHOW TRACE FOR <stmt>` statement was incomplete and incorrect and has thus been removed. To use tracing, use `SET tracing = ...` and `SHOW SESSION TRACE` instead. [#26729][#26729] {% comment %}doc{% endcomment %}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps also make a cross-reference to the corresponding CLI change (auto_trace).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

- The word `view` is now supported as an identifier like in PostgreSQL. [#27204][#27204] {% comment %}doc{% endcomment %}
- `IMPORT ... PGDUMP` no longer requires the `--no-owner` flag. [#27268][#27268] {% comment %}doc{% endcomment %}
- `AS OF SYSTEM TIME` can now use some more complex expressions to compute the desired timestamp. [#27206][#27206] {% comment %}doc{% endcomment %}
- Added support for the `convert_from()` and `convert_to()` built-in functions, for compatibility with PostgreSQL. For `convert_from()`, however, in contrast with PostgreSQL, the function in CockroachDB accepts `NUL` in the input, because null characters are valid in CockroachDB strings. [#27328][#27328] {% comment %}doc{% endcomment %}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The word "NUL" is not a reference to code. It is a proper noun. Therefore it should not be enclosed in code backticks.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

- The new `EXPERIMENTAL_RELOCATE LEASE` command for `ALTER TABLE` and `ALTER INDEX` allows manually transferring the leases for specific ranges to specific stores. [#26436][#26436] {% comment %}doc{% endcomment %}
- Add the `sql.distsql.{flow_stream_timeout,
max_running_flows}` [cluster setting](../v2.1/cluster-setting.html) to fine-tune flow setup [#27404][#27404] {% comment %}doc{% endcomment %}
- `IMPORT` now supprts and `oversample` `WITH` option to decrease variance in data distribution during processing. [#27341][#27341] {% comment %}doc{% endcomment %}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

... now supports a WITH oversample = ... option ...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

- Fixed permissions and audit logging issues with the optimizer. [#27108][#27108]
- Prevented a situation in which ranges repeatedly fail to perform a split. [#26934][#26934]
- Fixed a crash that could occur when distributed `LIMIT` queries were run on a cluster with at least one unhealthy node. [#26950][#26950]
- Failed [`IMPORT`](../v2.1/import.html)s now begin to clean up partially imported data immediately and in a faster manner. [#26959][#26959]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ditto plural s

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

- Alleviated a scenario in which a large number of uncommitted Raft commands could cause memory pressure at startup time. [#27009][#27009]
- Prevented the unbounded growth of the Raft log caused by a loss of quorum. [#27774][#27774]
- Foreign key references in `IMPORT ... PGDUMP` are now processed in the correct order. [#27782][#27782]
- Fix the "global matching" regex flag to `g`. [#27128][#27128] {% comment %}doc{% endcomment %}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This last release note is unreadable and does not make sense.

This is also a doc change, not a bug fix. The proper release note is:

Release note (doc change): the online documentation for the `g` flag accepted by the
SQL built-in function `regexp_replace()` has been corrected.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed. Thanks.

- Andrew Woods
- Art Nikpal
- Brett Snyder
- Emmanuel
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

make this Emmanuel Sales.

Copy link
Contributor

@knz knz Jul 30, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also perhaps remove Andy Woods and Emmanuel from this list since we're not including CRL team members here for the time being.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

Copy link
Contributor

@knz knz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed 3 of 3 files at r1, 1 of 1 files at r2.
Reviewable status: :shipit: complete! 0 of 0 LGTMs obtained


releases/v2.1.0-alpha.20180730.md, line 68 at r2 (raw file):

- The new `EXPERIMENTAL_RELOCATE LEASE` command for `ALTER TABLE` and `ALTER INDEX` allows manually transferring the leases for specific ranges to specific stores. [#26436][#26436] {% comment %}doc{% endcomment %}
- Added the `sql.distsql.{flow_stream_timeout,max_running_flows}` [cluster setting](../v2.1/cluster-setting.html) to fine-tune flow setup [#27404][#27404] {% comment %}doc{% endcomment %}
- `IMPORT` now supports a `WITH oversample = ...` option option to decrease variance in data distribution during processing. [#27341][#27341] {% comment %}doc{% endcomment %}

"option option" -> option

Copy link
Contributor Author

@jseldess jseldess left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewable status: :shipit: complete! 0 of 0 LGTMs obtained


releases/v2.1.0-alpha.20180730.md, line 68 at r2 (raw file):

Previously, knz (kena) wrote…

"option option" -> option

Done.

@jseldess jseldess force-pushed the v2.1-alpha.20180730-release-notes branch from 63b2fd3 to 3934d17 Compare July 30, 2018 15:06
@jseldess jseldess force-pushed the v2.1-alpha.20180730-release-notes branch from 3934d17 to 57dfc5f Compare July 30, 2018 15:30
@jseldess jseldess force-pushed the v2.1-alpha.20180730-release-notes branch from 57dfc5f to 6013ad1 Compare July 30, 2018 15:47
@jseldess jseldess force-pushed the v2.1-alpha.20180730-release-notes branch from 6013ad1 to 1279860 Compare July 30, 2018 15:57
Copy link
Contributor

@rmloveland rmloveland left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewable status: :shipit: complete! 0 of 0 LGTMs obtained


releases/v2.1.0-alpha.20180730.md, line 75 at r3 (raw file):

cluster setting

Nit: settings plural?


releases/v2.1.0-alpha.20180730.md, line 144 at r3 (raw file):

Prevented a scenario when dropping a table that could cause excessive compaction activity 

"when dropping a table could cause" ?


releases/v2.1.0-alpha.20180730.md, line 145 at r3 (raw file):

Limited the scanner for running incessantly on s

"limited the scanner from running incessantly" ?


releases/v2.1.0-alpha.20180730.md, line 157 at r3 (raw file):

### Doc Updates

- Added a tutorial on [benchmarking CockroachDB with TPC-C](../v2.1/performance-benchmarking-with-tpc-c.html). [#3281][#3281]

Link isn't rendering on this one


releases/v2.1.0-alpha.20180730.md, line 161 at r3 (raw file):

- Expanded the [Kubernetes tutorials](../v2.1/orchestrate-cockroachdb-with-kubernetes.html) to include setting up monitoring and alerting with Prometheus and Alertmanager. [#3370][#3370]
- Published a [full set of training modules on CockroachDB fundamentals](../v2.1/training/), including the architecture and operation, troubleshooting, and maintenance basics. [#3385][#3385]
- Updated the [rolling upgrade tutorial](../v2.1/upgrade-cockroach-version.html) with explicit `systemd` commands. https://github.com/cockroachdb/docs/pull/3396

Link appears as text but is not rendered as a link


releases/v2.1.0-alpha.20180730.md, line 167 at r3 (raw file):

This release includes 328 merged PRs by 42 authors. We would like to thank the following contributors from the CockroachDB community, with special thanks to first-time contributors Andrew Woods, Art Nikpal, Ivan Kozik, Madhav Suresh, Tarek Badr, and nexdrew.

Not sure about the author list below the paragraph. It's a little different than the text description, but not really longer (doesn't include all 42 authors). Did we mean to include all first-time contributors in the list? I suggest dropping the bulleted list in favor of the list in the paragraph, unless there is some reason for having both that I don't know about.

Copy link
Contributor

@knz knz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewable status: :shipit: complete! 0 of 0 LGTMs obtained


releases/v2.1.0-alpha.20180730.md, line 167 at r3 (raw file):

Previously, rmloveland (Rich Loveland) wrote…

Not sure about the author list below the paragraph. It's a little different than the text description, but not really longer (doesn't include all 42 authors). Did we mean to include all first-time contributors in the list? I suggest dropping the bulleted list in favor of the list in the paragraph, unless there is some reason for having both that I don't know about.

We've decided in the past to always list external contributors explicitly, even if it's not the first time they contribute.

@jseldess jseldess force-pushed the v2.1-alpha.20180730-release-notes branch from 1279860 to eec1907 Compare July 30, 2018 16:05
Copy link
Contributor Author

@jseldess jseldess left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewable status: :shipit: complete! 0 of 0 LGTMs obtained


releases/v2.1.0-alpha.20180730.md, line 75 at r3 (raw file):

Previously, rmloveland (Rich Loveland) wrote…
cluster setting

Nit: settings plural?

Done.


releases/v2.1.0-alpha.20180730.md, line 144 at r3 (raw file):

Previously, rmloveland (Rich Loveland) wrote…
Prevented a scenario when dropping a table that could cause excessive compaction activity 

"when dropping a table could cause" ?

Done.


releases/v2.1.0-alpha.20180730.md, line 145 at r3 (raw file):

Previously, rmloveland (Rich Loveland) wrote…
Limited the scanner for running incessantly on s

"limited the scanner from running incessantly" ?

Done.


releases/v2.1.0-alpha.20180730.md, line 157 at r3 (raw file):

Previously, rmloveland (Rich Loveland) wrote…

Link isn't rendering on this one

Weird. Fixed now?


releases/v2.1.0-alpha.20180730.md, line 161 at r3 (raw file):

Previously, rmloveland (Rich Loveland) wrote…

Link appears as text but is not rendered as a link

Done.


releases/v2.1.0-alpha.20180730.md, line 167 at r3 (raw file):

Previously, knz (kena) wrote…

We've decided in the past to always list external contributors explicitly, even if it's not the first time they contribute.

Done.

Copy link
Contributor

@knz knz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed 1 of 1 files at r4.
Reviewable status: :shipit: complete! 0 of 0 LGTMs obtained


releases/v2.1.0-alpha.20180730.md, line 164 at r4 (raw file):

- Updated the [OpenSSL certificate tutorial](../v2.1/create-security-certificates-openssl.html) to allow multiple node certificates with the same subject. [#3423][#3423]
- Add an example on [editing SQL statements in an external editor from within the built-in SQL shell](../v2.1/use-the-built-in-sql-client.html#edit-sql-statements-in-an-external-editor). [#3425][#3425]

What of the doc change to regexp_replace that I described above?

@jseldess jseldess merged commit d3501b6 into master Jul 30, 2018
@jseldess jseldess deleted the v2.1-alpha.20180730-release-notes branch July 30, 2018 22:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants