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

Fix README for cassandra tool #553

Merged
merged 1 commit into from
Feb 10, 2018
Merged

Fix README for cassandra tool #553

merged 1 commit into from
Feb 10, 2018

Conversation

vancexu
Copy link
Contributor

@vancexu vancexu commented Feb 9, 2018

No description provided.

@@ -6,19 +6,26 @@ How
---
- Run make bins
- You should see an executable `cadence-cassandra-tool`
- Make sure you already created cadence and visibility keyspaces (see `keyspace.cql` in schema)

Setting up initial cassandra schema on a new cluster
----------------------------------------------------
```
./cadence-cassandra-tool -ep 127.0.0.1 -k cadence setup-schema -v 0.0 -- this sets up just the schema version tables with initial version of 0.0
Copy link
Contributor

Choose a reason for hiding this comment

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

There is a make target for this. You can just replace these with
make install-schema

Copy link
Contributor Author

Choose a reason for hiding this comment

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

make sense, added

@@ -6,19 +6,26 @@ How
---
- Run make bins
- You should see an executable `cadence-cassandra-tool`
- Make sure you already created cadence and visibility keyspaces (see `keyspace.cql` in schema)
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 a bit confusing. Aren't we creating this using the commands below? How will the user make sure they have already created the keyspaces.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

removed

@coveralls
Copy link

coveralls commented Feb 9, 2018

Coverage Status

Coverage decreased (-0.05%) to 68.389% when pulling c3ae1db on readme into 083cb3c on master.

make install-schema
```

Setting up schema on a new cluster manually
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think this section is necessary If folks want to dig in, they can easily look up Makefile to see command breakdown.

Copy link
Contributor

Choose a reason for hiding this comment

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

Never mind, I see this is a repo for tools. Ignore this.

@@ -7,18 +7,30 @@ How
- Run make bins
- You should see an executable `cadence-cassandra-tool`

Setting up initial cassandra schema on a new cluster
Setting up cassandra schema on a new cluster using Makefile
Copy link
Contributor

Choose a reason for hiding this comment

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

Can avoid "using Makefile". It's a bit confusing, Instead, you call it out as a shortcut.

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.

3 participants