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

Add links to TSDB blog post series in tsdb/README.md #8078

Merged
merged 1 commit into from Oct 19, 2020

Conversation

codesome
Copy link
Member

Would it make sense to link these blog posts here? I feel it would be helpful for new contributors and I was also asked by folks to link them in upstream docs.

Copy link
Contributor

@brian-brazil brian-brazil left a comment

Choose a reason for hiding this comment

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

👍

@@ -11,3 +11,9 @@ Based on the Gorilla TSDB [white papers](http://www.vldb.org/pvldb/vol8/p1816-te
Video: [Storing 16 Bytes at Scale](https://youtu.be/b_pEevMAC3I) from [PromCon 2017](https://promcon.io/2017-munich/).

See also the [format documentation](docs/format/README.md).

A series of blog posts explaining different components of TSDB:
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we put a version number in here so it'll be obvious when this is outdated?

Copy link
Member Author

Choose a reason for hiding this comment

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

The dates in the blog post should be enough I believe (same with the above references which will go outdated before this, we don't have a version number there too)

Copy link
Member Author

Choose a reason for hiding this comment

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

which will go outdated before this

I mean some of them :P

Copy link
Member

Choose a reason for hiding this comment

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

Should we add them to the storage.md in the docs also / instead?

Copy link
Member Author

Choose a reason for hiding this comment

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

I would take it as "also", because the main references to understand TSDB is in this README file.
I don't have strong opinions on adding it in storage.md, maybe we could reference this readme itself there?

Copy link
Member Author

Choose a reason for hiding this comment

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

Or move all of this to storage.md and reference the website here instead.

Copy link
Contributor

Choose a reason for hiding this comment

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

This is all developer docs, it shouldn't go on the main user-facing website.

Copy link
Member Author

Choose a reason for hiding this comment

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

Alright, I will undo the last change

@codesome codesome changed the title Add links to TSDB blog post series in tsdb/README.md Add links to TSDB blog post series in storage.md and move tsdb/README.md to storage.md Oct 19, 2020
@codesome
Copy link
Member Author

@roidelapluie I have moved the tsdb/README.md contents to storage.md now

Signed-off-by: Ganesh Vernekar <cs15btech11018@iith.ac.in>
@codesome codesome changed the title Add links to TSDB blog post series in storage.md and move tsdb/README.md to storage.md Add links to TSDB blog post series in tsdb/README.md Oct 19, 2020
@codesome codesome merged commit d9cd913 into prometheus:master Oct 19, 2020
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.

None yet

3 participants