search

IBM / dbb-zappbuild

zAppBuild is a generic build solution for building z/OS applications using Apache Groovy build scripts and IBM Dependency Based Build (DBB) APIs.
Apache License 2.0
42 stars 144 forks source link

Readability of command examples #249

Closed ijmitch closed 2 years ago

ijmitch commented 2 years ago

Github's rendering of the code blocks for the command examples means you need to scroll right to see the end of the commands - and this is typically where the differences are.

I changed the commands in the code blocks to shorten the lines and use the shell continuation character so that copy/paste of the commands should still work.

ijmitch commented 2 years ago

I use Markdown-all-in-One which doesn't seem to honour the <!-- TOC depthFrom:3 depthTo:3 orderedList:false anchorMode:github.com --> so it makes a ToC including all the headings. Had to revert that using TextEdit.

Are you using https://marketplace.visualstudio.com/items?itemName=huntertran.auto-markdown-toc ?

dennis-behm commented 2 years ago

Yes, I was using the Markdown-TOC extension to build the ToCs. Let me switch to the Markdown-All-in-One, this seems to be much handier.

Going to review the PR shortly. I changed the base branch to target the develop branch where we collect multiple updates before creating a new release on main .

Wondering why I am not seeing any conflicts here, while the documentation was updated to reflect the new metadata store

ijmitch commented 2 years ago

Sorry for not spotting there was a develop branch (especially considering the fuss I make about branching strategies 😄 ).

Eyeballing the file in the develop branch the diff on the single file for this PR showing no conflicts makes sense to me.