Bug 704612

4.2 Using RHUI Manager

"which allows you to view and change information for individual CDSs."

Pet Peeve: I hate the abbreviation CDS, since pluralizing it always looks funny. Might want to consider "CDS instances" here.

-----

"... to display and change the synchronization schedules for CDSs and repositories..."

If you succumbed to my OCD from the previous comment, change it here too.

-----

"... used to create new entitlement certificates and configuration RPMs."

Change to "client configuration RPMs".

-----

"The Entitlements Manager screen is used to list entitled products in the current content certificate, and upload new certificates. "

No comma.

-----

4.3 Shell Prompt

"Specify the name of the repository with the --repo_id flag: "

Might want to explicitly point out the repo ID is gotten from the command right above it: "repo list". It's the only place in all of RHUI they see the ID instead of the name, so I want to make sure it's clear where it came from.

-----

Ok, I just realized the package commands use repo ID as well. So maybe in "repo list" itself make a note that the repo ID displayed is used throughout the shell commands.

-----

"rhui-manager packages upload
    Use this command to upload a new content certificate."

This should say "to upload a new package to a custom repository."

-----

"full path to an .rpm file, or directory containing .rpm files"

No comma.

-----

"or directory containing .rpm files with the --packages flag."

Might want to mention that only .rpm files in this directory will be uploaded, but that may be overkill.

-----

"(where an output of 0 means the CDS is running, and any other output means one or more CDS instances have failed)."

I'd change that to something like "output of 0 means the RHUI is running", since it means everything is happy.

(In reply to comment #0)
> "Red Hat content certificate private key."
> 
> Content certificate _and_ private key.
> 

<para>
	Red Hat content certificate and private key. This information is provided by Red Hat, and provides access to the repositories.
</para>

> -----
> 
> "After the first login, a certificate is stored at ~/.rhui that identifies the
> user with the RHUA for all future calls, and prevents you from having to log in
> each time."
> 
> Comma feels weird. Could also be rephrased:

<para>
	This login is used for the initial connection to the RHUA. After the first login, a certificate is stored at <filename>~/.rhui</filename> that identifies the user with the RHUA for all future calls and prevents you from having to log in each time.
</para>

> 
> "After the first login, a certificate is stored at ~/.rhui that identifies the
> user with the RHUA for all future calls, preventing the need to enter login
> credentials each time RHUI Manager is launched."
> 

Sticking with the simpler language, unless there's a subtle meaning difference in here that I've missed?


Revision 1-9

LKB

(In reply to comment #1)
> 4.2 Using RHUI Manager
> 
> "which allows you to view and change information for individual CDSs."
> 
> Pet Peeve: I hate the abbreviation CDS, since pluralizing it always looks
> funny. Might want to consider "CDS instances" here.

<para>
	From this screen, you can also access the CDS Repository Management screen, which allows you to view and change information for individual CDS instances. While in this screen, the prompt will indicate the hostname of the CDS being edited:
</para>

> 
> -----
> 
> "... to display and change the synchronization schedules for CDSs and
> repositories..."
> 
> If you succumbed to my OCD from the previous comment, change it here too.

<para>
	The Synchronization Status and Scheduling screen is used to display and change the synchronization schedules for CDS instances and repositories, and view past synchronizations. You can also trigger individual synchronizations.
</para>

> 
> -----
> 
> "... used to create new entitlement certificates and configuration RPMs."
> 
> Change to "client configuration RPMs".

<varlistentry>
<term> <guilabel>Create Certificates and Client Configuration RPMs</guilabel> </term>
	 <listitem>
		<para>
			The Create Certificates and Configuration RPMs screen is used to create new entitlement certificates and client configuration RPMs.
		</para>
	</listitem>
</varlistentry>

> 
> -----
> 
> "The Entitlements Manager screen is used to list entitled products in the
> current content certificate, and upload new certificates. "
> 
> No comma.
> 

<para>
	The Entitlements Manager screen is used to list entitled products in the current content certificate and upload new certificates.
</para>


Revision 1-9

LKB

(In reply to comment #2)
> 4.3 Shell Prompt
> 
> "Specify the name of the repository with the --repo_id flag: "
> 
> Might want to explicitly point out the repo ID is gotten from the command right
> above it: "repo list". It's the only place in all of RHUI they see the ID
> instead of the name, so I want to make sure it's clear where it came from.

<para>
	Displays information about a specified repository. Specify the name of the repository with the <command>--repo_id</command> flag. The repository ID is shown in the output of the <command>rhui-manager repo list</command> command.
</para>

> 
> -----
> 
> Ok, I just realized the package commands use repo ID as well. So maybe in "repo
> list" itself make a note that the repo ID displayed is used throughout the
> shell commands.

Went the other way, in an effort to get discrete units of information:

<para>
	Displays a list of all packages in a repository. Specify the name of the repository with the <command>--repo_id</command> flag. The repository ID is shown in the output of the <command>rhui-manager repo list</command> command:
</para>

and ...
 
> -----
> 
> "rhui-manager packages upload
>     Use this command to upload a new content certificate."
> 
> This should say "to upload a new package to a custom repository."
> 
> -----
> 
> "full path to an .rpm file, or directory containing .rpm files"
> 
> No comma.

<para>
	Use this command to upload a new package to a customer repository. Specify the repository to upload the packages to with the <command>--repo_id</command> flag, and the full path to an <filename>.rpm</filename> file or directory containing <filename>.rpm</filename> files with the <command>--packages</command> flag. The repository ID is shown in the output of the <command>rhui-manager repo list</command> command.
</para>

> 
> -----
> 
> "or directory containing .rpm files with the --packages flag."
> 
> Might want to mention that only .rpm files in this directory will be uploaded,
> but that may be overkill.

+1 overkill.

> 
> -----
> 
> "(where an output of 0 means the CDS is running, and any other output means one
> or more CDS instances have failed)."
> 
> I'd change that to something like "output of 0 means the RHUI is running",
> since it means everything is happy.

<para>
	Use the <command>--code</command> flag to display a code that reflect the state of the RHUI (where an output of <computeroutput>0</computeroutput> means the RHUI is running, and any other output means one or more CDS instances have failed).
</para>


Revision 1-9.

LKB

Most of the thing have been covered.

This book is now available at http://docs.redhat.com/docs/en-US/Red_Hat_Update_Infrastructure/2.0/html/Installation_Guide/index.html

Please raise a new bug for any further changes.

LKB