-
Notifications
You must be signed in to change notification settings - Fork 249
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
Refactor cassandra page #342
base: master
Are you sure you want to change the base?
Refactor cassandra page #342
Conversation
Wow I really appreciate the work put into it, thanks! Let me go through this next week. (But others can help with review as well :)) |
Sure :) |
Sorry for this to take so long, we're blocked on developer-portal/website#104. |
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.
Please check the comments. Mostly you've forgotten about the jekyll headers, so it wouldn't be rendered properly.
There is a Cassandra image available | ||
[for OpenShift](https://github.com/sclorg/cassandra-container). |
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.
There is a Cassandra image available | |
[for OpenShift](https://github.com/sclorg/cassandra-container). | |
There is a Cassandra image available for OpenShift. | |
Please follow the [Installation instructions](https://github.com/sclorg/cassandra-container#installation). |
@@ -0,0 +1,77 @@ | |||
## How to configure Cassandra |
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.
You're missing a header 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.
@@ -0,0 +1,115 @@ | |||
## Running a Cassandra cluster |
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.
You're missing a jekyll header here.
@@ -0,0 +1,7 @@ | |||
## Documentation |
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.
Should be probably in a "about.md" page.
Also it's missing a header (I think for most of the pages, along with the ##
instead of #
).
Row store means that like relational databases, Cassandra organizes data by | ||
rows and columns. The Cassandra Query Language (CQL) is a close relative of SQL. | ||
|
||
## Quick start |
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.
All of content here in developer portal should be a "Quick start" or a reference to some documentation. Not a documentation itself.
|
||
```bash | ||
$ sudo dnf install cassandra cassandra-server # install client/server | ||
$ sudo systemctl start cassandra # initialize Cassandra server |
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.
Aren't you duplicating the installation
page?
Please also check our writing guide.
I'd avoid the # comments
at the end of the line, as not everyone know that they're the comments. Can you move it to a separate line?
@@ -0,0 +1,4 @@ | |||
## Language connectors/adapters/drivers (packages) | |||
|
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.
Please add some entry on how to install them / what they are instead of link to package sources.
$ sudo firewall-cmd --permanent --zone=public --add-port=9042/tcp | ||
``` | ||
|
||
Follow the instructions to "Enabling remote access to server" from cassandra_configuration.md |
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.
You can actually write this as a link. It's not a .md
, but .html
- otherwise standard markdown link (absolute).
Ping... @tpardeshi Are you still interested in advancing this PR? |
Refactor Cassandra page into multiple files.