Skip to content

ansible/README incorrectly links to main OW README for verification step #2225

Open
@mrutkows

Description

@mrutkows

Environment details:

Mac was used, but this applies to ANY (native) instructions that take you the Ansible README.

Steps to reproduce the issue:

  1. Follow all (mac) instructions to prepare system, up through and include those provided within the "<openwhisk_home>/ansible/README.md" up until section titled "Verification after deployment"

Instructions read as follows:
Verification after Deployment

After a successful deployment you can use the wsk CLI (located in the bin folder of the repository) to verify that OpenWhisk is operable. See main README for instructions on how to setup and use wsk.

However, the README is hyperlinked to: "<openwhisk_home>/ansible/README.md"

which provides no direct or links to actually installing using the CLI (in fact, coming from mac setup instructions which has a section called "Deploy" which you left by following "Follow instructions in ansible/README.md" and never return to to perform the next instruction "Configure the CLI. Follow instructions in Configure CLI"

Provide the expected results and outputs:

Expected to be either taken back to where I left off (Mac or Ubuntu native READMEs) which is likely not possible in markdown... send me to the actual CLI setup:
/docs/cli.md

However, the markdown for "cli.md" has no "verification step" at all (just config)...

It would be good to perform what was suggested on the Mac setup README (which is now 2 hyperlinks back); which states:

Use the wsk CLI

bin/wsk action invoke /whisk.system/utils/echo -p message hello --result
{
"message": "hello"
}

Additionally, by default, the test command should likely include '-i' insecure since we were performing a "dev" install.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions