Bug 1704975 - [DOCS] Missing sub-step in operator sdk tutorial
Summary: [DOCS] Missing sub-step in operator sdk tutorial
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Documentation
Version: 4.1.0
Hardware: Unspecified
OS: Unspecified
unspecified
low
Target Milestone: ---
: 4.1.0
Assignee: Alex Dellapenta
QA Contact: Luke Stanton
Vikram Goyal
URL:
Whiteboard:
Depends On:
Blocks: 1664187
TreeView+ depends on / blocked
 
Reported: 2019-04-30 23:10 UTC by Luke Stanton
Modified: 2019-05-06 20:40 UTC (History)
3 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2019-05-06 20:40:19 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

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.


Note You need to log in before you can comment on or make changes to this bug.