ibm / ibmi-oss-docs

IBM i Open Source Documentation

IBM i Open Source

This repo will act as the authoritative documentation location for all things IBM i Open Source Software including PASE (Yum, Node.js/Python/Ruby/PHP, ssh etc) and all native ILE languages (C,RPG,CL etc). If you see a mistake or see a way to make some of the docs better then please issue a pull request.

What if I would like to contribute (or suggest changes) to this documentation?

This documentation is open source! Please feel free to help this documentation grow in terms of volume and usability! If you would like to see changes in this documentation, please do one of the following:

1. Submit an issue with the proposed changes. Please be as detailed as possible and include as much in "publishable" form as you can.

2. If you feel comfortable doing so, send a pull request. Start by forking the project, making your changes, and following the instructions here.

Contents

:maxdepth: 1

Getting Started <yum/README.md>
Setting up a User's Environment (SSH) <user_setup/README.md>
Troubleshooting <troubleshooting/README.md>
Node.js <nodejs/README.md>
Python <python/README.md>
Setting up TLS <tls/README.md>
ODBC <odbc/README.md>
Java <java/README.md>
Kafka <kafka/README.md>
Camel <camel/README.md>
Nginx <nginx/README.md>
Apache <apache/README.md>
PostgreSQL <postgresql.md>
MariaDB <mariadb/README.md>
Certbot (LetsEncrypt) <certbot.md>
ACS Clone Repo Tool <acscloner/README.md>
OpenSSL 3 Migration <yum/OPENSSL3_MIGRATION.md>
IBM Repos <yum/IBM_REPOS.md>
Third Party Repos <yum/3RD_PARTY_REPOS.md>
Porting Software to PASE <porting/README.md>
Migrating from 5733-OPS <troubleshooting/5733OPS_MIGRATION.md>

Support

• IBM i open source support

Collaboration

• Questions/comments about this site.
• Ryver forum (join here)

Where to find examples

• IBM i OSS Examples (GitHub)

Access to Source Code

• Some open source licenses, such as GPL, require that source code necessary for building the software (including patches, build recipes, etc) be made available to the public. For these packages, the source is provided in the form of source RPMs distributed at http://public.dhe.ibm.com/software/ibmi/products/pase/rpms/repo/src/

Links and other IBM i Open Source resources

• IBM i open source resources page (current)
• Previous authoritative IBMiOSS site (outdated)

ibmi-oss-docs's Issues

Fix markdown lint issues in acscloner/README.md

acscloner/README.md:3:81 MD013/line-length Line length [Expected: 80; Actual: 166]
acscloner/README.md:5:41 MD026/no-trailing-punctuation Trailing punctuation in heading [Punctuation: '?']
acscloner/README.md:7:81 MD013/line-length Line length [Expected: 80; Actual: 125]
acscloner/README.md:8:146 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]
acscloner/README.md:8:81 MD013/line-length Line length [Expected: 80; Actual: 146]
acscloner/README.md:10:32 MD026/no-trailing-punctuation Trailing punctuation in heading [Punctuation: '...']
acscloner/README.md:12 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank l
ines [Expected: 1; Actual: 0; Below] [Context: "### Source Repository"]
acscloner/README.md:13:77 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]
acscloner/README.md:15 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank l
ines [Expected: 1; Actual: 0; Below] [Context: "### Destination (IFS)"]
acscloner/README.md:18 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank l
ines [Expected: 1; Actual: 0; Below] [Context: "### Additional Operations -> Create or Update Repository Definitio
n"]
acscloner/README.md:19:81 MD013/line-length Line length [Expected: 80; Actual: 178]
acscloner/README.md:21:81 MD013/line-length Line length [Expected: 80; Actual: 100]
acscloner/README.md:21 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank l
ines [Expected: 1; Actual: 0; Below] [Context: "### Additional Operations -> Disable Repositories that Require Int
ernet Access from the IBM i System"]
acscloner/README.md:22:81 MD013/line-length Line length [Expected: 80; Actual: 257]
acscloner/README.md:24 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank l
ines [Expected: 1; Actual: 0; Below] [Context: "### Additional Operations -> Create nginx configuration file"]
acscloner/README.md:25:81 MD013/line-length Line length [Expected: 80; Actual: 170]
acscloner/README.md:29:81 MD013/line-length Line length [Expected: 80; Actual: 199]
acscloner/README.md:31:1 MD007/ul-indent Unordered list indentation [Expected: 0; Actual: 1]
acscloner/README.md:31:156 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]
acscloner/README.md:31:81 MD013/line-length Line length [Expected: 80; Actual: 156]
acscloner/README.md:32:1 MD007/ul-indent Unordered list indentation [Expected: 0; Actual: 1]
acscloner/README.md:33:1 MD007/ul-indent Unordered list indentation [Expected: 0; Actual: 1]
acscloner/README.md:33:81 MD013/line-length Line length [Expected: 80; Actual: 101]
acscloner/README.md:34:1 MD007/ul-indent Unordered list indentation [Expected: 0; Actual: 1]
acscloner/README.md:36:81 MD013/line-length Line length [Expected: 80; Actual: 139]
acscloner/README.md:38:81 MD013/line-length Line length [Expected: 80; Actual: 166]
acscloner/README.md:39:81 MD013/line-length Line length [Expected: 80; Actual: 166]
acscloner/README.md:41:81 MD013/line-length Line length [Expected: 80; Actual: 143]
acscloner/README.md:42:81 MD013/line-length Line length [Expected: 80; Actual: 104]
acscloner/README.md:43:81 MD013/line-length Line length [Expected: 80; Actual: 227]
acscloner/README.md:45:81 MD013/line-length Line length [Expected: 80; Actual: 103]
acscloner/README.md:52:81 MD013/line-length Line length [Expected: 80; Actual: 120]
acscloner/README.md:54 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2]
acscloner/README.md:55 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 3]

Add .NET section

Useful info:

• Overview of Mono, differences to MS .NET Framework implementation
• How to install
• How to connect to Db2
• How to call XMLSERVICE

Add 5799-PTL migration document

Some users have asked for more documentation on using rpms to replace PTL. Ideally, we'd have a table of what is in PTL and what replaces it in rpm and show what that there is no replacement for.

Document using pm2 to manage and keep your application online

pm2 is a daemon process manager that will help you manage and keep your application online 24/7.

This can be useful to run node.js applications in production.

[New] Document Readline applications not working in 5250

What documenation would you like added?

The Python REPL doesn't work properly (along with anything else that uses GNU Readline) in QSH / QP2TERM. When type a line of text and press enter, it echos only the first character, then when you press enter again, it echos the remainder of the line and executes it.

eg.

 > import foo
   i
 >
   mport foo
   Traceback (most recent call last):
     File "<stdin>", line 1, in <module>
   ModuleNotFoundError: No module named 'foo'
   >>>

The same thing happens with bash:

 > /QOpenSys/pkgs/bin/bash
   bash: cannot set terminal process group (30651): A system call received a par
   ameter that is not valid.
   bash: no job control in this shell
   bash-5.1$
 > echo foo
   e
 >
   cho foo
   foo
   bash-5.1$
   bash-5.1$

Node development - can't use Jest or Nodemon anymore

Describe the bug
We had version 10 of Node and we were able to use Jest for Unit Test and Nodemon. We refresh Node with version 16. For reasons I cannot explain these commands do not work anymore.

To Reproduce
Steps to reproduce the behavior:
in your project, npm i --save-dev nodemon jest
in package.json modify the scripts to contain:
"test": "jest",
"dev":"nodemon server" provided that you have a server.js module you normally run with node server.

do:
npm run dev
or
npm run test

Expected behavior
In the first case your server program should start running under Nodemon. If you edit your project, Nodemon will restart the server.
In the second case Jest will launch and try to run any test scripts you have.

Screenshots
If applicable, add screenshots to help explain your problem.

Additional context
Thanks for your attention

[Fixup] Node.js Page: Use update-alternatives rather than nodever

What improvement(s) could be made?

https://ibmi-oss-docs.readthedocs.io/en/latest/nodejs/README.html#setting-the-node-js-major-version

Should suggest using update-alternatives rather than nodever to change the node version system wide.

Fix markdown lint issues in postgresql.md

postgresql.md:3:81 MD013/line-length Line length [Expected: 80; Actual: 233]
postgresql.md:7:81 MD013/line-length Line length [Expected: 80; Actual: 206]
postgresql.md:10:1 MD014/commands-show-output Dollar signs used before commands without showing output [Context: "$ yum install postgresql12-ser..."]
postgresql.md:13:81 MD013/line-length Line length [Expected: 80; Actual: 355]
postgresql.md:17 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
postgresql.md:19 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```"]
postgresql.md:22:81 MD013/line-length Line length [Expected: 80; Actual: 119]
postgresql.md:25:1 MD014/commands-show-output Dollar signs used before commands without showing output [Context: "$ mkdir /home/postgres"]
postgresql.md:26:1 MD014/commands-show-output Dollar signs used before commands without showing output [Context: "$ chown postgres /home/postgre..."]
postgresql.md:27 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```"]
postgresql.md:32:81 MD013/line-length Line length [Expected: 80; Actual: 100]
postgresql.md:34:81 MD013/line-length Line length [Expected: 80; Actual: 107]
postgresql.md:38:1 MD014/commands-show-output Dollar signs used before commands without showing output [Context: "$ export PGDATA=/home/postgres"]
postgresql.md:40:1 MD014/commands-show-output Dollar signs used before commands without showing output [Context: "$ initdb -E UTF-8 -D /home/pos..."]
postgresql.md:45:81 MD013/line-length Line length [Expected: 80; Actual: 94]
postgresql.md:48 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```"]
postgresql.md:48 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
postgresql.md:58:1 MD014/commands-show-output Dollar signs used before commands without showing output [Context: "$ pg_ctl -D /home/postgres -l ..."]
postgresql.md:62 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```"]
postgresql.md:62 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
postgresql.md:68 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```bash"]
postgresql.md:69:1 MD014/commands-show-output Dollar signs used before commands without showing output [Context: "$ pg_ctl -D /home/postgres -l ..."]
postgresql.md:72:81 MD013/line-length Line length [Expected: 80; Actual: 113]
postgresql.md:73 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```"]
postgresql.md:73 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
postgresql.md:85:81 MD013/line-length Line length [Expected: 80; Actual: 188]
postgresql.md:86 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```"]
postgresql.md:86 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
postgresql.md:88:57 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 19]
postgresql.md:90:28 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 48]
postgresql.md:91:64 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 12]
postgresql.md:92:18 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 58]
postgresql.md:93:1 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 75]
postgresql.md:94:40 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 36]
postgresql.md:95:62 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 14]
postgresql.md:96:63 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 13]
postgresql.md:105:81 MD013/line-length Line length [Expected: 80; Actual: 108]
postgresql.md:107 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
postgresql.md:123:12 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 3]
postgresql.md:131:81 MD013/line-length Line length [Expected: 80; Actual: 96]
postgresql.md:133 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
postgresql.md:135:28 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]
postgresql.md:140:12 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 3]
postgresql.md:149:81 MD013/line-length Line length [Expected: 80; Actual: 121]
postgresql.md:151 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
postgresql.md:161:81 MD013/line-length Line length [Expected: 80; Actual: 133]
postgresql.md:163:81 MD013/line-length Line length [Expected: 80; Actual: 195]
postgresql.md:165:81 MD013/line-length Line length [Expected: 80; Actual: 86]
postgresql.md:168:1 MD014/commands-show-output Dollar signs used before commands without showing output [Context: "$ pg_ctl -D /home/postgres -l ..."]
postgresql.md:171:81 MD013/line-length Line length [Expected: 80; Actual: 173]
postgresql.md:173 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
postgresql.md:176 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```"]
postgresql.md:179:81 MD013/line-length Line length [Expected: 80; Actual: 128]
postgresql.md:183 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
postgresql.md:198:1 MD014/commands-show-output Dollar signs used before commands without showing output [Context: "$ pg_ctl -D /home/postgres -l ..."]
postgresql.md:201:81 MD013/line-length Line length [Expected: 80; Actual: 145]

Fix markdown lint issues in troubleshooting/SETTING_PATH.md

troubleshooting/SETTING_PATH.md:1 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "# Adjusting your PATH temporarily"]
troubleshooting/SETTING_PATH.md:3 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```"]
troubleshooting/SETTING_PATH.md:3 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
troubleshooting/SETTING_PATH.md:6 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```"]
troubleshooting/SETTING_PATH.md:7:81 MD013/line-length Line length [Expected: 80; Actual: 153]
troubleshooting/SETTING_PATH.md:8 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```"]
troubleshooting/SETTING_PATH.md:8 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
troubleshooting/SETTING_PATH.md:18 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "# HIGHLY Recommended: adjust your PATH permanently"]
troubleshooting/SETTING_PATH.md:18 MD025/single-title/single-h1 Multiple top level headings in the same document [Context: "# HIGHLY Recommended: adjust y..."]
troubleshooting/SETTING_PATH.md:19:81 MD013/line-length Line length [Expected: 80; Actual: 200]
troubleshooting/SETTING_PATH.md:21 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
troubleshooting/SETTING_PATH.md:24 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```"]
troubleshooting/SETTING_PATH.md:25:81 MD013/line-length Line length [Expected: 80; Actual: 87]
troubleshooting/SETTING_PATH.md:27 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
troubleshooting/SETTING_PATH.md:32:81 MD013/line-length Line length [Expected: 80; Actual: 98]
troubleshooting/SETTING_PATH.md:32 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "# Need to run globally-installed Node.js modules, or choose a Node.js version on a per-user basis?"]
troubleshooting/SETTING_PATH.md:32 MD025/single-title/single-h1 Multiple top level headings in the same document [Context: "# Need to run globally-install..."]
troubleshooting/SETTING_PATH.md:32:98 MD026/no-trailing-punctuation Trailing punctuation in heading [Punctuation: '?']
troubleshooting/SETTING_PATH.md:33:81 MD013/line-length Line length [Expected: 80; Actual: 322]
troubleshooting/SETTING_PATH.md:33:152 MD033/no-inline-html Inline HTML [Element: version]
troubleshooting/SETTING_PATH.md:34 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```"]
troubleshooting/SETTING_PATH.md:34 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
troubleshooting/SETTING_PATH.md:37 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```"]
troubleshooting/SETTING_PATH.md:38:66 MD047/single-trailing-newline Files should end with a single newline character

