Thanks to visit codestin.com
Credit goes to github.com

Skip to content
This repository was archived by the owner on Nov 22, 2017. It is now read-only.

Conversation

@willbarton
Copy link
Member

This PR is a significant overhaul of the Sheer README with the goal of making it clearer what Sheer does and can be used for, and how to use it (API documentation both for python developers and for front-ends). This includes a lot of the same information as the old README, but in some different places.

It removes the section about Jekyll because, honestly, coming to Sheer for the first time that certainly confused me, because however Sheer might have begun life it's a very different beast from Jekyll right now.

I've also provided some links to Elasticsearch documentation interspersed with the content, since Sheer uses Elasticsearch relatively transparently.

@dpford contributed to this while it was in the wiki. I welcome any other suggestions on how to make Sheer more understandable. It's not hard, it's just misunderstood.

You can view the updated README in my fork.

Reviewers

@rosskarchner
@dpford
@kurtwall

@anselmbradford
Copy link
Member

Fixes #83

@rosskarchner
Copy link
Contributor

This is fantastic-- sheer feels all grown up now!

@anselmbradford
Copy link
Member

This is awesome @willbarton A few stylistic comments, none of which I think should hold up this being merged if it doesn't make sense to tackle them now:

  • It would be good to eventually better align this with https://github.com/cfpb/open-source-project-template, specifically:
    • Adding the how to test the software section. nose and mock are mentioned for testing, but those are never touched on again in the Readme.
    • Change COPYING.txt filename to LICENSE, as it is referenced in the Readme.
  • The bulleted lists use a mix of styles, for example, the list under general usage includes lines that end in a period and lines that don't, and this line is capitalized after the colon, while the others aren't (I prefer caps myself). Also, Elasticsearch is downcased in this list while it is capitalized elsewhere.

@Scotchester
Copy link
Contributor

I think Ans's first bullet is worth addressing before merge.

  • Testing instructions definitely need to go in there.
  • The license link at the end of the README is correctly linked to COPYING.txt, but it would be nice to use the new standard name.

@willbarton
Copy link
Member Author

@anselmbradford Ok, I've taken care of both those points in 1f17392 and d7ffca4. Testing should absolutely be in there, and that's an oversight on my part.

The bulleted lists... I copied them straight from the output of sheer -h (and sheer index -h, etc). So I've updated the sheer command itself and what it outputs with -h as well as the README.

README.md Outdated
Copy link
Contributor

Choose a reason for hiding this comment

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

Please capitalize Homebrew.

@Scotchester
Copy link
Contributor

All good with me, now! 👍 @rosskarchner, ready for mergifcation?

@rosskarchner
Copy link
Contributor

Roll that beautiful bean footage.

rosskarchner added a commit that referenced this pull request Mar 31, 2015
Bring text from "Understanding Sheer" wiki page into README
@rosskarchner rosskarchner merged commit c01164c into cfpb:master Mar 31, 2015
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants