-
Notifications
You must be signed in to change notification settings - Fork 3
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 the get-started documents #5
add the get-started documents #5
Conversation
@dgarcia360 Please have a look to see if everything is OK in terms of our toolchain, customization, etc. |
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.
Minor / cosmetic changes. Great job porting this over from google docs!
521353f
to
7946e21
Compare
7946e21
to
3cec8e4
Compare
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.
Minor suggestions and adding the feature store sample app
Some initial comments on the content, starting with Key Features page:
As is, the Use Cases section is too vague to be part of the docs. "Big Data Analytics: Ideal for applications requiring real-time processing of vast datasets." |
Can we use Tabs in the Driver page, as in the Connect an Application? |
data-modeling/query-design/ - We should remove it or add examples to make it worthwhile. Without examples, it is a collection of high-level statements that are hard to use. |
/data-modeling/schema-design/
Relational database supports ALTER TABLE for decades. Lets avoid such statements, they are not helping the user to use the product. |
docs/index.rst
Outdated
@@ -2,7 +2,6 @@ | |||
:hide-version-warning: | |||
:hide-pre-content: | |||
:hide-post-content: | |||
:hide-sidebar: |
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.
@annastuchlik I'm not sure to like the homepage with the sidebar enabled.
Instead, in a future iteration we might want to link this getting started content on this section. Instead of showing products, we can show actions readers might want to do:
By doing so, we can move back the open-source, enterprise, cloud products to the "Products list" section:
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.
As a suggestion, cc/ @tzach and @annastuchlik let's leave the sidebar hidden (so as not to interfere with the cards) until users are directed to the getting started guide. To first navigate there, how about we link this guide via the "New to ScyllaDB? Start here" link. ATM this link goes to ScyllaDB basics which has a cloud context. Perhaps this guide is a better replacement for that.
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.
Yes, I'll hide the sidebar and add a link. Better, I'll replace the link with a button (it's supported by the current theme, so we don't need to release anything). I need to move the files under one folder beforehand.
docs/index.rst
Outdated
@@ -2,7 +2,6 @@ | |||
:hide-version-warning: | |||
:hide-pre-content: | |||
:hide-post-content: | |||
:hide-sidebar: |
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.
As a suggestion, cc/ @tzach and @annastuchlik let's leave the sidebar hidden (so as not to interfere with the cards) until users are directed to the getting started guide. To first navigate there, how about we link this guide via the "New to ScyllaDB? Start here" link. ATM this link goes to ScyllaDB basics which has a cloud context. Perhaps this guide is a better replacement for that.
scrapping that section as I feel it's hard to get right for this getting started guide / doesn't offer a lot of value to developer at this point in onboarding. |
scrapped in latest comments for something shorter / less snakeoil |
more examples added |
be0b3f8
to
6e070dd
Compare
@timkoopmans @tzach Please re-review. Here's how the content is now organized:
|
I've skipped the critical information: the button now takes you to https://docs.scylladb.com/stable/. After this PR is merged, I'll open another one to replace it with https://docs.scylladb.com/stable/get-started, as the URL doesn't exist yet. |
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.
Minor issues with some links, as discussed in person.
Happy with this version, thank you.
4f95a5a
to
89d3861
Compare
@tzach Tim and I are done reviewing. I've also asked @zseta and @danielhe4rt to have a final look at the driver-related pages. |
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.
Nice progress.
Few more comments
and the books table stores information about books. The ``author_id`` column | ||
in the books table serves as a foreign key referencing the authors table, | ||
ensuring data consistency and reducing redundancy. |
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.
Scylla does not support foreign keys.
We are highlighting a Scylla deficiency 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.
On a second thougt, I suggest to drop the entire section of (De)Normalization
Its better fit in a blog post, and its is not a must in the getting started section
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.
@timkoopmans, I'm removing the section @tzach is referring to, especially since it includes incorrect information. He's got a point - (de)normalization may not be the best fit for Getting Started, but we can add something else to this page later on.
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.
Good work!
This commit adds documents that cover basic concepts in ScyllaDB and help developers get started with ScyllaDB.
8550849
to
78a24ac
Compare
This PR adds documents that cover basic concepts in ScyllaDB and help developers get started with ScyllaDB.
In addition, the left navigation bar is enabled in this project so that the new documents are shown in the page tree.