[New] MariaDB 10.6.x migration guide

What documenation would you like added?

MariaDB 10.3 is going out of support soon.

See https://endoflife.date/mariadb

We should create a guide documenting how to migrate/upgrade to MariaDB 10.6

Change main document to index.md?

I think it may be good to have rename the main document to index.md (the standard) so that we can have a separate README.md for GitHub to show. This would allow us to have a place to describe how to get involved, how to build the docs, etc without having to clutter our main docs page with this info.

Fix markdown lint issues in yum/3RD_PARTY_REPOS.md

yum/3RD_PARTY_REPOS.md:6:41 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]
yum/3RD_PARTY_REPOS.md:8 MD025/single-title/single-h1 Multiple top level headings in the same document [Context: "# Installation instructions"]
yum/3RD_PARTY_REPOS.md:14 MD025/single-title/single-h1 Multiple top level headings in the same document [Context: "# Repository List"]
yum/3RD_PARTY_REPOS.md:16 MD001/heading-increment/header-increment Heading levels should only increment by one level at a time [Expected: h2; Actual: h3]
yum/3RD_PARTY_REPOS.md:24 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2]
yum/3RD_PARTY_REPOS.md:27:42 MD034/no-bare-urls Bare URL used [Context: "https://twitter.com/massimofan..."]
yum/3RD_PARTY_REPOS.md:29:81 MD013/line-length Line length [Expected: 80; Actual: 126]
yum/3RD_PARTY_REPOS.md:33 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2]
yum/3RD_PARTY_REPOS.md:34 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "## The i Doctor"]
yum/3RD_PARTY_REPOS.md:37:81 MD013/line-length Line length [Expected: 80; Actual: 124]
yum/3RD_PARTY_REPOS.md:40:1 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]
yum/3RD_PARTY_REPOS.md:41 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2]
yum/3RD_PARTY_REPOS.md:42 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "## QSECOFR"]
yum/3RD_PARTY_REPOS.md:45:81 MD013/line-length Line length [Expected: 80; Actual: 136]
yum/3RD_PARTY_REPOS.md:49 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2]
yum/3RD_PARTY_REPOS.md:50 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "## SoBored"]

Determine doc format

Options include:

• readthedocs.io
• GitHub pages
• custom GH wiki integration?
• etc...

Read the Docs

readthedocs.io is designed for building and serving documentation from a git repository. It uses Sphinx to build the docs. The default doc format is ReStructuredText, though it can be used with MarkDown with a plugin. I don't believe all of the features are available with the MarkDown plugin, though.

GH Pages

GH Pages is a static site generator and publisher. It defaults to using Jekyll to build its website, however it will serve up any HTML files that are in the master branch. By using a different branch to store the source, a custom GH action can be used that generates the HTML from the source and pushes to the master branch. In this way, the source can be stored in any format and anything that can be run in GH actions can be employed. While this could use Sphinx, just like ReadTheDocs, another option would be to use mkdocs which is like Sphinx, but is designed to work with MarkDown instead of ReStructuredText.

GH Wiki

A GitHub Wiki is easy to use, but rather simplistic. It allows users to open the Wiki only to users with push access or everyone with no middle ground. Though the Wiki is stored in a git repo internally, there is currently no way to send PRs to that repo. Workarounds do exist however.

One way we could do this is to have this repo contain the same format as the wiki repo and then submit PRs to this repo. Then, a custom GH action could be written that force-pushes the merged changes to the wiki. Users would no longer be able to directly edit the wiki, though.

One limitation of the GH Wiki is that its navigational features are rather limiting. The default sidebar contains a flat list of pages. If you want to impose a hierarchy on it, you must create a custom sidebar: https://help.github.com/en/github/building-a-strong-community/creating-a-footer-or-sidebar-for-your-wiki

Migrate ODBC docs from ibmi-oss-examples

The documentation at https://github.com/IBM/ibmi-oss-examples/blob/master/odbc/odbc.md would be more appropriate here, since it's not really an "example". Considering how much we link to that page, though, we should probably replace the page with a link to the new location instead of just deleting it.

[Fixup] Yum connection troubleshooting

What example(s) need improvement?

https://github.com/IBM/ibmi-oss-docs/blob/master/troubleshooting/YUM.md

What improvement(s) could be made?

Should clean it up to separate out the use case where ibmi-repos is not installed. In net, if IBM i repos isn't installed, get it installed! If you can't get it installed, well then talk to support or something

Migrate from recommonmark to MyST

We use recommonmark plugin to write docs in markdown format instead of restructured text, but this package has been deprecated and archived. The recommendation is to use MyST instead.

See readthedocs/recommonmark#221 for more info.

Fix markdown lint issues in yum/README.md

