Bug 1704975

Summary: [DOCS] Missing sub-step in operator sdk tutorial
Product: OpenShift Container Platform Reporter: Luke Stanton <lstanton>
Component: DocumentationAssignee: Alex Dellapenta <adellape>
Status: CLOSED CURRENTRELEASE QA Contact: Luke Stanton <lstanton>
Severity: low Docs Contact: Vikram Goyal <vigoyal>
Priority: unspecified    
Version: 4.1.0CC: aos-bugs, jokerman, mmccomas
Target Milestone: ---   
Target Release: 4.1.0   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2019-05-06 20:40:19 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:
Bug Depends On:    
Bug Blocks: 1664187    

Description Luke Stanton 2019-04-30 23:10:43 UTC 
Document URL: 

https://docs.openshift.com/container-platform/4.1/applications/operator_sdk/osdk-getting-started.html



Section Number and Name: 

  "Building a Go-based Memcached Operator using the Operator SDK"
    --> Procedure
      --> 1. Create a new project.



Describe the issue: 

Up to this point in the documentation, all steps have been explicitly spelled out, including things like "mkdir" commands". However, under the "Create a new project" heading, the following command is given without first specifying that the directory be created:

  $ cd $GOPATH/src/github.com/example-inc/



Suggestions for improvement:

For consistency, and since this is a tutorial, specify that the directory be created first:

  $ mkdir .../example-inc, etc.



Additional information:
Comment 1 Alex Dellapenta 2019-05-03 15:24:40 UTC 
Fix merged via https://github.com/openshift/openshift-docs/pull/14684.
Comment 2 Alex Dellapenta 2019-05-06 20:40:19 UTC 
Fix published:

https://docs.openshift.com/container-platform/4.1/applications/operator_sdk/osdk-getting-started.html#building-memcached-operator-using-osdk-osdk-getting-started