| Summary: | [Docs] [RFE] [Managing Providers] Update the structure of the Managing Providers guide | ||
|---|---|---|---|
| Product: | Red Hat CloudForms Management Engine | Reporter: | Andrew Dahms <adahms> |
| Component: | Documentation | Assignee: | Dayle Parker <dayleparker> |
| Status: | CLOSED CURRENTRELEASE | QA Contact: | Chris Budzilowicz <cbudzilo> |
| Severity: | medium | Docs Contact: | |
| Priority: | medium | ||
| Version: | 5.6.0 | CC: | cbudzilo, hhudgeon, jhardy, obarenbo |
| Target Milestone: | GA | Keywords: | FutureFeature |
| Target Release: | 5.8.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: | 2017-06-02 03:51:07 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: | |
Assigning to Dayle for review. Dayle - nothing above is written in stone, and by all means let me know if you notice anything else along the way that might be a good one for us to address at the same time. Status: WIP. Updates (checked into Github, branch BZ1371751-providers): Preface: * Added a general paragraph defining providers as a concept. Chapter 1. Infrastructure Providers * Added sentence about adding infrastructure providers individually or via discovery. Chapter 2. Configuration Management Providers * Added description intro paragraph. * Added sentence about how to add them to CF. [TO DO] Added placeholder thumbnail overview image - needs editing. Chapter 3. Cloud Providers * Added description intro paragraph. * Added sentence about how to add them to CF (ind. or via discovery). * Added section: Discovering Cloud Providers. [TO DO] Added placeholder thumbnail overview image - needs editing. Chapter 4. Network Providers * Added description intro paragraph. * Added sentence about how to add them to CF (ind. or via discovery). [TO DO] Added placeholder thumbnail overview image - needs editing. Chapter 5. Containers Providers * Added description intro paragraph. [TO DO] Added placeholder thumbnail overview image - needs editing. Changing the QA contact to cbudizlo based on discussion during the CloudForms documentation meeting. Thanks Chris! I forgot to link to https://github.com/ManageIQ/manageiq_docs/pull/370/. Pulled the changes into euwe as well in https://github.com/ManageIQ/manageiq_docs/pull/387. This update is now live in the 4.5 Managing Providers guide: https://access.redhat.com/documentation/en-us/red_hat_cloudforms/4.5/html-single/managing_providers/ And the 4.2 Managing Providers guide: https://access.redhat.com/documentation/en-us/red_hat_cloudforms/4.2/html-single/managing_providers/ |
The following changes must be made to the Managing Providers guide: * Add an introductory block before the first chapter to provide a basic description of what a provider is in CloudForms, and the different major types (Compute, Configuration Management, Networking) * Use a standard introduction to each chapter on provider types. - Basic introductory paragraph to the type that follows the same style. - Overview of the thumbnail for that type, similar to that in the opening to the chapter on infrastructure providers but in its own section. - Methods by which providers can be added - individually or via discovery for infrastructure and cloud, individually for all others. * Add a procedure on discovering cloud providers to the chapter on cloud providers.