yum/README.md:5:81 MD013/line-length Line length [Expected: 80; Actual: 305]
yum/README.md:21:81 MD013/line-length Line length [Expected: 80; Actual: 524]
yum/README.md:27:81 MD013/line-length Line length [Expected: 80; Actual: 228]
yum/README.md:29:81 MD013/line-length Line length [Expected: 80; Actual: 140]
yum/README.md:35:81 MD013/line-length Line length [Expected: 80; Actual: 85]
yum/README.md:41:81 MD013/line-length Line length [Expected: 80; Actual: 236]
yum/README.md:43:81 MD013/line-length Line length [Expected: 80; Actual: 112]
yum/README.md:55:81 MD013/line-length Line length [Expected: 80; Actual: 209]
yum/README.md:57:81 MD013/line-length Line length [Expected: 80; Actual: 154]
yum/README.md:62:81 MD013/line-length Line length [Expected: 80; Actual: 113]
yum/README.md:65:81 MD013/line-length Line length [Expected: 80; Actual: 142]
yum/README.md:67:66 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]
yum/README.md:69:81 MD013/line-length Line length [Expected: 80; Actual: 258]
yum/README.md:71:81 MD013/line-length Line length [Expected: 80; Actual: 154]
yum/README.md:76:81 MD013/line-length Line length [Expected: 80; Actual: 113]
yum/README.md:79:81 MD013/line-length Line length [Expected: 80; Actual: 142]
yum/README.md:83:81 MD013/line-length Line length [Expected: 80; Actual: 267]
yum/README.md:85:81 MD013/line-length Line length [Expected: 80; Actual: 266]
yum/README.md:91:81 MD013/line-length Line length [Expected: 80; Actual: 110]
yum/README.md:93 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2]
yum/README.md:96:81 MD013/line-length Line length [Expected: 80; Actual: 197]
yum/README.md:100:81 MD013/line-length Line length [Expected: 80; Actual: 230]
yum/README.md:111:81 MD013/line-length Line length [Expected: 80; Actual: 359]
yum/README.md:118:81 MD013/line-length Line length [Expected: 80; Actual: 193]
yum/README.md:126:81 MD013/line-length Line length [Expected: 80; Actual: 196]
yum/README.md:128:81 MD013/line-length Line length [Expected: 80; Actual: 243]
yum/README.md:132:81 MD013/line-length Line length [Expected: 80; Actual: 338]
yum/README.md:161:81 MD013/line-length Line length [Expected: 80; Actual: 142]
yum/README.md:172:81 MD013/line-length Line length [Expected: 80; Actual: 195]
yum/README.md:213:81 MD013/line-length Line length [Expected: 80; Actual: 203]
yum/README.md:215:81 MD013/line-length Line length [Expected: 80; Actual: 213]
yum/README.md:234:31 MD026/no-trailing-punctuation Trailing punctuation in heading [Punctuation: '?']
yum/README.md:238:50 MD026/no-trailing-punctuation Trailing punctuation in heading [Punctuation: '?']
yum/README.md:240:81 MD013/line-length Line length [Expected: 80; Actual: 131]
yum/README.md:240:101 MD034/no-bare-urls Bare URL used [Context: "http://ibm.biz/ibmi-oss-suppor..."]
yum/README.md:242:72 MD026/no-trailing-punctuation Trailing punctuation in heading [Punctuation: '?']
yum/README.md:246:60 MD026/no-trailing-punctuation Trailing punctuation in heading [Punctuation: '?']
yum/README.md:248:81 MD013/line-length Line length [Expected: 80; Actual: 95]
yum/README.md:250:81 MD013/line-length Line length [Expected: 80; Actual: 121]
yum/README.md:250:121 MD026/no-trailing-punctuation Trailing punctuation in heading [Punctuation: '?']
yum/README.md:252:81 MD013/line-length Line length [Expected: 80; Actual: 175]
yum/README.md:254:81 MD013/line-length Line length [Expected: 80; Actual: 93]
yum/README.md:254:93 MD026/no-trailing-punctuation Trailing punctuation in heading [Punctuation: '?']
yum/README.md:256:81 MD013/line-length Line length [Expected: 80; Actual: 106]
yum/README.md:258:67 MD026/no-trailing-punctuation Trailing punctuation in heading [Punctuation: '?']
yum/README.md:260:81 MD013/line-length Line length [Expected: 80; Actual: 315]

Fix markdown lint issues in odbc/using.md

odbc/using.md:3:81 MD013/line-length Line length [Expected: 80; Actual: 110]
odbc/using.md:7:81 MD013/line-length Line length [Expected: 80; Actual: 467]
odbc/using.md:9 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
odbc/using.md:14:81 MD013/line-length Line length [Expected: 80; Actual: 114]
odbc/using.md:14 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "* DRIVER: The ODBC driver for ..."]
odbc/using.md:15:81 MD013/line-length Line length [Expected: 80; Actual: 98]
odbc/using.md:16:81 MD013/line-length Line length [Expected: 80; Actual: 86]
odbc/using.md:19:81 MD013/line-length Line length [Expected: 80; Actual: 481]
odbc/using.md:23:81 MD013/line-length Line length [Expected: 80; Actual: 329]
odbc/using.md:27:81 MD013/line-length Line length [Expected: 80; Actual: 126]
odbc/using.md:31:81 MD013/line-length Line length [Expected: 80; Actual: 180]
odbc/using.md:33:81 MD013/line-length Line length [Expected: 80; Actual: 275]
odbc/using.md:40 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
odbc/using.md:41:1 MD014/commands-show-output Dollar signs used before commands without showing output [Context: "$ odbcinst -j"]
odbc/using.md:44:81 MD013/line-length Line length [Expected: 80; Actual: 207]
odbc/using.md:46:81 MD013/line-length Line length [Expected: 80; Actual: 237]
odbc/using.md:60:81 MD013/line-length Line length [Expected: 80; Actual: 404]
odbc/using.md:62:81 MD013/line-length Line length [Expected: 80; Actual: 135]
odbc/using.md:76:81 MD013/line-length Line length [Expected: 80; Actual: 223]
odbc/using.md:82:81 MD013/line-length Line length [Expected: 80; Actual: 310]
odbc/using.md:86:81 MD013/line-length Line length [Expected: 80; Actual: 211]
odbc/using.md:88:81 MD013/line-length Line length [Expected: 80; Actual: 290]
odbc/using.md:90:81 MD013/line-length Line length [Expected: 80; Actual: 304]
odbc/using.md:94:81 MD013/line-length Line length [Expected: 80; Actual: 154]
odbc/using.md:96 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
odbc/using.md:100:81 MD013/line-length Line length [Expected: 80; Actual: 278]

Enable markdown linting

https://github.com/marketplace/actions/markdownlint-cli

First we need to fix existing markdown lint issues, though. These are:

• acscloner/README.md #33
• java11/JAVA11_EARLY_ACCESS.md #34
• nginx.md #35
• nvm/README.md #36
• porting/GOTCHAS.md #42
• postgresql.md #43
• README.md #44
• troubleshooting/5733OPS_MIGRATION.md #45
• troubleshooting/README.md #46
• troubleshooting/SETTING_BASH.md #47
• troubleshooting/SETTING_PATH.md #48
• yum/3RD_PARTY_REPOS.md #49
• yum/README.md #50

To test, install markdownlint-cli: npm i -g markdownlint-cli and run markownlint-cli .

It is likely we will need to adjust the basic markdown lint rules.

Enhance Node.js section

Useful pages:

• Supported Node.js versions
• Using alternatives to set the default Node.js version
• How to use nvm
• Gotchas on specific packages or native package builds (yum install development tools, etc).
• Options for connecting to Db2
• Options for calling XMLSERVICE

Fix markdown lint issues in java11/JAVA11_EARLY_ACCESS.md

