Update README to match pgai docs #7464
Conversation
…caledb-github-repo-to-match-the-pgai-docs
…in-the-timescaledb-github-repo-to-match-the-pgai-docs' into 3269-docs-rfc-update-the-readme-in-the-timescaledb-github-repo-to-match-the-pgai-docs
README.md
Outdated
| <h3>TimescaleDB is an extension for PostgreSQL that enables time-series workloads while increasing ingest, query, storage, and analytics performance</h3> | ||
|
|
||
| ## TimescaleDB | ||
| [](https://docs.timescale.com/) | ||
| [](https://timescaledb.slack.com/archives/C4GT3N90X) | ||
| [](https://console.cloud.timescale.com/signup) | ||
|
|
||
| TimescaleDB is an open-source database designed to make SQL scalable for | ||
| time-series data. It is engineered up from PostgreSQL and packaged as a | ||
| PostgreSQL extension, providing automatic partitioning across time and space | ||
| (partitioning key), as well as full SQL support. | ||
| </div> | ||
|
|
||
| TimescaleDB scales PostgreSQL for time-series data with the help of [hypertables](https://docs.timescale.com/use-timescale/latest/hypertables/about-hypertables/). Hypertables are PostgreSQL tables that automatically partition your data by time and space. You interact with a hypertable in the same way as regular PostgreSQL table. Behind the scenes, the database performs the work of setting up and maintaining the hypertable's partitions. | ||
|
|
||
| From the perspective of both use and management, TimescaleDB looks and feels like PostgreSQL, and can be managed and queried as | ||
| such. However, it provides a range of features and optimizations that make managing your time-series data easier and more efficient. |
There was a problem hiding this comment.
I think that the messaging is not 100% consistent with how we talk about Timescale(DB) on timescale.com
I would propose to quickly coordinate with marketing as well on the messaging as we are now expanding to more use cases than pure time series and we also start talking about Hypercore, our hybrid row-columnar engine. As an example from the website:
Time series, events, and analytics
For ingesting and querying vast amounts of live data. Our hybrid row-columnar engine makes queries up to 350x faster, ingests 44% faster and reduces storage by 95% over RDS.
There was a problem hiding this comment.
Please note that I don't include other use cases that we have on TImescale Cloud (like RAG, search, and Al) that are supported in other ways.
The additional events, and (real-time) analytics use cases that I mention on my previous comment are fully served by the TImescaleDB extension (this repo)
There was a problem hiding this comment.
Hi @atovpeko , as Yannis has mentioned here , mostly content from https://www.timescale.com , is it possible to add that link as well somewhere in the README ? Possibly, with a normal title : About Timescale , or whatever you choose.
Then, we won't need to replicate the info he mentioned, over here; and it won't go stale.
There was a problem hiding this comment.
Hi @pallavisontakke There is a section called "About Timescale" at the bottom, with the tagline and the link to the website :-) I have also added a line from the website, to align messaging.
Co-authored-by: Fabrízio de Royes Mello <[email protected]> Signed-off-by: atovpeko <[email protected]>
…in-the-timescaledb-github-repo-to-match-the-pgai-docs' into 3269-docs-rfc-update-the-readme-in-the-timescaledb-github-repo-to-match-the-pgai-docs
…caledb-github-repo-to-match-the-pgai-docs Signed-off-by: atovpeko <[email protected]>
Signed-off-by: Iain Cox <[email protected]>
…caledb-github-repo-to-match-the-pgai-docs
Co-authored-by: Fabrízio de Royes Mello <[email protected]> Signed-off-by: Iain Cox <[email protected]>
Co-authored-by: Fabrízio de Royes Mello <[email protected]> Signed-off-by: Iain Cox <[email protected]>
…in-the-timescaledb-github-repo-to-match-the-pgai-docs' into 3269-docs-rfc-update-the-readme-in-the-timescaledb-github-repo-to-match-the-pgai-docs # Conflicts: # README.md
Did some SQL indentation for better reading. Used this tool to help me a bit: https://sqlformat.darold.net/. Signed-off-by: Fabrízio de Royes Mello <[email protected]>
Reverted without qualifying `pg_catalog` schema to don't complicate things Signed-off-by: Fabrízio de Royes Mello <[email protected]>
…caledb-github-repo-to-match-the-pgai-docs
| If you prefer not to install or administer your instance of TimescaleDB, try the | ||
| 30 day free trial of [Timescale Cloud](https://console.cloud.timescale.com/signup), our fully managed cloud offering. | ||
| Timescale is pay-as-you-go. We don't charge for storage you dont use, backups, snapshots, ingress or egress. | ||
| </div> |
There was a problem hiding this comment.
After this, I would immediately show installation instructions using Docker. Something like:
Install (Linux, MacOS)
Install:
docker run -d --name timescaledb -p 5432:5432 -e POSTGRES_PASSWORD=password timescale/timescaledb-ha:pg17 psql -d "postgres://postgres:password@localhost/postgres"
Connect to the database:
docker exec -it timescaledb psql -d "postgres://postgres:password@localhost/postgres"
See installation instructions for other platforms or try Timescale Cloud for free. (with the right links)
There was a problem hiding this comment.
After that maybe show how to create a hypertable, enable the columnstore, load some data which is shown later. I think our goal should be to get people using the product as quickly as possible vs boring them with a lot content.
README.md
Outdated
|
|
||
| ### Architecture documents | ||
| ## Back up, replicate, and restore data |
There was a problem hiding this comment.
I don't think this is needed in the README. This is kind of advanced and should be covered in docs.
Co-authored-by: Ramon Guiu <[email protected]> Signed-off-by: atovpeko <[email protected]>
…caledb-github-repo-to-match-the-pgai-docs
Some improvements and clarifications Signed-off-by: Ramon Guiu <[email protected]>
…caledb-github-repo-to-match-the-pgai-docs
Co-authored-by: Iain Cox <[email protected]> Signed-off-by: Ramon Guiu <[email protected]>
atovpeko
deleted the
3269-docs-rfc-update-the-readme-in-the-timescaledb-github-repo-to-match-the-pgai-docs
branch
Disable-check: force-changelog-file
Disable-check: commit-count