improve README, move bulk of info to main CrateDB docs #891

cowutils · 2017-04-25T19:45:21Z

No description provided.

tianon

Looks like this needs to be rebased, and I've got a few comments on the content, but overall I'm definitely +1 on the idea of redirecting folks to upstream docs for more details. 👍

tianon · 2017-04-25T20:29:09Z

crate/README-short.txt

@@ -1 +1,2 @@
-Crate is an open source, highly scalable, shared-nothing distributed SQL database.
+CrateDB is a distributed SQL database that makes it simple to store and analyze
+massive amounts of machine data in real-time.


This needs to be a single line, and needs to be less than 100 characters (as seen in the Travis output).

tianon · 2017-04-25T20:29:50Z

crate/content.md


-## Open Files
+[CrateDB](github.com/crate/crate) is a distributed SQL database that makes it
+simple to store and analyze massive amounts of machine data in real-time.


This should be a single line -- see Travis output (there's a markdownfmt.sh script in the root of this repo that can be used to test locally).

I'm confused by what you mean here

I ran the script and it gave me some output, but no errors

what am I looking for?

also, as you commented, I don't see any travis stuff because it didn't run!

@tianon I am also noticing that the markdownfmt.sh script produces a strange output. it's the whole of README.md plus the auto generated stuff. I removed the README.md and the output looks good. but I am not sure I should be removing the README.md from git

if I leave the README.md in git, am I right in assuming that the docker hub scripts will update that file properly?

sorry, I'm new to this whole thing!

Doh, sorry for not being more specific -- ./markdownfmt.sh is just an interface to the particular markdownfmt tool we use. If you use -d, it'll show you a "diff" of the formatting changes it expects. If you use -w, it'll write the suggested changes directly to the files for you (which you'll want to review afterwards -- it doesn't always get the intent 100% right). Leaving the README.md completely alone is perfect -- @docker-library-bot will update it (and the Docker Hub description) automatically after this PR merges. 👍

tianon · 2017-04-25T20:33:52Z

crate/user-feedback.md

+- Check [StackOverflow](https://stackoverflow.com/tags/crate) for common
+  problems
+- Chat with us on [Slack](https://crate.io/docs/support/slackin/)
+- Get [paid support](https://crate.io/pricing/)


This entire user-feedback.md file was removed over in #888, especially to streamline the long content (similar in intent to this PR). If you want to customize the content in that new "Quick reference" section, you probably want to modify crate/get-help.md to point to these other resources (see any of .template-helpers/get-help.md, ibmjava/get-help.md, neo4j/get-help.md, oraclelinux/get-help.md, silverpeas/get-help.md, solr/get-help.md, websphere-liberty/get-help.md, or xwiki/get-help.md for examples).

okay done that in my updated code ty

tianon · 2017-04-25T20:36:45Z

Shoot, Travis didn't even run on this PR for some reason 😞

cowutils · 2017-04-27T16:36:18Z

@tianon oh! I think I made this pr by mistake, or else I don't understand how this particular function of github works. I have crate#3 which is where I was planning to get review from other Crate.io employees, and then was planning to pr against this repo

I can certainly address your comments here in the above pr. but not sure if I should close this one, or if they're the same or something haha 😅

cowutils · 2017-04-27T17:00:26Z

@tianon also, I noticed a README-short.md in our github repository for this image (i.e. nothing to do with the docs repository). I take it this can be removed? (I think it's here just bcus someone mirrored it over for some reason, but it serves no purposes here as far as I can tell)

https://github.com/crate/docker-crate/blob/master/README-short.txt

tianon · 2017-04-27T19:56:59Z

Huh, that's some odd PR work -- they wouldn't be the same PR, but they might be pointing at the same source branch (meaning they'll have the same contents).

You likely want to do a rebase on this, which is easiest to perform via git pull --rebase https://github.com/docker-library/docs.git master (and will rebase your branch on master of this repo); then, you'll need to force push to update the branch (and then the "This branch has conflicts that must be resolved" from GitHub should go away). If you'd rather, one of us could take over from here (since you left the box checked that gives us push access), or we could wait for further comments from other members of the Crate team on the content? Your choice! (we're happy to help 😄 ❤️)

tianon · 2017-04-27T19:57:23Z

Oh, and the README-short.txt over in the docker-crate repo should be totally safe to remove. 👍

cowutils · 2017-05-15T11:25:06Z

@tianon thanks so much for all your help. I have made fixes and forced pushed an update to this branch. can you take another look? thanks!!

cowutils · 2017-05-15T12:18:01Z

@tianon update: I got an ack from my colleague. so this is good to go from our perspective. how does it look from your pov?

yosifkit · 2017-05-15T19:56:48Z

crate/README-short.txt

@@ -1 +0,0 @@
-Crate is an open source, highly scalable, shared-nothing distributed SQL database.


We do need this file in our repo; it populates the "Short Description" on the Docker Hub. It needs to be a single line, and less than 100 characters.

yosifkit · 2017-05-15T20:16:13Z

crate/get-help.md

@@ -1 +1,20 @@
-[the public Crate community on Slack](https://crate.io/docs/support/slackin/)


This file is inserted in the "quick reference" section under "where to get help". It is designed for a short message, so it is going to look strange with new headers inside the current bulleted list. Sorry we haven't documented this file yet.

cowutils · 2017-05-16T17:03:26Z

@yosifkit @tianon I have updated my pr. can you please review? thanks!

if this is okay, what should happen next? thx!

tianon · 2017-05-16T17:03:20Z

crate/content.md

+# What Is CrateDB?

-Starting with 0.55.0, Crate does no longer support providing custom configuration files. However it is still possible to mount Crate's configuration into `/crate/config/crate.yml`.
+[CrateDB](github.com/crate/crate) is a distributed SQL database that makes it simple to store and analyze massive amounts of machine data in real-time.


This URL should have https:// in front ([CrateDB](https://github.com/crate/crate)).

tianon · 2017-05-16T17:04:07Z

crate/content.md

+	- Extremely fast distributed query execution.
+	- Auto-partitioning, auto-sharding, and auto-replication.
+	- Self-healing and auto-rebalancing.
+	- CrateDB offers the scalability and flexibility typically associated with a NoSQL database and is designed to run on inexpensive commodity servers and can be deployed and run across any sort of network. From personal computers to multi-region hybrid clouds.


These tabs are reversed: (should be hypen<tab>text)

- Standard ...

(Likely being treated as a code-block as-is)

not sure I follow!

I added the tabs bcus that's what the script asked me to add

how do you mean "reversed"?

tianon · 2017-05-16T17:04:56Z

crate/content.md


-By Default, Crate uses multicast for node discovery. This means nodes started in the same multicast zone will discover each other automatically. Docker multicast support between containers on different hosts depends on an overlay network driver. If that does not support multicast, you have to [enable unicast in a custom*crate.yml*](https://crate.io/docs/reference/best_practice/multi_node_setup.html) file.
+	- [Getting Started With CrateDB on Docker](https://crate.io/docs/install/containers/docker/)
+	- [CrateDB Docker Best Practices](https://crate.io/docs/reference/best_practice/docker.html)


Same as above, should be -<tab>text

ohhh okay

wow. is that standard markdown? ugly!! haha

tianon · 2017-05-16T17:06:13Z

Once it's good, we'll merge and the docs at https://hub.docker.com/_/crate/ will be automatically updated. Thanks for your persistence!

cowutils · 2017-05-17T09:46:35Z

@yosifkit @tianon pushed some fixups!! ty!

tianon reviewed Apr 25, 2017

View reviewed changes

cowutils force-pushed the nomi/improve-docs branch 3 times, most recently from f2061e7 to e69230e Compare May 15, 2017 11:23

cowutils mentioned this pull request May 15, 2017

improve README, move bulk of info to main CrateDB docs crate/docker-docs#3

Closed

improve README, move bulk of info to main CrateDB docs

0d4ccc1

cowutils force-pushed the nomi/improve-docs branch from f6200ee to 0d4ccc1 Compare May 15, 2017 12:15

yosifkit requested changes May 15, 2017

View reviewed changes

fixup! improve README, move bulk of info to main CrateDB docs

f6a21be

tianon reviewed May 16, 2017

View reviewed changes

fixup! improve README, move bulk of info to main CrateDB docs

4a3d68a

yosifkit approved these changes May 17, 2017

View reviewed changes

yosifkit merged commit d2125ef into docker-library:master May 17, 2017

cowutils deleted the nomi/improve-docs branch May 19, 2017 12:11

		@@ -1 +0,0 @@
		Crate is an open source, highly scalable, shared-nothing distributed SQL database.

		@@ -1 +1,20 @@
		[the public Crate community on Slack](https://crate.io/docs/support/slackin/)

improve README, move bulk of info to main CrateDB docs #891

improve README, move bulk of info to main CrateDB docs #891

Uh oh!

Conversation

cowutils commented Apr 25, 2017

Uh oh!

tianon left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tianon commented Apr 25, 2017

Uh oh!

cowutils commented Apr 27, 2017

Uh oh!

cowutils commented Apr 27, 2017

Uh oh!

tianon commented Apr 27, 2017

Uh oh!

tianon commented Apr 27, 2017

Uh oh!

cowutils commented May 15, 2017

Uh oh!

cowutils commented May 15, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cowutils commented May 16, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tianon May 16, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tianon commented May 16, 2017 via email

Uh oh!

cowutils commented May 17, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

tianon May 16, 2017 •

edited

Loading