17
Wed, Apr
5 New Articles

Practical OSS: MkDocs for the IBM i, Part 1

Typography
  • Smaller Small Medium Big Bigger
  • Default Helvetica Segoe Georgia Times

MkDocs may be the shortest path from tribal knowledge to IT portal.

During my continuing foray into open-source software (OSS), I ran across a very interesting tool named MkDocs. Richard Schoen mentioned it on the Midrange mailing lists. I was a little concerned—not because it was open source, but because it used the dreaded Python language. Personally, I’ll program in any language; I wrote a lot of Lisp back in the ‘80s when it was the primary language for programmable synthesizers. But Python and its reliance on the number of spaces at the beginning of a line of code has always given me the heebie-jeebies. That being said, the concept of MkDocs became more intriguing the more I read, and it seemed like I wouldn’t really have to learn much about Python to make it work. (Yeah, that was wrong, but still.)

So this is the first of a brief series of articles that will introduce the MkDocs utility and hopefully make you as curious about it as I was and perhaps lead you to incorporate it in your own shop.

What Is MkDocs?

For in-depth information, you can go to the MkDocs website to find out about the package. In brief, it’s a tool that takes very simple text files and turns them into a beautifully rendered website, complete with navigation and search capabilities. The generic term for this kind of tool is “static site generator” because its purpose is to create static HTML that can then be copied very simply to any web server. On the IBM i, I just copy everything to an Apache web instance (with a single command) and off it goes.

But calling MkDocs just a static site generator is an understatement. Yes, you can use it just to render text into HTML, but there is so much more to it; MkDocs is a powerful, highly extensible ecosystem of features and functions that allows you to customize your website in a wide variety of ways. But let’s start with the basics.

