WIP: Improve data types docs (superseded, kept open as a temporary reference) #11418
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nomicode
force-pushed
the
nomi/readme_plus
branch
from
c53981d
to
1a9f574
Compare
nomicode
force-pushed
the
nomi/readme_plus
branch
from
c80c18a
to
1896dbb
Compare
This was referenced Jun 18, 2021
some impromptu improvements. more to follow so far: - started making some light improvements to the README - ended up adding a lot of links to the main docs - ended up tidying up the pages I linked to so that readers have a good first impression if they click through - improved the intros for the three main SQL docs (syntax, compatibility, compliance) and improved how they link through to each other - (unexpectedly) ended up spending most of my time reworking the data types docs (and some adjacent PostgreSQL compat info)
nomicode
force-pushed
the
nomi/readme_plus
branch
from
e0aac62
to
ae2a85d
Compare
nomicode
added a commit
that referenced
this pull request
Jul 13, 2021
I have squashed all commits on #11418. The old PR and old branch will be left in place until this work is complete. I am going to tease apart the changes into separate PRs: - One or more PRs that cover the changes made to individual whole docs (other than `data-types.rst`, where most of changes are). - Basic restructuring changes for `data-types.rst` so that the heading structure matches the final intended structure. - One or more PRs for the remaining changes to `data-types.rst`, each intended to cover a specific logical set changes. Specifically, for example, a PR that covers my changes for the `TIMESTAMP` data type. Changes like this are big enough to warrant review in isolation. I have chosen not to cherry-pick commits, because each doc has been visited multiple time by commits that span multiple docs. It will make it easier for: me to (as above): - Chunk it by file (except `data-types.rst`). - Prepare `data-types.rst` for the main changes by getting the document structure sorted in advance. - Slot data types changes in one-by-one, without having to alter the structure of the `data-types.rst` doc. For my reference, the rest of this commit message preserves the individual commit messages from the squashed commits. Eventually, this commit will be discarded, and any information in the commit message that needs to be preserved will be migrated to the relevant PR. --- some impromptu improvements (7494fe1) more to follow so far: - started making some light improvements to the README - ended up adding a lot of links to the main docs - ended up tidying up the pages I linked to so that readers have a good first impression if they click through - improved the intros for the three main SQL docs (syntax, compatibility, compliance) and improved how they link through to each other - (unexpectedly) ended up spending most of my time reworking the data types docs (and some adjacent PostgreSQL compat info) --- - Add `_venv/` to .gitignore (2d9978b) - Restructuring (2d9978b) - checkpoint (73670a6) - Uppercase data types added to CrateDB Admin keywords list (f7050bf) See crate/crate-admin#724 - checkpoint (caa68f1) - checkpoint (f7050bf) - finish null type, fix http doc (f7050bf) - clean up (f7050bf) - labels (f7050bf) - checkpoint (f7050bf) - finished with dates and types (f7050bf) - checkpoint (f7050bf)
nomicode
changed the title
|
this PR has been superseded by #11558 |
nomicode
added a commit
that referenced
this pull request
Jul 13, 2021
I have squashed all commits on #11418. The old PR and old branch will be left in place until this work is complete. I am going to tease apart the changes into separate PRs: - One or more PRs that cover the changes made to individual whole docs (other than `data-types.rst`, where most of changes are). - Basic restructuring changes for `data-types.rst` so that the heading structure matches the final intended structure. - One or more PRs for the remaining changes to `data-types.rst`, each intended to cover a specific logical set changes. Specifically, for example, a PR that covers my changes for the `TIMESTAMP` data type. Changes like this are big enough to warrant review in isolation. I have chosen not to cherry-pick commits, because each doc has been visited multiple time by commits that span multiple docs. It will make it easier for: me to (as above): - Chunk it by file (except `data-types.rst`). - Prepare `data-types.rst` for the main changes by getting the document structure sorted in advance. - Slot data types changes in one-by-one, without having to alter the structure of the `data-types.rst` doc. For my reference, the rest of this commit message preserves the individual commit messages from the squashed commits. Eventually, this commit will be discarded, and any information in the commit message that needs to be preserved will be migrated to the relevant PR. --- some impromptu improvements (7494fe1) more to follow so far: - started making some light improvements to the README - ended up adding a lot of links to the main docs - ended up tidying up the pages I linked to so that readers have a good first impression if they click through - improved the intros for the three main SQL docs (syntax, compatibility, compliance) and improved how they link through to each other - (unexpectedly) ended up spending most of my time reworking the data types docs (and some adjacent PostgreSQL compat info) --- - Add `_venv/` to .gitignore (2d9978b) - Restructuring (2d9978b) - checkpoint (73670a6) - Uppercase data types added to CrateDB Admin keywords list (f7050bf) See crate/crate-admin#724 - checkpoint (caa68f1) - checkpoint (f7050bf) - finish null type, fix http doc (f7050bf) - clean up (f7050bf) - labels (f7050bf) - checkpoint (f7050bf) - finished with dates and types (f7050bf) - checkpoint (f7050bf)
nomicode
added a commit
that referenced
this pull request
Jul 15, 2021
I have squashed all commits on #11418. The old PR and old branch will be left in place until this work is complete. I am going to tease apart the changes into separate PRs: - One or more PRs that cover the changes made to individual whole docs (other than `data-types.rst`, where most of changes are). - Basic restructuring changes for `data-types.rst` so that the heading structure matches the final intended structure. - One or more PRs for the remaining changes to `data-types.rst`, each intended to cover a specific logical set changes. Specifically, for example, a PR that covers my changes for the `TIMESTAMP` data type. Changes like this are big enough to warrant review in isolation. I have chosen not to cherry-pick commits, because each doc has been visited multiple time by commits that span multiple docs. It will make it easier for: me to (as above): - Chunk it by file (except `data-types.rst`). - Prepare `data-types.rst` for the main changes by getting the document structure sorted in advance. - Slot data types changes in one-by-one, without having to alter the structure of the `data-types.rst` doc. For my reference, the rest of this commit message preserves the individual commit messages from the squashed commits. Eventually, this commit will be discarded, and any information in the commit message that needs to be preserved will be migrated to the relevant PR. --- some impromptu improvements (7494fe1) more to follow so far: - started making some light improvements to the README - ended up adding a lot of links to the main docs - ended up tidying up the pages I linked to so that readers have a good first impression if they click through - improved the intros for the three main SQL docs (syntax, compatibility, compliance) and improved how they link through to each other - (unexpectedly) ended up spending most of my time reworking the data types docs (and some adjacent PostgreSQL compat info) --- - Add `_venv/` to .gitignore (2d9978b) - Restructuring (2d9978b) - checkpoint (73670a6) - Uppercase data types added to CrateDB Admin keywords list (f7050bf) See crate/crate-admin#724 - checkpoint (caa68f1) - checkpoint (f7050bf) - finish null type, fix http doc (f7050bf) - clean up (f7050bf) - labels (f7050bf) - checkpoint (f7050bf) - finished with dates and types (f7050bf) - checkpoint (f7050bf)
|
Hi Naomi, as you said this patch has been superseded by #11558, can we close this one? With kind regards, |
amotl
pushed a commit
that referenced
this pull request
Aug 3, 2021
I have squashed all commits on #11418. The old PR and old branch will be left in place until this work is complete. I am going to tease apart the changes into separate PRs: - One or more PRs that cover the changes made to individual whole docs (other than `data-types.rst`, where most of changes are). - Basic restructuring changes for `data-types.rst` so that the heading structure matches the final intended structure. - One or more PRs for the remaining changes to `data-types.rst`, each intended to cover a specific logical set changes. Specifically, for example, a PR that covers my changes for the `TIMESTAMP` data type. Changes like this are big enough to warrant review in isolation. I have chosen not to cherry-pick commits, because each doc has been visited multiple time by commits that span multiple docs. It will make it easier for: me to (as above): - Chunk it by file (except `data-types.rst`). - Prepare `data-types.rst` for the main changes by getting the document structure sorted in advance. - Slot data types changes in one-by-one, without having to alter the structure of the `data-types.rst` doc. For my reference, the rest of this commit message preserves the individual commit messages from the squashed commits. Eventually, this commit will be discarded, and any information in the commit message that needs to be preserved will be migrated to the relevant PR. --- some impromptu improvements (7494fe1) more to follow so far: - started making some light improvements to the README - ended up adding a lot of links to the main docs - ended up tidying up the pages I linked to so that readers have a good first impression if they click through - improved the intros for the three main SQL docs (syntax, compatibility, compliance) and improved how they link through to each other - (unexpectedly) ended up spending most of my time reworking the data types docs (and some adjacent PostgreSQL compat info) --- - Add `_venv/` to .gitignore (2d9978b) - Restructuring (2d9978b) - checkpoint (73670a6) - Uppercase data types added to CrateDB Admin keywords list (f7050bf) See crate/crate-admin#724 - checkpoint (caa68f1) - checkpoint (f7050bf) - finish null type, fix http doc (f7050bf) - clean up (f7050bf) - labels (f7050bf) - checkpoint (f7050bf) - finished with dates and types (f7050bf) - checkpoint (f7050bf)
amotl
pushed a commit
that referenced
this pull request
Aug 3, 2021
I have squashed all commits on #11418. The old PR and old branch will be left in place until this work is complete. I am going to tease apart the changes into separate PRs: - One or more PRs that cover the changes made to individual whole docs (other than `data-types.rst`, where most of changes are). - Basic restructuring changes for `data-types.rst` so that the heading structure matches the final intended structure. - One or more PRs for the remaining changes to `data-types.rst`, each intended to cover a specific logical set changes. Specifically, for example, a PR that covers my changes for the `TIMESTAMP` data type. Changes like this are big enough to warrant review in isolation. I have chosen not to cherry-pick commits, because each doc has been visited multiple time by commits that span multiple docs. It will make it easier for: me to (as above): - Chunk it by file (except `data-types.rst`). - Prepare `data-types.rst` for the main changes by getting the document structure sorted in advance. - Slot data types changes in one-by-one, without having to alter the structure of the `data-types.rst` doc. For my reference, the rest of this commit message preserves the individual commit messages from the squashed commits. Eventually, this commit will be discarded, and any information in the commit message that needs to be preserved will be migrated to the relevant PR. --- some impromptu improvements (7494fe1) more to follow so far: - started making some light improvements to the README - ended up adding a lot of links to the main docs - ended up tidying up the pages I linked to so that readers have a good first impression if they click through - improved the intros for the three main SQL docs (syntax, compatibility, compliance) and improved how they link through to each other - (unexpectedly) ended up spending most of my time reworking the data types docs (and some adjacent PostgreSQL compat info) --- - Add `_venv/` to .gitignore (2d9978b) - Restructuring (2d9978b) - checkpoint (73670a6) - Uppercase data types added to CrateDB Admin keywords list (f7050bf) See crate/crate-admin#724 - checkpoint (caa68f1) - checkpoint (f7050bf) - finish null type, fix http doc (f7050bf) - clean up (f7050bf) - labels (f7050bf) - checkpoint (f7050bf) - finished with dates and types (f7050bf) - checkpoint (f7050bf)
|
I tried to clean up and summarize all improvements into #11631, which probably supersedes the respective other PRs, including this one. @norosa: If you can confirm I did a reasonable job on this, we might consider closing this PR. |
|
Closing this in favor of #11631. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
some impromptu improvements. more to follow
so far:
started making some light improvements to the README
ended up adding a lot of links to the main docs
ended up tidying up the pages I linked to so that readers have a good first impression if they click through
improved the intros for the three main SQL docs (syntax, compatibility, compliance) and improved how they link through to each other
(unexpectedly) ended up spending most of my time reworking the data types docs (and some adjacent PostgreSQL compat info)