java11/JAVA11_EARLY_ACCESS.md:3:81 MD013/line-length Line length [Expected: 80; Actual: 162]
java11/JAVA11_EARLY_ACCESS.md:7 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "## Is this Java production-ready?"]
java11/JAVA11_EARLY_ACCESS.md:7:33 MD026/no-trailing-punctuation Trailing punctuation in heading [Punctuation: '?']
java11/JAVA11_EARLY_ACCESS.md:10 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "## Why is this only "early access"?"]
java11/JAVA11_EARLY_ACCESS.md:10:35 MD026/no-trailing-punctuation Trailing punctuation in heading [Punctuation: '?']
java11/JAVA11_EARLY_ACCESS.md:11:81 MD013/line-length Line length [Expected: 80; Actual: 392]
java11/JAVA11_EARLY_ACCESS.md:13 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "## How do I install this?"]
java11/JAVA11_EARLY_ACCESS.md:13:25 MD026/no-trailing-punctuation Trailing punctuation in heading [Punctuation: '?']
java11/JAVA11_EARLY_ACCESS.md:14:81 MD013/line-length Line length [Expected: 80; Actual: 126]
java11/JAVA11_EARLY_ACCESS.md:16 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "## Where does this install?"]
java11/JAVA11_EARLY_ACCESS.md:16:27 MD026/no-trailing-punctuation Trailing punctuation in heading [Punctuation: '?']
java11/JAVA11_EARLY_ACCESS.md:19 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "## How do I select this JVM to run my program?"]
java11/JAVA11_EARLY_ACCESS.md:19:46 MD026/no-trailing-punctuation Trailing punctuation in heading [Punctuation: '?']
java11/JAVA11_EARLY_ACCESS.md:20:81 MD013/line-length Line length [Expected: 80; Actual: 218]
java11/JAVA11_EARLY_ACCESS.md:21 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```"]
java11/JAVA11_EARLY_ACCESS.md:21 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
java11/JAVA11_EARLY_ACCESS.md:26:81 MD013/line-length Line length [Expected: 80; Actual: 141]
java11/JAVA11_EARLY_ACCESS.md:27 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```"]
java11/JAVA11_EARLY_ACCESS.md:27 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
java11/JAVA11_EARLY_ACCESS.md:32:81 MD013/line-length Line length [Expected: 80; Actual: 147]
java11/JAVA11_EARLY_ACCESS.md:32 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "## Why do I get error "Directory /QOpenSys/pkgs/lib/jvm/openjdk-11 in the JAVA_HOME environment variable does not contain a Java Virtual Machine."?"]
java11/JAVA11_EARLY_ACCESS.md:32:147 MD026/no-trailing-punctuation Trailing punctuation in heading [Punctuation: '?']
java11/JAVA11_EARLY_ACCESS.md:34:81 MD013/line-length Line length [Expected: 80; Actual: 145]
java11/JAVA11_EARLY_ACCESS.md:36 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "## Can this integrate with RPG via the *JAVA declaration?"]
java11/JAVA11_EARLY_ACCESS.md:36:57 MD026/no-trailing-punctuation Trailing punctuation in heading [Punctuation: '?']
java11/JAVA11_EARLY_ACCESS.md:40 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "## Can I use ILE native methods?"]
java11/JAVA11_EARLY_ACCESS.md:40:32 MD026/no-trailing-punctuation Trailing punctuation in heading [Punctuation: '?']
java11/JAVA11_EARLY_ACCESS.md:41:81 MD013/line-length Line length [Expected: 80; Actual: 108]
java11/JAVA11_EARLY_ACCESS.md:42:81 MD013/line-length Line length [Expected: 80; Actual: 108]
java11/JAVA11_EARLY_ACCESS.md:44 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "## Does this show up in WRKJVMJOB?"]
java11/JAVA11_EARLY_ACCESS.md:44:34 MD026/no-trailing-punctuation Trailing punctuation in heading [Punctuation: '?']
java11/JAVA11_EARLY_ACCESS.md:48 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "## Can this run inside of a chroot container?"]
java11/JAVA11_EARLY_ACCESS.md:48:45 MD026/no-trailing-punctuation Trailing punctuation in heading [Punctuation: '?']
java11/JAVA11_EARLY_ACCESS.md:51 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "## Are there any functions known not to work?"]
java11/JAVA11_EARLY_ACCESS.md:51:45 MD026/no-trailing-punctuation Trailing punctuation in heading [Punctuation: '?']
java11/JAVA11_EARLY_ACCESS.md:52:81 MD013/line-length Line length [Expected: 80; Actual: 102]
java11/JAVA11_EARLY_ACCESS.md:53:81 MD013/line-length Line length [Expected: 80; Actual: 217]

Fix markdown lint issues in odbc/installation.md

odbc/installation.md:3:81 MD013/line-length Line length [Expected: 80; Actual: 269]
odbc/installation.md:14:81 MD013/line-length Line length [Expected: 80; Actual: 397]
odbc/installation.md:18:81 MD013/line-length Line length [Expected: 80; Actual: 765]
odbc/installation.md:20:81 MD013/line-length Line length [Expected: 80; Actual: 224]
odbc/installation.md:23:1 MD014/commands-show-output Dollar signs used before commands without showing output [Context: "$ yum install <package-locatio..."]
odbc/installation.md:26:81 MD013/line-length Line length [Expected: 80; Actual: 207]
odbc/installation.md:30 MD024/no-duplicate-heading/no-duplicate-header Multiple headings with the same content [Context: "### Driver Manager"]
odbc/installation.md:32:81 MD013/line-length Line length [Expected: 80; Actual: 397]
odbc/installation.md:34 MD024/no-duplicate-heading/no-duplicate-header Multiple headings with the same content [Context: "### Driver"]
odbc/installation.md:36:81 MD013/line-length Line length [Expected: 80; Actual: 525]
odbc/installation.md:38:81 MD013/line-length Line length [Expected: 80; Actual: 309]
odbc/installation.md:42 MD024/no-duplicate-heading/no-duplicate-header Multiple headings with the same content [Context: "### Driver Manager"]
odbc/installation.md:44:81 MD013/line-length Line length [Expected: 80; Actual: 287]
odbc/installation.md:48 MD024/no-duplicate-heading/no-duplicate-header Multiple headings with the same content [Context: "### Driver"]
odbc/installation.md:50:81 MD013/line-length Line length [Expected: 80; Actual: 444]
odbc/installation.md:52:81 MD013/line-length Line length [Expected: 80; Actual: 157]
odbc/installation.md:56 MD024/no-duplicate-heading/no-duplicate-header Multiple headings with the same content [Context: "### Driver Manager"]
odbc/installation.md:58:81 MD013/line-length Line length [Expected: 80; Actual: 274]
odbc/installation.md:60 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
odbc/installation.md:64 MD024/no-duplicate-heading/no-duplicate-header Multiple headings with the same content [Context: "### Driver"]
odbc/installation.md:66:81 MD013/line-length Line length [Expected: 80; Actual: 555]
odbc/installation.md:66:555 MD047/single-trailing-newline Files should end with a single newline character

Fix markdown lint issues in troubleshooting/5733OPS_MIGRATION.md