First, MkDocs is based on the Markdown language created by Jon Gruber in 2004. At its simplest, Markdown is a text-based editor, as opposed to a WYSIWYG editor. You write your content in simple, mostly unformatted text documents. Certain basic functions are understood, such as headings and highlighting, but they’re triggered by characters within the text itself. For example, the main heading for a page is on a line by itself that starts with a single hashtag (#). Second-level headings start with two hashtags (##) and so on. One of the things I really like about Markdown is that it’s geared toward technical writing and as such supports the concept of a “fenced code block.” These code blocks start and end with three backticks (```). This triggers the Markdown processor to highlight the block using monospaced code, typically with the ability to copy the code with a single click. I’ll show this in more detail in subsequent articles that will focus on a real example.

But for this article, let’s continue with some of the high-level concepts. Foremost would be the idea of a theme. Themes are an integral part of Markdown and thus of MkDocs. MkDocs creates static websites that make extensive use of CSS, and the CSS is part of the theme. By simply changing a single line in your configuration, you can completely change the visual feel of your site. Hundreds of themes are out there for your choosing; click here for a site with five examples. I like this site because it includes the theme I’m currently using, Material for MkDocs. But CSS is only one component of a theme. Remember that MkDocs generates HTML. That generation isn’t hardcoded; it uses templates that are populated and combined to form pages. Once you really start getting into MkDocs, you may find yourself customizing the templates to add your own specific touches.

After templates, the two other big components are extensions and plug-ins. We’ll cover these in more detail in the next article, but basically these are two ways to provide additional functionality, not unlike extensions for your favorite web browser.

What Is Required to Use MkDocs?

Short answer: not much. The very high-level setup steps are:

  • Make sure you have the IBM i Open Source Package Management (OSPM) installed.
  • Install mkdocs.
  • Install material theme (highly recommended).
  • Create a basic Apache web server instance.

At this point, you’ve done everything you need to develop your website. I recommend creating a folder named mkdocs in the root of your IFS (or one level down if you have a sandbox area already). Add a subfolder for your test website and get cracking!

  • Run mkdocs serve and get your site working.
  • Run mkdocs build to generate the HTML in folder
  • Copy it to your Apache instance’s base folder.

That’s it. But there’s always a little more to it, isn’t there? Let me elaborate.

Detailed Startup Steps

The first thing in setup is getting the IBM i Open Source Package Management installed. This is a little bit in the weeds, but the short version is that the 5733-OPS licensed product is pretty much superseded by the IBM i Open Source Package Management. Click here for the IBM take on OSPM and installing the latest version via IBM i ACS. For more in-depth discussion from the user community, go to the IBM i OSS Docs site.

As part of the ACS installation of OSPM, you should automatically get Python3. That’s important, because everything we’re doing really requires the new version of python. And once you have Python3 installed, you can then use pip3 to install some of the additional pieces that will make your website even better. Please note that you don’t need these additional features, but they make life a lot more fun, and pip3 is super easy to use. Caveat: Like everything in open source, the happy path is very easy. The problem is that when things don’t work, it’s hard to figure it out. Because I didn’t understand the correct sequence of things, I ran into some problems that required me to learn way more about Python, pip, and package management than I had intended to.

Anyway, once you’ve done that, you can install MkDocs. Richard Schoen has done a great job of documenting this process on his howtostuff site. It was Richard’s initial enthusiasm that got me started down this path, so if you enjoy MkDocs, thank him. Then you can use pip3 to install the Material theme. Please be careful and use pip3 rather than pip. I am not going to go into a discussion of Python virtual environments where you can alias Python to Python3 and pip to pip3. Just remember that when you install a piece of Python software, use pip3 wherever you see pip.

I won’t spend a lot of time on creating an Apache web server. If you want in-depth documentation, you can use the IBM documentation. Generally speaking, you need the simplest configuration of a web server, because all it does is serve up web pages. I recommend you create a folder /www/mkdocs, and put a subfolder under there for each website you plan to create. I basically just have a test folder and a production folder, but you may find it so easy to create web sites that you create multiple.

Even More Fun in Testing

If (like me) you find things not working on the IBM i and you need another way to check your work, or if you just want to get deeper into the UNIX side of things, you can run this entire process in Linux. And what’s really cool is that if you have Windows 10, you can run Linux right on your Windows desktop using Windows Subsystem for Linux (WSL). That’s way outside the scope of this article, but if you want a very solid Linux playground that doesn’t require virtual machines or anything else, please check into it. Installing WSL took me about an hour, and it gave me a fantastic place to work. I now have an icon on my taskbar that I click to bring up an Ubuntu instance. If you want to start honing your Linux skills, then by all means get this running.

A Little Research Note

As I was researching text-processing software, I ran across a wonderful little tidbit. If you’re as old as I am, you remember the days before Microsoft Word. One of my very first jobs was to program an interface between the IBM Series/1 (not the iSeries!) and dedicated word processors from Ontel. If you’d like to see an interesting little bit of history, please take a look at_”A Brief History of Word Processing,” written back in 1986 by Brian Kunde. Enjoy!

 

Joe Pluta

Joe Pluta is the founder and chief architect of Pluta Brothers Design, Inc. He has been extending the IBM midrange since the days of the IBM System/3. Joe uses WebSphere extensively, especially as the base for PSC/400, the only product that can move your legacy systems to the Web using simple green-screen commands. He has written several books, including Developing Web 2.0 Applications with EGL for IBM i, E-Deployment: The Fastest Path to the Web, Eclipse: Step by Step, and WDSC: Step by Step. Joe performs onsite mentoring and speaks at user groups around the country. You can reach him at This email address is being protected from spambots. You need JavaScript enabled to view it..


MC Press books written by Joe Pluta available now on the MC Press Bookstore.

Developing Web 2.0 Applications with EGL for IBM i Developing Web 2.0 Applications with EGL for IBM i
Joe Pluta introduces you to EGL Rich UI and IBM’s Rational Developer for the IBM i platform.
List Price $39.95

Now On Sale

WDSC: Step by Step WDSC: Step by Step
Discover incredibly powerful WDSC with this easy-to-understand yet thorough introduction.
List Price $74.95

Now On Sale

Eclipse: Step by Step Eclipse: Step by Step
Quickly get up to speed and productivity using Eclipse.
List Price $59.00

Now On Sale

BLOG COMMENTS POWERED BY DISQUS

LATEST COMMENTS

Support MC Press Online

$0.00 Raised:
$

Book Reviews

Resource Center

  • SB Profound WC 5536 Have you been wondering about Node.js? Our free Node.js Webinar Series takes you from total beginner to creating a fully-functional IBM i Node.js business application. You can find Part 1 here. In Part 2 of our free Node.js Webinar Series, Brian May teaches you the different tooling options available for writing code, debugging, and using Git for version control. Brian will briefly discuss the different tools available, and demonstrate his preferred setup for Node development on IBM i or any platform. Attend this webinar to learn:

  • SB Profound WP 5539More than ever, there is a demand for IT to deliver innovation. Your IBM i has been an essential part of your business operations for years. However, your organization may struggle to maintain the current system and implement new projects. The thousands of customers we've worked with and surveyed state that expectations regarding the digital footprint and vision of the company are not aligned with the current IT environment.

  • SB HelpSystems ROBOT Generic IBM announced the E1080 servers using the latest Power10 processor in September 2021. The most powerful processor from IBM to date, Power10 is designed to handle the demands of doing business in today’s high-tech atmosphere, including running cloud applications, supporting big data, and managing AI workloads. But what does Power10 mean for your data center? In this recorded webinar, IBMers Dan Sundt and Dylan Boday join IBM Power Champion Tom Huntington for a discussion on why Power10 technology is the right strategic investment if you run IBM i, AIX, or Linux. In this action-packed hour, Tom will share trends from the IBM i and AIX user communities while Dan and Dylan dive into the tech specs for key hardware, including:

  • Magic MarkTRY the one package that solves all your document design and printing challenges on all your platforms. Produce bar code labels, electronic forms, ad hoc reports, and RFID tags – without programming! MarkMagic is the only document design and print solution that combines report writing, WYSIWYG label and forms design, and conditional printing in one integrated product. Make sure your data survives when catastrophe hits. Request your trial now!  Request Now.

  • SB HelpSystems ROBOT GenericForms of ransomware has been around for over 30 years, and with more and more organizations suffering attacks each year, it continues to endure. What has made ransomware such a durable threat and what is the best way to combat it? In order to prevent ransomware, organizations must first understand how it works.

  • SB HelpSystems ROBOT GenericIT security is a top priority for businesses around the world, but most IBM i pros don’t know where to begin—and most cybersecurity experts don’t know IBM i. In this session, Robin Tatam explores the business impact of lax IBM i security, the top vulnerabilities putting IBM i at risk, and the steps you can take to protect your organization. If you’re looking to avoid unexpected downtime or corrupted data, you don’t want to miss this session.

  • SB HelpSystems ROBOT GenericCan you trust all of your users all of the time? A typical end user receives 16 malicious emails each month, but only 17 percent of these phishing campaigns are reported to IT. Once an attack is underway, most organizations won’t discover the breach until six months later. A staggering amount of damage can occur in that time. Despite these risks, 93 percent of organizations are leaving their IBM i systems vulnerable to cybercrime. In this on-demand webinar, IBM i security experts Robin Tatam and Sandi Moore will reveal:

  • FORTRA Disaster protection is vital to every business. Yet, it often consists of patched together procedures that are prone to error. From automatic backups to data encryption to media management, Robot automates the routine (yet often complex) tasks of iSeries backup and recovery, saving you time and money and making the process safer and more reliable. Automate your backups with the Robot Backup and Recovery Solution. Key features include:

  • FORTRAManaging messages on your IBM i can be more than a full-time job if you have to do it manually. Messages need a response and resources must be monitored—often over multiple systems and across platforms. How can you be sure you won’t miss important system events? Automate your message center with the Robot Message Management Solution. Key features include:

  • FORTRAThe thought of printing, distributing, and storing iSeries reports manually may reduce you to tears. Paper and labor costs associated with report generation can spiral out of control. Mountains of paper threaten to swamp your files. Robot automates report bursting, distribution, bundling, and archiving, and offers secure, selective online report viewing. Manage your reports with the Robot Report Management Solution. Key features include:

  • FORTRAFor over 30 years, Robot has been a leader in systems management for IBM i. With batch job creation and scheduling at its core, the Robot Job Scheduling Solution reduces the opportunity for human error and helps you maintain service levels, automating even the biggest, most complex runbooks. Manage your job schedule with the Robot Job Scheduling Solution. Key features include:

  • LANSA Business users want new applications now. Market and regulatory pressures require faster application updates and delivery into production. Your IBM i developers may be approaching retirement, and you see no sure way to fill their positions with experienced developers. In addition, you may be caught between maintaining your existing applications and the uncertainty of moving to something new.

  • LANSAWhen it comes to creating your business applications, there are hundreds of coding platforms and programming languages to choose from. These options range from very complex traditional programming languages to Low-Code platforms where sometimes no traditional coding experience is needed. Download our whitepaper, The Power of Writing Code in a Low-Code Solution, and:

  • LANSASupply Chain is becoming increasingly complex and unpredictable. From raw materials for manufacturing to food supply chains, the journey from source to production to delivery to consumers is marred with inefficiencies, manual processes, shortages, recalls, counterfeits, and scandals. In this webinar, we discuss how:

  • The MC Resource Centers bring you the widest selection of white papers, trial software, and on-demand webcasts for you to choose from. >> Review the list of White Papers, Trial Software or On-Demand Webcast at the MC Press Resource Center. >> Add the items to yru Cart and complet he checkout process and submit

  • Profound Logic Have you been wondering about Node.js? Our free Node.js Webinar Series takes you from total beginner to creating a fully-functional IBM i Node.js business application.

  • SB Profound WC 5536Join us for this hour-long webcast that will explore:

  • Fortra IT managers hoping to find new IBM i talent are discovering that the pool of experienced RPG programmers and operators or administrators with intimate knowledge of the operating system and the applications that run on it is small. This begs the question: How will you manage the platform that supports such a big part of your business? This guide offers strategies and software suggestions to help you plan IT staffing and resources and smooth the transition after your AS/400 talent retires. Read on to learn: