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

Refactor cassandra page #342

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

tpardeshi
Copy link

Refactor Cassandra page into multiple files.

@pvalena
Copy link
Contributor

pvalena commented Jun 2, 2020

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 :))

@tpardeshi
Copy link
Author

Sure :)

@pvalena
Copy link
Contributor

pvalena commented Oct 12, 2020

Sorry for this to take so long, we're blocked on developer-portal/website#104.

Copy link
Contributor

@pvalena pvalena left a 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.

Comment on lines +3 to +4
There is a Cassandra image available
[for OpenShift](https://github.com/sclorg/cassandra-container).
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
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
Copy link
Contributor

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.

Copy link
Contributor

Choose a reason for hiding this comment

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

Also the page should start with

# Title

(not a ## Subtitle)
Please check our contribution guide.

@@ -0,0 +1,115 @@
## Running a Cassandra cluster
Copy link
Contributor

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
Copy link
Contributor

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
Copy link
Contributor

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
Copy link
Contributor

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)

Copy link
Contributor

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
Copy link
Contributor

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).

@jackorp
Copy link
Contributor

jackorp commented Jun 11, 2021

Ping... @tpardeshi Are you still interested in advancing this PR?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants