#7424 Improve Realm Domains doc text
Closed: fixed 6 years ago Opened 6 years ago by pvoborni.

open mostly so that we can backport to 4.6 branch

Issue

Realm Domains has almost no doc text, it has only examples.

Steps to Reproduce

$ ipa help realmdomains
Realm domains

Manage the list of domains associated with IPA realm.

EXAMPLES:

 Display the current list of realm domains:
   ipa realmdomains-show

 Replace the list of realm domains:
   ipa realmdomains-mod --domain=example.com
   ipa realmdomains-mod --domain={example1.com,example2.com,example3.com}

 Add a domain to the list of realm domains:
   ipa realmdomains-mod --add-domain=newdomain.com

 Delete a domain from the list of realm domains:
   ipa realmdomains-mod --del-domain=olddomain.com

Topic commands:
  realmdomains-mod   Modify realm domains.
  realmdomains-show  Display the list of realm domains.

To get command help, use:
  ipa <command> --help
$ ipa realmdomains-mod --help
Usage: ipa [global-options] realmdomains-mod [options]

Modify realm domains.
Options:

Actual behavior

See above

Expected behavior

The doc text will describe what the commands are about and what behavior to expect from then.

Version/Release/Distribution

All IPA versions since Realm Domains introduction.


Metadata Update from @pvoborni:
- Custom field on_review adjusted to https://github.com/freeipa/freeipa/pull/1597

6 years ago

Metadata Update from @pvoborni:
- Issue assigned to pvoborni

6 years ago

Metadata Update from @pvoborni:
- Issue tagged with: ux

6 years ago

Metadata Update from @fbarreto:
- Issue set to the milestone: FreeIPA 4.6.4

6 years ago

master:

  • b43e731 realm domains: improve doc text

Metadata Update from @tdudlak:
- Issue close_status updated to: fixed
- Issue status updated to: Closed (was: Open)

6 years ago

Login to comment on this ticket.

Metadata