Bug 771788 - review/update doc for rhc-ctl-app
Summary: review/update doc for rhc-ctl-app
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Deadline: 2012-01-10
Product: OKD
Classification: Red Hat
Component: Documentation
Version: 1.x
Hardware: Unspecified
OS: Unspecified
medium
low
Target Milestone: ---
: ---
Assignee: David O'Brien
QA Contact: ecs-bugs
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2012-01-05 00:08 UTC by David O'Brien
Modified: 2015-07-19 23:50 UTC (History)
3 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2012-01-16 03:41:40 UTC
Target Upstream Version:


Attachments (Terms of Use)

Description David O'Brien 2012-01-05 00:08:24 UTC
Description of problem:

(from email request)

Hey David, I was just going through the documentation for rhc-ctl-app and I noticed that the commands for 'tidy', 'add-alias', 'remove-alias', 'threaddump' aren't in the following document:

http://docs.redhat.com/docs/en-US/OpenShift_Express/1.0/html/User_Guide/sect-User_Guide-Application_Development-Managing_Applications.html

Would you be able to add those?

Thanks

-Matt 

Version-Release number of selected component (if applicable):




Additional info:

I'll double-check but I'm 99% sure the *-alias commands are covered, perhaps in a different sub-section? Same goes for tidy. I'm not currently familiar with "threaddump" but will follow up.

Comment 1 David O'Brien 2012-01-05 04:00:03 UTC
The *-alias commands are covered in 3.5.1.1. Using Arbitrary DNS Names

http://hurl.test.redhat.com/fCDcYE

The "tidy" option is part of 4.2.1. The Disk Space Cleanup Tool

http://hurl.test.redhat.com/MgJXHo

"threaddump" doesn't appear anywhere. I have to track that down.

Comment 2 David O'Brien 2012-01-06 01:03:25 UTC
I can produce some basic content about what threaddump does and what it's for, but I don't have a solid example or procedure to use. I emailed libra-devel with the issues I was  having, but so far no response (Subject: rhc-tail-files and threaddump strangeness? Date: 01/05/2012).

If anyone can shed light on this, elaborate, etc., it would help improve the doc.

Comment 3 David O'Brien 2012-01-06 02:40:09 UTC
I've spoken to szhou on IRC about this and sorted out the issues I was having (afaict). Should have some draft doc available by COB Friday.

Comment 4 David O'Brien 2012-01-06 04:13:19 UTC
Think I've covered this ok. Needs tech review. Currently building on brew. Should be available in an hour or two.

OpenShift_Express-User_Guide-2.0-web-en-US-2.2.3-1.el6eng
http://brewweb.devel.redhat.com/brew/taskinfo?taskID=3922504

It'll be part of Chapter 4 (below) when it appears:
http://hurl.test.redhat.com/pLDkmM

Comment 6 David O'Brien 2012-01-16 03:41:40 UTC
default formats published to docs.redhat.com
pdf formats published to openshift.com/docs


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