Skip to content

Commit a1f1a7a

Browse files
ddimatosfernandofloresg
ddimatos
and
fernandofloresg
authored
Update development branch with the same changes pushed to 1.13.0 (cherry-pick) (#1974)
* Update release 1.13.0 staging branch with the latest changes for docs. (#1973) * Added new doc and cleaned up old Signed-off-by: ddimatos <[email protected]> Conflicts: docs/source/resources/releases_maintenance.rst Changes to be committed: modified: docs/ansible_content.rst new file: docs/source/_static/css/table.css new file: docs/source/_static/my_theme.css new file: docs/source/character_set.rst new file: docs/source/collection-requirements.rst modified: docs/source/conf.py new file: docs/source/configuration.rst modified: docs/source/index.rst deleted: docs/source/installation.rst deleted: docs/source/license.rst new file: docs/source/life-cycle.rst deleted: docs/source/playbooks.rst deleted: docs/source/reference/community.rst deleted: docs/source/reference/documentation.rst deleted: docs/source/requirements-single.rst deleted: docs/source/requirements_managed.rst deleted: docs/source/resources/character_set.rst deleted: docs/source/resources/resources.rst deleted: plugins/modules/__init__.py * Doc updates to map to parent site Signed-off-by: ddimatos <[email protected]> * Move ansible_content to source directory Signed-off-by: ddimatos <[email protected]> * Coloring of keywords fixed Signed-off-by: ddimatos <[email protected]> * update css Signed-off-by: ddimatos <[email protected]> * Update release table to use relative link Signed-off-by: ddimatos <[email protected]> * Corrected sed command that had regressed with a missing space Signed-off-by: ddimatos <[email protected]> * update env vars Signed-off-by: ddimatos <[email protected]> * Update docs with better formating. Signed-off-by: ddimatos <[email protected]> * Update collection names case Signed-off-by: ddimatos <[email protected]> * update links Signed-off-by: ddimatos <[email protected]> * Fix link Signed-off-by: ddimatos <[email protected]> * Formatting Signed-off-by: ddimatos <[email protected]> * Correct usage of code block Signed-off-by: ddimatos <[email protected]> * Update config with new format Signed-off-by: ddimatos <[email protected]> * Update collection dependencies Signed-off-by: ddimatos <[email protected]> * Update EOL year Signed-off-by: ddimatos <[email protected]> * Update expanding option color Signed-off-by: ddimatos <[email protected]> * Update the keywowrd formating Signed-off-by: ddimatos <[email protected]> * Update code snippt formatting Signed-off-by: ddimatos <[email protected]> * Update release notes to reflect the latest releases Signed-off-by: ddimatos <[email protected]> Conflicts: docs/source/release_notes.rst Changes to be committed: modified: docs/source/release_notes.rst * Revert changes back to use double quotes with escape to avoid sanity test failure Signed-off-by: ddimatos <[email protected]> * File should never had been included Signed-off-by: ddimatos <[email protected]> * Delete unused content Signed-off-by: ddimatos <[email protected]> * Update copyright year Signed-off-by: ddimatos <[email protected]> * Mac vs Nix sed variant fix Signed-off-by: ddimatos <[email protected]> * Update readme to remove redundant content Signed-off-by: ddimatos <[email protected]> --------- Signed-off-by: ddimatos <[email protected]> * Update character_set.rst --------- Signed-off-by: ddimatos <[email protected]> Co-authored-by: Fernando Flores <[email protected]>
1 parent 13ca5d0 commit a1f1a7a

28 files changed

+2377
-1758
lines changed

‎README.md

Lines changed: 2 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -164,26 +164,8 @@ As Red Hat Ansible [Certified Content](https://catalog.redhat.com/software/searc
164164

165165
## Release Notes and Roadmap
166166

167-
The collection's cumulative release notes can be reviewed [here](https://ibm.github.io/z_ansible_collections_doc/ibm_zos_core/docs/source/release_notes.html). Note, some collections release before an ansible-core version reaches End of Life (EOL), thus the version of ansible-core that is supported must be a version that is currently supported.
168-
169-
For AAP users, to see the supported ansible-core versions, review the [AAP Life Cycle](https://access.redhat.com/support/policy/updates/ansible-automation-platform).
170-
171-
For Galaxy and GitHub users, to see the supported ansible-core versions, review the [ansible-core support matrix](https://docs.ansible.com/ansible/latest/reference_appendices/release_and_maintenance.html#ansible-core-support-matrix).
172-
173-
<br/>The collection's changelogs can be reviewed in the following table.
174-
175-
| Version | Status | Release notes | Changelogs |
176-
|----------|----------------|---------------|------------|
177-
| 1.14.x | In development | unreleased | unreleased |
178-
| 1.13.x | Current | [Release notes](https://ibm.github.io/z_ansible_collections_doc/ibm_zos_core/docs/source/release_notes.html#version-1-13-0.beta.1) | [Changelogs](https://github.com/ansible-collections/ibm_zos_core/blob/v1.13.0-beta.1/CHANGELOG.rst) |
179-
| 1.12.x | Released | [Release notes](https://ibm.github.io/z_ansible_collections_doc/ibm_zos_core/docs/source/release_notes.html#version-1-12-0) | [Changelogs](https://github.com/ansible-collections/ibm_zos_core/blob/v1.12.0/CHANGELOG.rst) |
180-
| 1.11.x | Released | [Release notes](https://ibm.github.io/z_ansible_collections_doc/ibm_zos_core/docs/source/release_notes.html#version-1-11-0) | [Changelogs](https://github.com/ansible-collections/ibm_zos_core/blob/v1.11.0/CHANGELOG.rst) |
181-
| 1.10.x | Released | [Release notes](https://ibm.github.io/z_ansible_collections_doc/ibm_zos_core/docs/source/release_notes.html#version-1-10-0) | [Changelogs](https://github.com/ansible-collections/ibm_zos_core/blob/v1.10.0/CHANGELOG.rst) |
182-
| 1.9.x | Released | [Release notes](https://ibm.github.io/z_ansible_collections_doc/ibm_zos_core/docs/source/release_notes.html#version-1-9-2) | [Changelogs](https://github.com/ansible-collections/ibm_zos_core/blob/v1.9.2/CHANGELOG.rst) |
183-
| 1.8.x | Released | [Release notes](https://ibm.github.io/z_ansible_collections_doc/ibm_zos_core/docs/source/release_notes.html#version-1-8-0) | [Changelogs](https://github.com/ansible-collections/ibm_zos_core/blob/v1.8.0/CHANGELOG.rst) |
184-
| 1.7.x | Released | [Release notes](https://ibm.github.io/z_ansible_collections_doc/ibm_zos_core/docs/source/release_notes.html#version-1-7-0) | [Changelogs](https://github.com/ansible-collections/ibm_zos_core/blob/v1.7.0/CHANGELOG.rst) |
185-
| 1.6.x | Released | [Release notes](https://ibm.github.io/z_ansible_collections_doc/ibm_zos_core/docs/source/release_notes.html#version-1-6-0) | [Changelogs](https://github.com/ansible-collections/ibm_zos_core/blob/v1.6.0/CHANGELOG.rst) |
186-
| 1.5.x | Released | [Release notes](https://ibm.github.io/z_ansible_collections_doc/ibm_zos_core/docs/source/release_notes.html#version-1-5-0) | [Changelogs](https://github.com/ansible-collections/ibm_zos_core/blob/v1.5.0/CHANGELOG.rst) |
167+
The collection's cumulative [release notes](https://ibm.github.io/z_ansible_collections_doc/ibm_zos_core/docs/source/release_notes.html) are an easy way to review changes. The collection [Life Cycle](https://ibm.github.io/z_ansible_collections_doc/ibm_zos_core/docs/source/life-cycle.html) also referred to as the Roadmap contains changelog details, support dates and the current level of support
168+
for each collection. For a complete guide to support, review the **Ansible for IBM Z** [Collection Life Cycles](https://ibm.github.io/z_ansible_collections_doc/collections_content/collection-life-cycles.html#life-cycles).
187169

188170
## Related Information
189171

‎docs/Makefile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -158,9 +158,9 @@ module-doc:
158158
@echo "Reverting edited source file."
159159
scripts/post-template.sh
160160

161-
@if test -e ../plugins/modules/__init__.py.skip; \
161+
@if test -e ../plugins/modules/__init__.py.skip; then \
162162
echo "Rename file '../plugins/modules/__init__.py.skip' back to ../plugins/modules/__init__.py.'"; \
163-
then mv -f ../plugins/modules/__init__.py.skip ../plugins/modules/__init__.py; \
163+
mv -f ../plugins/modules/__init__.py.skip ../plugins/modules/__init__.py; \
164164
fi
165165

166166
@echo $(line_header)

‎docs/ansible_content.rst

Lines changed: 0 additions & 37 deletions
This file was deleted.

‎docs/scripts/post-zos_apf.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,5 +28,5 @@ SCRIPT_DIR=`dirname "$0"`
2828
CURR_PATH=`pwd`
2929
# Delete any temporary index RST
3030
if [[ -f $CURR_PATH/source/modules/zos_apf.rst ]]; then
31-
sed -i'' -e "s/\> \\*\//\> \\\*\//g" $CURR_PATH/source/modules/zos_apf.rst
31+
sed -i '' -e "s/\> \\*\//\> \\\*\//g" $CURR_PATH/source/modules/zos_apf.rst
3232
fi

‎docs/scripts/pre-template.sh

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,13 @@
2727

2828
template_doc_source=`ansible-config dump|grep DEFAULT_MODULE_PATH| cut -d'=' -f2|sed 's/[][]//g' | tr -d \'\" |sed 's/modules/doc_fragments\/template.py/g'`
2929
cp $template_doc_source $template_doc_source.tmp
30-
sed -i'' -e "s/\"\\\\n\"/'\\\\\\\\n'/g" $template_doc_source
31-
sed -i'' -e "s/\"\\\\r\"/'\\\\\\\\r'/g" $template_doc_source
32-
sed -i'' -e "s/\"\\\\r\\\\n\"/'\\\\\\\\r\\\\\\\\n'/g" $template_doc_source
30+
31+
if [[ "$OSTYPE" == "darwin"* ]]; then
32+
sed -i '' -e "s/\"\\\\n\"/'\\\\\\\\n'/g" $template_doc_source
33+
sed -i '' -e "s/\"\\\\r\"/'\\\\\\\\r'/g" $template_doc_source
34+
sed -i '' -e "s/\"\\\\r\\\\n\"/'\\\\\\\\r\\\\\\\\n'/g" $template_doc_source
35+
else
36+
sed -i -e "s/\"\\\\n\"/'\\\\\\\\n'/g" $template_doc_source
37+
sed -i -e "s/\"\\\\r\"/'\\\\\\\\r'/g" $template_doc_source
38+
sed -i -e "s/\"\\\\r\\\\n\"/'\\\\\\\\r\\\\\\\\n'/g" $template_doc_source
39+
fi

‎docs/source/_static/css/custom.css

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
.rst-content dl:not(.docutils) dt:first-child {
2+
margin-top: 0;
3+
}
4+
5+
.rst-content dl:not(.docutils) dl dt {
6+
margin-bottom: 4px;
7+
border: none;
8+
border-left: solid 3px #ccc;
9+
background: #f0f0f0;
10+
color: #555;
11+
}
12+
13+
.rst-content dl table,
14+
.rst-content dl ul,
15+
.rst-content dl ol,
16+
.rst-content dl p {
17+
margin-bottom: 8px !important;
18+
}
19+
20+
.rst-content dl:not(.docutils) dt {
21+
display: table;
22+
margin: 6px 0;
23+
font-size: 90%;
24+
line-height: normal;
25+
background: #e7f2fa;
26+
color: #2980B9;
27+
border-top: solid 3px #6ab0de;
28+
padding: 6px;
29+
position: relative;
30+
}
31+
32+
html.writer-html5 .rst-content dl.field-list {
33+
display: initial;
34+
}
35+
36+
html.writer-html5 .rst-content dl.field-list>dd,
37+
html.writer-html5 .rst-content dl.field-list>dt {
38+
margin-bottom: 4px;
39+
padding-left: 6px;
40+
}
41+
42+
p {
43+
line-height: 20px;
44+
font-size: 16px;
45+
}
46+
47+
html.writer-html5 .rst-content dl.field-list>dt:after {
48+
content: initial;
49+
}
50+
51+
body{
52+
font-family:"Arial", Helvetica, sans-serif;
53+
}

‎docs/source/_static/css/table.css

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
.wy-table-responsive table td, .wy-table-responsive table th {
2+
white-space: inherit;
3+
}

‎docs/source/_static/my_theme.css

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
.wy-nav-content {
2+
max-width: none;
3+
}

‎docs/source/ansible_content.rst

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
.. _ibm-zos_core-collection:
2+
3+
=========
4+
z/OS Core
5+
=========
6+
7+
The **IBM z/OS core collection** is part of the Red Hat® *Ansible Certified Content
8+
for IBM Z®* offering that brings Ansible automation to IBM Z®. This collection
9+
brings forward the possibility to manage batch jobs, perform program authorizations,
10+
run operator operations, and execute both JES and MVS commands as well as execute
11+
shell, python, and REXX scripts. It supports data set creation, searching, copying,
12+
fetching, and encoding. It provides both archive and unarchive of data sets,
13+
initializing volumes, performing backups and supports Jinja templating.
14+
15+
System programmers can enable pipelines to setup, tear down and deploy applications
16+
while system administrators can automate time consuming repetitive tasks inevitably
17+
freeing up their time. New z/OS users can find comfort in Ansible's familiarity and
18+
expedite their proficiency in record time.
19+
20+
.. _ibm_zos_core:
21+
https://galaxy.ansible.com/ibm/ibm_zos_core
22+
.. _Z Open Automation Utilities:
23+
https://www.ibm.com/support/knowledgecenter/SSKFYE
24+
25+
.. toctree::
26+
:maxdepth: 1
27+
:caption: Collection Content
28+
29+
plugins
30+
modules
31+
filters

0 commit comments

Comments
 (0)