troubleshooting/5733OPS_MIGRATION.md:3 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2]
troubleshooting/5733OPS_MIGRATION.md:4 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "## Environment setup (PATH)"]
troubleshooting/5733OPS_MIGRATION.md:5:146 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]
troubleshooting/5733OPS_MIGRATION.md:5:81 MD013/line-length Line length [Expected: 80; Actual: 146]
troubleshooting/5733OPS_MIGRATION.md:9:81 MD013/line-length Line length [Expected: 80; Actual: 141]
troubleshooting/5733OPS_MIGRATION.md:10:221 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]
troubleshooting/5733OPS_MIGRATION.md:10:81 MD013/line-length Line length [Expected: 80; Actual: 221]
troubleshooting/5733OPS_MIGRATION.md:14:201 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]
troubleshooting/5733OPS_MIGRATION.md:14:81 MD013/line-length Line length [Expected: 80; Actual: 201]
troubleshooting/5733OPS_MIGRATION.md:16:124 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]
troubleshooting/5733OPS_MIGRATION.md:16:81 MD013/line-length Line length [Expected: 80; Actual: 124]
troubleshooting/5733OPS_MIGRATION.md:18:81 MD013/line-length Line length [Expected: 80; Actual: 320]
troubleshooting/5733OPS_MIGRATION.md:25:81 MD013/line-length Line length [Expected: 80; Actual: 98]
troubleshooting/5733OPS_MIGRATION.md:26 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "``` bash"]
troubleshooting/5733OPS_MIGRATION.md:31:81 MD013/line-length Line length [Expected: 80; Actual: 237]
troubleshooting/5733OPS_MIGRATION.md:32 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "``` python3"]
troubleshooting/5733OPS_MIGRATION.md:35 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```"]
troubleshooting/5733OPS_MIGRATION.md:37 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "``` python3"]
troubleshooting/5733OPS_MIGRATION.md:44:248 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]
troubleshooting/5733OPS_MIGRATION.md:44:81 MD013/line-length Line length [Expected: 80; Actual: 248]
troubleshooting/5733OPS_MIGRATION.md:45:81 MD013/line-length Line length [Expected: 80; Actual: 112]
troubleshooting/5733OPS_MIGRATION.md:46:198 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]
troubleshooting/5733OPS_MIGRATION.md:46:81 MD013/line-length Line length [Expected: 80; Actual: 198]
troubleshooting/5733OPS_MIGRATION.md:47:81 MD013/line-length Line length [Expected: 80; Actual: 162]
troubleshooting/5733OPS_MIGRATION.md:48:81 MD013/line-length Line length [Expected: 80; Actual: 183]
troubleshooting/5733OPS_MIGRATION.md:52:191 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]
troubleshooting/5733OPS_MIGRATION.md:52:81 MD013/line-length Line length [Expected: 80; Actual: 191]
troubleshooting/5733OPS_MIGRATION.md:53:102 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]
troubleshooting/5733OPS_MIGRATION.md:53:81 MD013/line-length Line length [Expected: 80; Actual: 102]
troubleshooting/5733OPS_MIGRATION.md:54:114 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]
troubleshooting/5733OPS_MIGRATION.md:54:81 MD013/line-length Line length [Expected: 80; Actual: 114]
troubleshooting/5733OPS_MIGRATION.md:55:81 MD013/line-length Line length [Expected: 80; Actual: 195]
troubleshooting/5733OPS_MIGRATION.md:56:81 MD013/line-length Line length [Expected: 80; Actual: 277]
troubleshooting/5733OPS_MIGRATION.md:56:153 MD033/no-inline-html Inline HTML [Element: version]
troubleshooting/5733OPS_MIGRATION.md:57:81 MD013/line-length Line length [Expected: 80; Actual: 320]
troubleshooting/5733OPS_MIGRATION.md:57 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- To switch the default versio..."]
troubleshooting/5733OPS_MIGRATION.md:57:96 MD033/no-inline-html Inline HTML [Element: version]
troubleshooting/5733OPS_MIGRATION.md:58 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```"]
troubleshooting/5733OPS_MIGRATION.md:58 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
troubleshooting/5733OPS_MIGRATION.md:61 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```"]
troubleshooting/5733OPS_MIGRATION.md:63:81 MD013/line-length Line length [Expected: 80; Actual: 184]
troubleshooting/5733OPS_MIGRATION.md:63 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "- To use `node-gyp` (or other ..."]
troubleshooting/5733OPS_MIGRATION.md:63:184 MD047/single-trailing-newline Files should end with a single newline character

Fix markdown lint issues in odbc/examples.md

odbc/examples.md:3:81 MD013/line-length Line length [Expected: 80; Actual: 192]
odbc/examples.md:5:81 MD013/line-length Line length [Expected: 80; Actual: 268]
odbc/examples.md:11:81 MD013/line-length Line length [Expected: 80; Actual: 243]
odbc/examples.md:24:81 MD013/line-length Line length [Expected: 80; Actual: 205]
odbc/examples.md:26:81 MD013/line-length Line length [Expected: 80; Actual: 90]
odbc/examples.md:28 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
odbc/examples.md:32:81 MD013/line-length Line length [Expected: 80; Actual: 120]
odbc/examples.md:36 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
odbc/examples.md:44:81 MD013/line-length Line length [Expected: 80; Actual: 220]
odbc/examples.md:47 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```javascript"]
odbc/examples.md:62:81 MD013/line-length Line length [Expected: 80; Actual: 123]
odbc/examples.md:64 MD024/no-duplicate-heading/no-duplicate-header Multiple headings with the same content [Context: "### DSNs"]
odbc/examples.md:66:81 MD013/line-length Line length [Expected: 80; Actual: 346]
odbc/examples.md:68 MD024/no-duplicate-heading/no-duplicate-header Multiple headings with the same content [Context: "### Node.js"]
odbc/examples.md:70:81 MD013/line-length Line length [Expected: 80; Actual: 112]
odbc/examples.md:73:1 MD014/commands-show-output Dollar signs used before commands without showing output [Context: "$ yum install nodejs10"]
odbc/examples.md:76:81 MD013/line-length Line length [Expected: 80; Actual: 210]
odbc/examples.md:79 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```javascript"]
odbc/examples.md:90:3 MD047/single-trailing-newline Files should end with a single newline character

Installing Python Packages references an invalid yum command

