0.1.2 • Published 4 years ago

menu-maker v0.1.2

Weekly downloads
2
License
MIT
Repository
github
Last release
4 years ago

menu-maker

Build a summary document for a set of Markdown files that follow a basic convention

Right now this project is intended for a very specific purpose and is limited to generating markdown targeting files that look like this:

# Ansible Tower Deep Dive

> A demo of Ansible Tower, its key features, and potential integrations.

*duration*: 60 minutes
*audience*: Infrastructure Engineers
*category*: Deep Dive

## Overview

An Ansible Tower Demo can be delivered at any time. It will cover subects such as 

-   Projects and Git integration
-   Templates and how to run playbooks in Tower
-   Credentials and how to store them and save them in Tower
-   Surveys and how to attach them to playbooks
-   Schedules and how to set playbooks on schedules
-   Automated tickets with ServiceNow 
-   Network config auditing/compliance
-   Target Audience would be anyone interested in Ansible Tower

## Prerequirements

-   Basic understanding of Ansible

If you follow that structure the CLI will work. This is the only snippet that is relevant for generating the menu:

# Ansible Tower Deep Dive

> A demo of Ansible Tower, its key features, and potential integrations.

*duration*: 60 minutes
*audience*: Infrastructure Engineers
*category*: Deep Dive

Here is an example generated menu:

![MENU](images/menu.jpeg)

## Ansible Tower Deep Dive

A demo of Ansible Tower, its key features, and potential integrations.

_Duration_: 60 minutes  
_Audience_: Infrastructure Engineers

[(docs)](content/ansible/deep-dives/ansible-tower-deep-dive.md)

## Red Hat OpenShift for Security Engineers

Red Hat OpenShift provides defense-in-depth from an infrastructure, developer workflow, and software supply chain perspective. This session introduces how this works and how it relates to the current approach to information security.

_Duration_: 90 minutes  
_Audience_: Security Engineers

[(docs)](content/openshift/webinars/openshift-for-security-engineers.md)

Requirements

  • NodeJS 12+ if you aren't using a precompiled binary

Install

You can either install through NPM if you have NodeJS on your system... npm install -g menu-maker ...or you can download a binary for your platform on the project releases page. These are binaries created with pkg if you want to target a different node version or

Usage

If you don't want to install it globally:

npx menu-maker MENU.md content/**/*/md

If you have already installed it globally or are using a precompiled binary:

menu-maker MENU.md content/**/*/md

Issues

The tool hasn't been tested since it was just an experiment. It has only been tested on a happy path and has no error handling for files that don't follow the convention shared above. Make sure to get your file glob right when running the tool!