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

More involved README restructuring #764

Closed
wants to merge 3 commits into
base: master
from

Conversation

Projects
None yet
3 participants
@ryan-williams
Member

ryan-williams commented Aug 10, 2015

This builds off of #763:

  • Move description of Avro, Parquet, Spark to end, in "Under the Hood" section
  • Clarify simple CLI use of count_kmers; save more involved scala-code-snippet for adam-shell example later on.
  • Update some links to non-incubator, yes-apache-project versions.
  • De-duplicate blocks showing arg-less adam-submit and adam-submit transform commands and their full output.
    • Update sample output of these commands.
  • Move info about installing Spark and setting up ADAM aliases into "Installing" section.

There's probably too much going on to get much out of Github's "rich diff", so you might want to just look at the new version in its entirety.

ryan-williams added some commits Aug 10, 2015

More involved README restructuring
- Move description of Avro, Parquet, Spark to end, in "Under the Hood" section
- Clarify simple CLI use of `count_kmers`; save more involved scala-code-snippet for `adam-shell` example later on.
- Update some links to non-incubator, yes-apache-project versions.
- De-duplicate blocks showing arg-less `adam-submit` and `adam-submit transform` commands and their full output.
- Move info about installing Spark and setting up ADAM aliases into "Installing" section
More README fixes
- fix relative intra-page links
- update example output of arg-less `adam-submit` and `adam-submit transform` calls
- move "applications" to their own section at the end
@fnothaft

This comment has been minimized.

Show comment
Hide comment
@fnothaft

fnothaft Aug 10, 2015

Member

This looks really good to me! Thanks @ryan-williams. I will leave this open for more comment.

Member

fnothaft commented Aug 10, 2015

This looks really good to me! Thanks @ryan-williams. I will leave this open for more comment.

# Getting Started
## Installation
### Binary Distributions
Bundled release binaries can be found on our [releases][] page.

This comment has been minimized.

@massie

massie Aug 11, 2015

Member

Missing URL?

@massie

massie Aug 11, 2015

Member

Missing URL?

This comment has been minimized.

@massie

massie Aug 11, 2015

Member

Or wait, I think that would point to https://github.com/bigdatagenomics/adam/releases?

@massie

massie Aug 11, 2015

Member

Or wait, I think that would point to https://github.com/bigdatagenomics/adam/releases?

@massie

This comment has been minimized.

Show comment
Hide comment
@massie

massie Aug 11, 2015

Member

+1

Ignore my comment noise re: the releases URL. Let's merge this later today.

For other reviewers, if you click the "View" button at the top of the "Files Changed" tab you can view the page as it will be displayed. Looks good.

Member

massie commented Aug 11, 2015

+1

Ignore my comment noise re: the releases URL. Let's merge this later today.

For other reviewers, if you click the "View" button at the top of the "Files Changed" tab you can view the page as it will be displayed. Looks good.

@ryan-williams

This comment has been minimized.

Show comment
Hide comment
@ryan-williams

ryan-williams Aug 12, 2015

Member

Random related q: what is/should be the purpose of the docs/ directory and its relationship to README.md? Is it published anywhere?

Member

ryan-williams commented Aug 12, 2015

Random related q: what is/should be the purpose of the docs/ directory and its relationship to README.md? Is it published anywhere?

@fnothaft

This comment has been minimized.

Show comment
Hide comment
@fnothaft

fnothaft Aug 13, 2015

Member

@ryan-williams the docs/ directory is a set of Pandoc markdown files that are intended to serve as longer, more verbose documentation (i.e., documentation beyond the README). We build and distribute these via the distribution artifact (which is only built when you do mvn package -P distribution).

Member

fnothaft commented Aug 13, 2015

@ryan-williams the docs/ directory is a set of Pandoc markdown files that are intended to serve as longer, more verbose documentation (i.e., documentation beyond the README). We build and distribute these via the distribution artifact (which is only built when you do mvn package -P distribution).

@fnothaft

This comment has been minimized.

Show comment
Hide comment
@fnothaft

fnothaft Aug 13, 2015

Member

Thanks @ryan-williams! This is great; thanks for taking it on. I've committed this manually as 20ded3d.

Member

fnothaft commented Aug 13, 2015

Thanks @ryan-williams! This is great; thanks for taking it on. I've committed this manually as 20ded3d.

@fnothaft fnothaft closed this Aug 13, 2015

@fnothaft fnothaft deleted the readme2 branch Aug 13, 2015

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