-
Notifications
You must be signed in to change notification settings - Fork 482
Docs upcoming v26.0.0 #34136
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
base: main
Are you sure you want to change the base?
Docs upcoming v26.0.0 #34136
Conversation
add license key information to installation instructions
docs portion of #34045
Co-authored-by: Pranshu Maheshwari <maheshwarip@users.noreply.github.com>
also note that you can get a community license key in the cloud console
- Added a banner to signal we're only allowed 1 major version at a time
- Specify upgrade pattern
- Got rid of compatibility table
<!--
Describe the contents of the PR briefly but completely.
If you write detailed commit messages, it is acceptable to copy/paste
them
here, or write "see commit messages for details." If there is only one
commit
in the PR, GitHub will have already added its commit message above.
-->
### Motivation
<!--
Which of the following best describes the motivation behind this PR?
* This PR fixes a recognized bug.
[Ensure issue is linked somewhere.]
* This PR adds a known-desirable feature.
[Ensure issue is linked somewhere.]
* This PR fixes a previously unreported bug.
[Describe the bug in detail, as if you were filing a bug report.]
* This PR adds a feature that has not yet been specified.
[Write a brief specification for the feature, including justification
for its inclusion in Materialize, as if you were writing the original
feature specification.]
* This PR refactors existing code.
[Describe what was wrong with the existing code, if it is not obvious.]
-->
### Tips for reviewer
<!--
Leave some tips for your reviewer, like:
* The diff is much smaller if viewed with whitespace hidden.
* [Some function/module/file] deserves extra attention.
* [Some function/module/file] is pure code movement and only needs a
skim.
Delete this section if no tips.
-->
### Checklist
- [ ] This PR has adequate test coverage / QA involvement has been duly
considered. ([trigger-ci for additional test/nightly
runs](https://trigger-ci.dev.materialize.com/))
- [ ] This PR has an associated up-to-date [design
doc](https://github.com/MaterializeInc/materialize/blob/main/doc/developer/design/README.md),
is a design doc
([template](https://github.com/MaterializeInc/materialize/blob/main/doc/developer/design/00000000_template.md)),
or is sufficiently small to not require a design.
<!-- Reference the design in the description. -->
- [ ] If this PR evolves [an existing `$T ⇔ Proto$T`
mapping](https://github.com/MaterializeInc/materialize/blob/main/doc/developer/command-and-response-binary-encoding.md)
(possibly in a backwards-incompatible way), then it is tagged with a
`T-proto` label.
- [ ] If this PR will require changes to cloud orchestration or tests,
there is a companion cloud PR to account for those changes that is
tagged with the release-blocker label
([example](MaterializeInc/cloud#5021)).
<!-- Ask in #team-cloud on Slack if you need help preparing the cloud
PR. -->
- [ ] If this PR includes major [user-facing behavior
changes](https://github.com/MaterializeInc/materialize/blob/main/doc/developer/guide-changes.md#what-changes-require-a-release-note),
I have pinged the relevant PM to schedule a changelog post.
Signed-off-by: Petros Angelatos <petrosagg@gmail.com> Co-authored-by: kay-kim <kay.kim@materialize.com>
docs: tweak swap upgrade instructions
--------- Co-authored-by: kay-kim <kay.kim@materialize.com>
for preview only, but we should merge this with proper version when v26.0.0 gets cut
| and drops, see [`CREATE SOURCE (New Syntax)`](/sql/create-source/postgres-v2/) | ||
| and see [`CREATE SOURCE (New Syntax)`](/sql/create-source/postgres-v2/) and |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the following fragment is duplicated in this sentence:
see [CREATE SOURCE (New Syntax)](/sql/create-source/postgres-v2/)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you! will update.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| ```sql | ||
| CREATE SCHEMA v3; | ||
| CREATE TABLE v3.T | ||
| FROM SOURCE my_source(REFERENCE public.T) WITH (EXCLUDE COLUMNS (B)); | ||
| ``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In the add column example above, we make mention of creating a new materialized view. After creating a new schema and the new table with access to column B, they can add a new materialized view that references column B.
For the drop column example, it might be useful to do the same.
e.g.
After v3.T has hydrated, create a new materialized that no longer references column B.
CREATE MATERIALIZED VIEW v3.matview AS
SELECT SUM(A)
FROM v2.T;There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍 Will do a fast-follow post release.
| ALTER TABLE T DROP COLUMN B; | ||
| ``` | ||
|
|
||
| Dropping the column B will have no effect on `v3.T`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
May want to note that it will affect v2.T and v2.matview. When the user attempts to read from either, MZ will report an error that the source table schema has been altered.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you. Will update.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
docs: Minor fixes for upgrade docs
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
i don't really know where this data comes from, but a few thoughts:
- would it be possible to hide the entries for deprecated fields?
- could we sort the fields so that required fields come first?
- it'd be nice when a field has a type of something like
MaterializeCertSpecthat it links to the definition of that type further below. - some of the entries have the field type on the same line as the description, other entries have them on separate lines - we should be consistent here
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Partial response before I forget:
I had copied the json file from #34114 ... and then small tweak to the shortcode.
- For deprecated ... don't we need to show deprecated for people who are using it to know? unless we know that no one is using it. I mean, if the json generator doesn't output them, that's fine, but was also wondering.
- Can tweak shortcode to render how we want it.
...and a syntax fix Signed-off-by: Petros Angelatos <petrosagg@gmail.com>
docs: Specify that Terraform version can be higher too
No description provided.