The [Installing Python Packages](page https://ibmi-oss-docs.readthedocs.io/en/latest/python/INSTALLING_PYTHON_PKGS.html) makes reference to the command yum install "Developer Tools" to install the “Developer Tools” group.

The command should be yum group install "Development Tools".

There are no other references to the yum install "Developer Tools" command in the repo.

I suggest changing the paragraph to the following ...

Also, you may need to install development tools, like gcc and automake, which you can often do a la carte (yum install gcc automake) or you may need to install the “Development Tools” group (yum group install "Development Tools").

Enhance Python section

Useful pages

• Supported Python versions
• Using alternatives to pick the default python/python3 binary
• Using virtualenvs to install packages
• How to build native packages (install python3-devel, development tools, etc)
• Pages on important packages to install via pip: pandas, etc
• Options for connecting to Db2
• Options for calling XMLSERVICE

Add ML docs

A lot of the info here could be migrated to a Machine Learning page in this repo.

CONTRIBUTION file

Tell people to press . (dot) to open the editor and make a PR.

Fix markdown lint issues in nginx.md

nginx.md:3 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "## Summary"]
nginx.md:4:81 MD013/line-length Line length [Expected: 80; Actual: 168]
nginx.md:8 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
nginx.md:9:1 MD014/commands-show-output Dollar signs used before commands without showing output [Context: "$ yum install nginx"]
nginx.md:12 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "## Config"]
nginx.md:14 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```"]
nginx.md:14 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
nginx.md:29 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "## Starting and Stopping"]
nginx.md:30:81 MD013/line-length Line length [Expected: 80; Actual: 206]
nginx.md:32 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
nginx.md:33:1 MD014/commands-show-output Dollar signs used before commands without showing output [Context: "$ nginx -c /www/nginx/nginx.co..."]
nginx.md:38 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
nginx.md:39:1 MD014/commands-show-output Dollar signs used before commands without showing output [Context: "$ nginx -c /www/nginx/nginx.co..."]
nginx.md:44:81 MD013/line-length Line length [Expected: 80; Actual: 217]
nginx.md:46 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2]

Fix markdown lint issues in troubleshooting/SETTING_BASH.md

troubleshooting/SETTING_BASH.md:1:81 MD013/line-length Line length [Expected: 80; Actual: 258]
troubleshooting/SETTING_BASH.md:1:1 MD037/no-space-in-emphasis Spaces inside emphasis markers [Context: "*** The bash shell can (and sh..."]
troubleshooting/SETTING_BASH.md:1 MD041/first-line-heading/first-line-h1 First line in file should be a top level heading [Context: "*** The bash shell can (and sh..."]
troubleshooting/SETTING_BASH.md:3:81 MD013/line-length Line length [Expected: 80; Actual: 127]
troubleshooting/SETTING_BASH.md:4:81 MD013/line-length Line length [Expected: 80; Actual: 96]
troubleshooting/SETTING_BASH.md:6 MD012/no-multiple-blanks Multiple consecutive blank lines [Expected: 1; Actual: 2]
troubleshooting/SETTING_BASH.md:7:1 MD037/no-space-in-emphasis Spaces inside emphasis markers [Context: "** Technique #1: chsh**"]
troubleshooting/SETTING_BASH.md:10:81 MD013/line-length Line length [Expected: 80; Actual: 229]
troubleshooting/SETTING_BASH.md:12:1 MD037/no-space-in-emphasis Spaces inside emphasis markers [Context: "** Technique #2: sql**"]
troubleshooting/SETTING_BASH.md:14:81 MD013/line-length Line length [Expected: 80; Actual: 147]
troubleshooting/SETTING_BASH.md:21 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```SQL"]
troubleshooting/SETTING_BASH.md:26 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```SQL"]
troubleshooting/SETTING_BASH.md:32:207 MD047/single-trailing-newline Files should end with a single newline character

Add FAQ entry about QSH multithreading

We have an entry in the FAQ about multithreading related to yum, but not a general issue. We've seen this in numerous contexts: curl, node/npm, git, etc and should list some common errors we have encountered to make it easily findable.

[New] Node.js os.uptime enosys

What documentation would you like added?

Document that os.uptime returns enosys

Welcome to Node.js v20.5.1.
Type ".help" for more information.
> require('os').uptime()
Uncaught:
SystemError [ERR_SYSTEM_ERROR]: A system error occurred: uv_uptime returned ENOSYS (function not implemented)
    at __node_internal_captureLargerStackTrace (node:internal/errors:496:5)
    at new SystemError (node:internal/errors:256:5)
    at new NodeError (node:internal/errors:367:7)
    at Object.__node_internal_checkError [as uptime] (node:os:68:13) {
  code: 'ERR_SYSTEM_ERROR',
  info: {
    errno: -109,
    code: 'ENOSYS',
    message: 'function not implemented',
    syscall: 'uv_uptime'
  },
  errno: [Getter/Setter: -109],
  syscall: [Getter/Setter: 'uv_uptime']
}

Fix markdown lint issues in nvm/README.md

nvm/README.md:3 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "## Step 1: Install developer tools"]
nvm/README.md:5 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```"]
nvm/README.md:5 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
nvm/README.md:7 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```"]
nvm/README.md:8 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Above] [Context: "## Step 2: Install NVM"]
nvm/README.md:10:81 MD013/line-length Line length [Expected: 80; Actual: 220]
nvm/README.md:14 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "## Step 3: Configure your $HOME/.nvmrc file"]
nvm/README.md:16 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```"]
nvm/README.md:16 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
nvm/README.md:23 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "## Step 4: Set necessary environment variables"]
nvm/README.md:25 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```"]
nvm/README.md:25 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
nvm/README.md:31:81 MD013/line-length Line length [Expected: 80; Actual: 143]
nvm/README.md:32 MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```"]
nvm/README.md:32 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"]
nvm/README.md:41 MD022/blanks-around-headings/blanks-around-headers Headings should be surrounded by blank lines [Expected: 1; Actual: 0; Below] [Context: "## Step 5: Run nvm!"]
nvm/README.md:41:19 MD026/no-trailing-punctuation Trailing punctuation in heading [Punctuation: '!']
nvm/README.md:42:81 MD013/line-length Line length [Expected: 80; Actual: 192]

Fix markdown lint issues in odbc/README.md

odbc/README.md:3:81 MD013/line-length Line length [Expected: 80; Actual: 492]

[New] Add Golang Page

