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

DOC-6403 v23.1.0-alpha.2 release notes #16245

Merged
merged 15 commits into from
Feb 14, 2023
Merged

Conversation

andf-crl
Copy link
Contributor

@andf-crl andf-crl commented Feb 13, 2023

Addresses: DOC-6403

  • Release notes for v23.1.0-alpha.2

Process Feedback

  • See diff for an example of the manual effort required each time we do these. This diff represents the initial changes required by hand to get the automated output from release_notes.py into human-readable form, even before any copy review, including my own. Specifically:
    • Red/Green are frequently entire paragraphs, not sporadic punctuation or added links. Scope: out of control.
    • Non-red/green is 11 release notes. This represents release notes that arrived ready for users to read them. It means:
      • All other release notes in this PR required me to fix them, sometimes research them upstream (read the eng PR, scratch my head, ask for help, give up).
      • All other release notes in this PR continue to be problematic in their original upstream location: PR description and commit messages. Users are free to see these as they are since we are open source. Open source :: open mistake visibility.
    • Basic typos abound. Missing punctuation abounds. Every engineer phrases things differently, so manual edits for basic conformity to our Style Guide -- and even just for actual correctness -- are extensive.
      • Some basic typos invert the intended meaning. Likely the following is very wrong, but I can't tell in which direction:
        • Previously, certain GRANT or REVOKE commands on a user which does not exist would error with the correct PG code. This is now fixed. [#94677][#94677]
          • "incorrect" ?? "would not error" ??
    • No standardization of phrasing, feature names, and product names:
      • CC Console vs DB Console vs Admin Console
      • DB Console page names are all over the place, some refer to page names, some to graph names, some to tabs.
    • Extensive deleting = wasted time reading and judging an item to be N/A. Determination of whether I delete a RN should in fact never reach me! It needs to be an engineering design decision, agreed upon during feature development:
      • No docs needed, and/or:
      • No release note required
    • Specialized knowledge requirement . For example, I happened to know that when engineers say "global privileges" they mean "system-level privileges". Former means nothing to every single CRDB user (outside of CRL), latter is documented and linkable. I'm sure there's CDC or KV stuff in here that I left incorrect because I don't happen to know that the engineer is wrong.
      • Which crdb_internal namespace (tables? schemas? built-in functions?) is "public-internal" and which is "CRDB-internal"? I left all, can never tell intent with these.
        • "public" and "internal" usually mean the opposite thing in other contexts, such as every other company I've ever heard of. If we want to embrace "internal is public, war is peace, etc" then we need to be carefully and thoroughly explicit about it.
    • New ticket linking policy (Epic: None and CRDB-12345 link) is not expected by release_notes.py, and as such is not parsed / stripped / anything, but instead dumped raw. More manual deletions.
      • New "instructions to docs" section (i.e. Our CTE docs should be updated with the following changes:) is similarly unexpected, and also dumped raw. Instructions to docs should be in Jira. More manual deletions.
      • Also don't need any intra-eng banter, like: Informs: https://github.com/cockroachdb/cockroach/issues/XXXXX. More manual deletions.
    • Many many duplicate release notes. I left every single one as-is because the last time I asked "it was both a bug fix and a feature so it should be in both". It's in both now too, but there are 12 such boths this time around. Probably not actually intended, but I don't have the information to determine. Example: #96029.
    • Changes without release note annotation Policy: if no release note annotation, no release note. Deleted all.

Staging

v23.1.md

@vercel
Copy link

vercel bot commented Feb 13, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated
docs ❌ Failed (Inspect) Feb 14, 2023 at 4:20PM (UTC)

@github-actions
Copy link

Files changed:

  • _config_base.yml
  • _data/releases.csv
  • _includes/releases/v23.1/v23.1.0-alpha.2.md:

@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Feb 13, 2023

Deploying with  Cloudflare Pages  Cloudflare Pages

Latest commit: 61c4306
Status:⚡️  Build in progress...

View logs

@andf-crl andf-crl changed the title DOC-6403 v23.1.0-alpha.2 release notes - INITIAL RAW DOC-6403 v23.1.0-alpha.2 release notes Feb 13, 2023
@netlify
Copy link

netlify bot commented Feb 13, 2023

Netlify Preview

Name Link
🔨 Latest commit 61c4306
🔍 Latest deploy log https://app.netlify.com/sites/cockroachdb-docs/deploys/63ebb4d08607e60007893b7e
😎 Deploy Preview https://deploy-preview-16245--cockroachdb-docs.netlify.app/docs/releases/v23.1
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

Copy link
Contributor

@MichaelTrestman MichaelTrestman left a comment

Choose a reason for hiding this comment

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

LGTM. Huge RN, wow!

_includes/releases/v23.1/v23.1.0-alpha.2.md Outdated Show resolved Hide resolved
_includes/releases/v23.1/v23.1.0-alpha.2.md Outdated Show resolved Hide resolved
_includes/releases/v23.1/v23.1.0-alpha.2.md Outdated Show resolved Hide resolved
_includes/releases/v23.1/v23.1.0-alpha.2.md Outdated Show resolved Hide resolved
_includes/releases/v23.1/v23.1.0-alpha.2.md Outdated Show resolved Hide resolved
_includes/releases/v23.1/v23.1.0-alpha.2.md Outdated Show resolved Hide resolved
- Add the `log_timezone` session variable, which is read-only and always `UTC`. [#94123][#94123]
- Added Two new virtual tables `crdb_internal.index_spans` and `.table_spans`, which list the logical keyspace used by each index/table. [#93644][#93644]
- The following new statements are introduced:
- `SHOW RANGES FROM CURRENT_CATALOG` and `SHOW RANGES` without a parameter: functions as an alias for `SHOW RANGES FROM DATABASE` on the session's current database.
Copy link
Contributor

Choose a reason for hiding this comment

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

Looks like there's no docs for this stuff to even link to at this point?
seems unfortunate.

@andf-crl andf-crl merged commit a55fc77 into master Feb 14, 2023
@andf-crl andf-crl deleted the v23.1.0-alpha.2-release-notes branch February 14, 2023 16:28
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.

2 participants