search

IBM / ibm_zos_zosmf

Ansible collection to work with z/OS based on z/OS Management Facility (z/OSMF).
21 stars 14 forks source link

CPM role Initial draft v1 #1

Closed viane closed 4 years ago

zosmf-Robyn commented 4 years ago

About README files:

We made some improvements for all README files under branch "master" based on ID reviewing feedback, please make sure to follow below overall rules:

Overall rules:

  1. All titles should follow: Only first letter of first word is capitalized.
  2. Make the header title is same as that in the section "## Contents" of "README.md".
  3. Use "name - Description." for the items in a list.
  4. Be careful for typo issues and incorrect links.
    • typo issues: i.e. Provison, middlewares, requireed, foramt
    • incorrect links: i.e. provision_software_service -- please make sure the role name is same as the sub-directory name under the directory "roles/".
  5. Below are some simple templates. For more details about wording, please refer to the latest README files under the branch "master".

Simple template for README_component_name_1 under "docs/":

# Header title
Overview description.

## Modules
- `module_name_1` - Description.

### Module documentation
For information about the modules, use the [ansible-doc](https://docs.ansible.com/ansible/latest/cli/ansible-doc.html) command:
\```
ansible-doc ibm.ibm_zos_zosmf.module_name_1
、```

## Roles
- [role_name_1](../roles/role_name_1/README.md) - Description.

## Requirements
Observe the following requirements.
### Control node
### Managed node

## Usage
The collection provides various sample playbooks to demonstrate the use of modules and roles in the directory [examples](../examples/README.md).

## Test
See the section [Test documentation: component_name_1](../tests/component_name_1/README.md).

## Copyright
© Copyright IBM Corporation 2020.

Simple template for README under "roles/role_name_1/":

# Ansible role: role_name_1
Overview description.

## Role variables
The available role variables are described as follows.
- `available_name_1` - Description.

## Requirements
See the section [Requirements](../../docs/README_component_name_1.md#Requirements). 

## Dependencies

## Usage
For a sample playbook, see [sample_role_${role_name_1}.yml](../../examples/sample_role_${role_name_1}.yml) in the directory [examples](../../examples/README.md).

## Test
For a test playbook, see [test_role_${role_name_1}.yml](../../tests/component_name_1/test_role_${role_name_1}.yml) in the directory [tests/component_name_1](../../tests/component_name_1/README.md).

## Copyright
© Copyright IBM Corporation 2020.

And please add your DCO signed-off on each commit otherwise PR check will fail.