• How to build golang to run on IBM I
  potentially useful links:
  (https://community.ibm.com/community/user/power/discussion/c-linkable-shared-library-created-out-of-a-golang-project-on-aix-72-fails-to-run-with-error-the-local-exec-model-was-used-for-thread-local-storage-but-the-module-is-not-the-main-program)
  (golang/go#45017)
• How to connect to Db2
  The below connection works on windows with the ibm i access driver routed to the IBMI DSN. Tested in a windows environment go rest apis are about twice as fast as node.js.
  db, err := sql.Open("odbc", "DSN=IBMI;SYSTEM=xxx.xxx.xx.xx;Uid=xxx;Pwd=xxx")

Document ACS tunneling/proxy support

• Create a page about the new “SSH Tunneling” support in ACS
  *Create information in the general doc that links to the new SSH Tunneling page as well as the ACS Clone tool page ( https://bitbucket.org/ibmi/opensource/src/master/docs/acscloner/README.md )
• Leave bread crumbs in the troubleshooting page as well

‌Originally at https://bitbucket.org/ibmi/opensource/issues/111/need-documentation-for-options-if-ibm-i by @ThePrez

Document how to set up X11 forwarding on macOS and Windows

This article shows how to get started with ML and mentions using ssh -Y to do X11 forwarding, but that only works out of the box on Linux. On macOS, you have to install XQuartz and on Windows, if you're using Putty you can't use -Y, but need to configure it through the GUI and you have to install and set up an X11 server like Xming. See https://superuser.com/questions/119792/how-to-use-x11-forwarding-with-putty/119908#119908.

We should document this here.

Create Sphinx setup and document how to build the docs

We need to setup and configure Sphinx so that our docs get built properly. In addition, we should create a getting started guide for anyone who wishes to contribute to the docs. For the most part, the docs should be easy to edit as they are Markdown, but if anyone wants to build the pages to see what they will look like in a finished product it would be helpful to have a guide letting them know the process.

Add link for PHP

What example(s) need improvement?

List of OSS doesn't include PHP

What improvement(s) could be made?

Link to IBM's PHP page.

Fix markdown lint issues in troubleshooting/README.md

troubleshooting/README.md:14:81 MD013/line-length Line length [Expected: 80; Actual: 129]
troubleshooting/README.md:20:81 MD013/line-length Line length [Expected: 80; Actual: 122]
troubleshooting/README.md:24:81 MD013/line-length Line length [Expected: 80; Actual: 143]
troubleshooting/README.md:27:81 MD013/line-length Line length [Expected: 80; Actual: 114]
troubleshooting/README.md:32:81 MD013/line-length Line length [Expected: 80; Actual: 154]
troubleshooting/README.md:34:81 MD013/line-length Line length [Expected: 80; Actual: 171]
troubleshooting/README.md:38:81 MD013/line-length Line length [Expected: 80; Actual: 152]
troubleshooting/README.md:42:81 MD013/line-length Line length [Expected: 80; Actual: 187]
troubleshooting/README.md:50:194 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]
troubleshooting/README.md:50:81 MD013/line-length Line length [Expected: 80; Actual: 194]
troubleshooting/README.md:51:81 MD013/line-length Line length [Expected: 80; Actual: 272]
troubleshooting/README.md:53:81 MD013/line-length Line length [Expected: 80; Actual: 107]
troubleshooting/README.md:73:81 MD013/line-length Line length [Expected: 80; Actual: 95]
troubleshooting/README.md:79:81 MD013/line-length Line length [Expected: 80; Actual: 87]
troubleshooting/README.md:82:25 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]
troubleshooting/README.md:85:81 MD013/line-length Line length [Expected: 80; Actual: 156]
troubleshooting/README.md:87:81 MD013/line-length Line length [Expected: 80; Actual: 235]
troubleshooting/README.md:91:81 MD013/line-length Line length [Expected: 80; Actual: 192]
troubleshooting/README.md:93:27 MD026/no-trailing-punctuation Trailing punctuation in heading [Punctuation: '!']
troubleshooting/README.md:95:81 MD013/line-length Line length [Expected: 80; Actual: 164]

[New] Page on monitoring solutions

What documenation would you like added?

• Prometheus
• Grafana straight-up
• Grafana+Prometheus
• Prometheus + DataDog
• Prometheus + Nagios
• Prometheus + Instana
• Node-RED dashboard (thebeardedgeek example?)

yum-utils missing yum-complete-transaction

repoquery --list yum-utils shows no such executable in the bin directory. The man page was installed: /QOpenSys/pkgs/share/man/man8/yum-complete-transaction.8

The version of yum-utils I have:
yum-utils.noarch 1.1.31-6 @IBM

When attempting to update a package, I got this notice

There are unfinished transactions remaining. You might consider running yum-complete-transaction first to finish them.

which is why I went searching for that command.

[New] Jenkins with/on IBM i

What documenation would you like added?

• Information on how to run Jenkins on IBM i (also, optionally, manage with sc)
• Information on how to run the worker on IBM i to use IBM i as a build/test node

Fix markdown lint issues in odbc/why-odbc.md

odbc/why-odbc.md:3:81 MD013/line-length Line length [Expected: 80; Actual: 133]
odbc/why-odbc.md:5:81 MD013/line-length Line length [Expected: 80; Actual: 385]
odbc/why-odbc.md:7:81 MD013/line-length Line length [Expected: 80; Actual: 458]
odbc/why-odbc.md:9:81 MD013/line-length Line length [Expected: 80; Actual: 502]
odbc/why-odbc.md:11:81 MD013/line-length Line length [Expected: 80; Actual: 595]
odbc/why-odbc.md:11:595 MD047/single-trailing-newline Files should end with a single newline character

[New] Document CHOKIDAR_USEPOLLING for working around lack of fs.watch

What documenation would you like added?

When using various Node.js tools for watching a filesystem and hot-reloading on file changes, many use Chokidar which relies on fs.watch, which is not supported on IBM i. This results in error messages such as:

Watchpack Error (watrcher): Error: ENONSYS: function not implmemented, watch
Error from chokidar src/api/modules): error enosys: function not implemented, watch 

As a workaround, Chokidar supports polling, which can be enabled by setting the CHOKIDAR_USEPOLLING environment variable to 1.

Need a license for this repo

We'd like to license this under the CC0 license, but we've had non-IBM contributions that would need to agree to the licensing:

• @aaronbartell
• @jbh
• @jkyeung
• @NattyNarwhal
• @worksofliam
• @phpdave
• @jwoehr
• @friedkiwi

I've uploaded licensing docs based off of what libzmq has done for their licensing efforts. You can find the list of commits being re-licensed under your user name at https://github.com/IBM/ibmi-oss-docs/tree/master/.licensing/commits.

Please copy and fill out template to a file with your GitHub username.md, eg. I would make .licensing/kadler.md. Once this is done, send a PR referencing this issue so we can get a permanent record of your agreement to the relicensing.

Fix markdown lint issues in README.md

README.md:4:81 MD013/line-length Line length [Expected: 80; Actual: 305]
README.md:6:83 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]
README.md:6:81 MD013/line-length Line length [Expected: 80; Actual: 83]
README.md:8:81 MD013/line-length Line length [Expected: 80; Actual: 205]
README.md:10:186 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]
README.md:10:81 MD013/line-length Line length [Expected: 80; Actual: 186]
README.md:12:81 MD013/line-length Line length [Expected: 80; Actual: 278]

Fix markdown lint issues in porting/GOTCHAS.md

porting/GOTCHAS.md:5:81 MD013/line-length Line length [Expected: 80; Actual: 289]
porting/GOTCHAS.md:11:81 MD013/line-length Line length [Expected: 80; Actual: 351]
porting/GOTCHAS.md:21:81 MD013/line-length Line length [Expected: 80; Actual: 162]
porting/GOTCHAS.md:39:81 MD013/line-length Line length [Expected: 80; Actual: 369]
porting/GOTCHAS.md:47:81 MD013/line-length Line length [Expected: 80; Actual: 425]
porting/GOTCHAS.md:57:81 MD013/line-length Line length [Expected: 80; Actual: 130]
porting/GOTCHAS.md:58:81 MD013/line-length Line length [Expected: 80; Actual: 116]
porting/GOTCHAS.md:61:81 MD013/line-length Line length [Expected: 80; Actual: 119]
porting/GOTCHAS.md:65:81 MD013/line-length Line length [Expected: 80; Actual: 120]
porting/GOTCHAS.md:66:81 MD013/line-length Line length [Expected: 80; Actual: 120]
porting/GOTCHAS.md:70:81 MD013/line-length Line length [Expected: 80; Actual: 141]
porting/GOTCHAS.md:74:81 MD013/line-length Line length [Expected: 80; Actual: 117]
porting/GOTCHAS.md:79:81 MD013/line-length Line length [Expected: 80; Actual: 166]
porting/GOTCHAS.md:80:81 MD013/line-length Line length [Expected: 80; Actual: 160]
porting/GOTCHAS.md:81:81 MD013/line-length Line length [Expected: 80; Actual: 102]

[Fixup] Add FAQ entry for GCC missing errors

What improvement(s) could be made?

Users trying to build C/C++ applications tend to run in to issues with missing GCC and don't know how to solve. We should add FAQ entries for common gcc and g++ missing errors (and possibly gcc-cpp, since I don't think gcc6 package requires it).

unable to execute 'gcc': No such file or directory

Solution: yum install gcc or yum group install "Development Tools"

gcc-6.bin: error trying to exec 'cc1plus': execvp: No such file or directory

Solution: yum install gcc-cplusplus or yum group install "Development Tools"

collect2: fatal error: library libstdc++ not found

Solution: yum install libstdcplusplus-devel

Add FAQ entry about finding the wrong command version

We periodically get users accidentally running OPS versions of software instead of rpm versions and confused about why they see that. This is also a problem when sometimes it works from SSH, but gets different results in QP2TERM/QSH.

We should add a FAQ entry to describe this problem and the solution (ie. link to https://ibmi-oss-docs.readthedocs.io/en/latest/troubleshooting/SETTING_PATH.html)