Skip to content
This repository has been archived by the owner on Aug 2, 2023. It is now read-only.

Document local installation of Appsody CLI for developers #38

Closed
bschrammIBM opened this issue Aug 8, 2019 · 15 comments
Closed

Document local installation of Appsody CLI for developers #38

bschrammIBM opened this issue Aug 8, 2019 · 15 comments
Assignees
Labels
documentation-id Improvements or additions to documentation status-Yellow

Comments

@bschrammIBM
Copy link
Contributor

This is the Appsody CLI, it sets the default hub url to the Kabanero public hub. The hub can be changed to point to Champ’s hub (or manually use the CLI to change it).
There are current instructions on the Kabanero.io website:
https://kabanero.io/developer/cli/

There are new instructions included in the proposed Getting Started flow.
These instructions need to be reviewed and updated.

@alohr51 alohr51 added the documentation-id Improvements or additions to documentation label Aug 12, 2019
@jantley-ibm
Copy link
Contributor

Dev: David Harris ID: Helen Masters

@jantley-ibm jantley-ibm added the release-0.1 Kabanero Branch label Aug 29, 2019
@helenmasters
Copy link

@bschrammIBM is this task a request for a docs new page or a request to update the existing https://kabanero.io/developer/cli/ page?

Please can you also point me to the "new instructions" which you refer to in the "proposed Getting Started flow"?

@SueChaplain
Copy link
Contributor

SueChaplain commented Sep 10, 2019

@helenmasters - if this work is to update the new getting started page (see kabanero-io/kabanero-website#158), I don't think this is a huge amount of work. Let's discuss. I'm happy to own it if you are not going to be able to cover it (or assign to someone else locally).

@bschrammIBM
Copy link
Contributor Author

bschrammIBM commented Sep 11, 2019

@SueChaplain Yes It is to edit and polish the instructions for installing the Appsody CLI. One of the issues is the installation instructions are Mac-specific. Should we include instructiosn for PC too?
The instructions are on this page https://kabanero-kdsee.us-south.cf.test.appdomain.cloud/developer-tools/

The Kabanero uses Appsody as its CLI experience to access collections

Install XCode Command Line Tools and Homebrew.

xcode-select --install
To install Homebrew run:

/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
Install the Appsody plugin.

brew install appsody/appsody/appsody
Select the Kabanero Collection.

To see a list of all available public collections run:

$ appsody list
Need more help using Appsody? Learn More 

@SueChaplain
Copy link
Contributor

We've got 4 different platforms for Appsody :-/ macOS is probably the slickest if we are trying to make it look simple, so we could just link to the Appsody install topic for other platforms as a footnote?

I noticed that the VS Code install gets as far as initializing a collection (although the screen shot is missing the Appsody stacks), so we probably need to do more work to fix and balance the content a little better across these 3 tools.

@SueChaplain
Copy link
Contributor

@kSee04 - did your PR https://github.com/kabanero-io/kabanero-website/pull/161/files change this content already? It looks like it but the URL I have (https://kabanero-kdsee.us-south.cf.test.appdomain.cloud/developer-tools/) doesn't refresh ... maybe that's a stale site? Where can I preview the latest changes for the Getting Started please?

@alohr51
Copy link
Member

alohr51 commented Sep 11, 2019

@SueChaplain we have a couple of test instances you can see the above changes on https://kabanero.us-south.cf.test.appdomain.cloud/developer-tools/

@SueChaplain
Copy link
Contributor

I believe this work has been handled by @kSee04, so think this can be closed. @bschrammIBM ?

@SueChaplain
Copy link
Contributor

@alohr51 we are trying to go through the open issues and close any out that are complete. We believe this one is done but perhaps held back with the Getting Started section. Is there a preview of this work to double check please? The one provided in an earlier comment is no longer live.

Any idea when Getting Started will make it to production? Thanks!

@marikaj123
Copy link
Member

@alohr51 - Hi Andrew, any status update on this issue would be appreciated.

@alohr51
Copy link
Member

alohr51 commented Oct 3, 2019

so looks like this is blocked on kabanero-io/kabanero-website/issues/193 which involves getting the new content from Alan and Nate for the dev tools section of the new experience.

Although, if design (cc @mdenby) decided this could be a doc/guide instead of on a page in the website, then doc team could probably go ahead and create that install doc/guide and be unblocked. Then the website could link to the doc/guide when it talks about the Appsody CLI in the dev tools section

@SueChaplain
Copy link
Contributor

Is this still a valid issue?

so looks like this is blocked on kabanero-io/kabanero-website/issues/193 which involves getting the new content from Alan and Nate for the dev tools section of the new experience.

Might it not be superseded by the content coming from Alan and Nate? If not, we need visibility of the work that's underway in order to contribute some changes. If there is no change in status by 14th October this issue is unlikely to make the 18th October date.

@mingcyu
Copy link

mingcyu commented Nov 4, 2019

Need to discuss with Alan whether this is still needed given the page is being replaced

@mingcyu
Copy link

mingcyu commented Nov 7, 2019

@ralanlittle Alan, is this issue still needed given that it will be replaced per discussion above?

@mingcyu
Copy link

mingcyu commented Nov 18, 2019

Closing issue as no strong opinion. Please reopen if needed

@mingcyu mingcyu closed this as completed Nov 18, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation-id Improvements or additions to documentation status-Yellow
Projects
None yet
Development

No branches or pull requests

7 participants