add how do i install oshinko cli article #244
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| // Module included in the following assemblies: | ||
| // | ||
| // <List assemblies here, each on a new line> | ||
| [id='install-oshinko-cli'] | ||
| = install the Oshinko command line interface tool | ||
|
There was a problem hiding this comment. this is actually a small artifact of our current "How do I" article format. we basically append the title to "How do I ....", i think it might be possible to programmatically fix this inline. i'll do some research. |
||
| :page-layout: howdoi | ||
| :page-menu_entry: How do I? | ||
|
|
||
| The Oshinko command line interface(CLI) tool is a binary application that gives you | ||
|
There was a problem hiding this comment. space between 'interface' and '(CLI)' |
||
| another option for creating and managing Apache Spark clusters on OpenShift. | ||
|
|
||
| .Prerequisites | ||
|
|
||
| * A Linux or MacOSX command terminal | ||
|
There was a problem hiding this comment. This is fine, but our group has adopted the convention of using passive sentences for rereqs. So this would be: There was a problem hiding this comment. Just a nitpicking comment, the name officially changed from MacOSX to macOS :) |
||
|
|
||
| .Procedure | ||
|
|
||
| . Download the Oshinko CLI tool archive appropriate for your operating system | ||
| from the link:https://github.com/radanalyticsio/oshinko-cli/releases[project Releases page]. | ||
|
|
||
| . Extract the `oshinko` binary from the archive to a location that is in your | ||
| terminal's `PATH`. | ||
|
There was a problem hiding this comment. Not sure why path is formatted this way. Maybe ..in your terminal's path, for example... (Or maybe that doesn't make sense?) There was a problem hiding this comment. so, i put "PATH" in the block quotes because i am referencing the environment variable of the same name, the standard convention for adding something to the path. maybe that is too specific though, i will switch it. |
||
|
|
||
| .Additional resources | ||
|
|
||
| * link:https://github.com/radanalyticsio/oshinko-cli[Oshinko CLI project repository] | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
wondering if how to install oshinko cli should be the first how-to that people see
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
++
we have an open issue (#218) that speaks to a need for ordering on these things. i haven't come across a good solution to the problem.
i think some sort of categorized sections would be good, but i'm not sure what those categories should be. this is complicated by articles that straddle 2+ boundaries. totally open to suggestions here.