Skip to content

Commit

Permalink
Refactor shortguides (linode#1996)
Browse files Browse the repository at this point in the history
* Turned non-bundle shortguides into bundles

* Renamed shortguide yaml to headless

* Upated shortguide archetype, writers guide to use headless yaml and leaf bundles

* Update writer's guide to explain how to use image shortcode for shortguides

* Adding headless to CI test yaml_rules

* Spelling fix

* Dictionary fix
nmelehan authored and Guaris committed Aug 24, 2018
1 parent 976e727 commit 94a49a2
Showing 63 changed files with 112 additions and 87 deletions.
2 changes: 1 addition & 1 deletion archetypes/shortguide.md
Original file line number Diff line number Diff line change
@@ -10,7 +10,7 @@ modified: {{ now.Format "2006-01-02" }}
modified_by:
name: Linode
title: "{{ replace .TranslationBaseName "-" " " | title }}"
shortguide: true
headless: true
show_on_rss_feed: false
---

1 change: 1 addition & 0 deletions ci/vale/dictionary.txt
Original file line number Diff line number Diff line change
@@ -1063,6 +1063,7 @@ rundir
runlevels
runtime
runtimes
rvm
rw
rwx
rwxr
12 changes: 6 additions & 6 deletions ci/yaml_rules.json
Original file line number Diff line number Diff line change
@@ -65,6 +65,12 @@
"type": "list",
"description": "List of external links that will appear at the bottom of the guide."
},
"headless": {
"elements": false,
"required": false,
"type": "bool",
"description": "If true, this guide will be hidden from all layouts and search index and will not be rendered unless embedded in another guide."
},
"icon": {
"elements": false,
"required": false,
@@ -136,12 +142,6 @@
"type": "date",
"description": "Date this guide was originally published. Should use the form YYYY-MM-DD."
},
"shortguide": {
"elements": false,
"required": false,
"type": "bool",
"description": "If true, this guide will be hidden from all layouts and search index."
},
"show_on_frontpage": {
"elements": false,
"required": false,
Original file line number Diff line number Diff line change
@@ -29,7 +29,7 @@ Web pages are structured documents, and Beautiful Soup gives you the tools to wa

### Install Python

{{< content "install_python_miniconda.md" >}}
{{< content "install_python_miniconda" >}}

### Install Beautiful Soup and Dependencies

Original file line number Diff line number Diff line change
@@ -23,7 +23,7 @@ Nextcloud 13 is a cloud storage platform that offers users the ability to self-h

You will need a Linode with Docker CE installed to follow along with the steps in this guide.

{{< content "install-docker-ce.md" >}}
{{< content "install-docker-ce" >}}

## Install Nextcloud 13 and Talk

@@ -71,7 +71,7 @@ The basic Nextcloud Docker image is already configured for persistent data in th

### Install Docker Compose

{{< content "install-docker-compose.md" >}}
{{< content "install-docker-compose" >}}

### Create docker-compose.yaml

Original file line number Diff line number Diff line change
@@ -28,11 +28,11 @@ Nextcloud is a cloud storage platform that allows you to store and access your f

### Docker

{{< content "install-docker-ce.md" >}}
{{< content "install-docker-ce" >}}

### Docker Compose

{{< content "install-docker-compose.md" >}}
{{< content "install-docker-compose" >}}

## Attach a Block Storage Volume

Original file line number Diff line number Diff line change
@@ -55,7 +55,7 @@ The remainder of the commands in this guide should be performed from the control

### Install Miniconda

{{< content "install_python_miniconda.md" >}}
{{< content "install_python_miniconda" >}}

### Install Ansible

Original file line number Diff line number Diff line change
@@ -34,11 +34,11 @@ You will need a Linode with Docker and Docker Compose installed to complete this

### Install Docker

{{< content "install-docker-ce.md" >}}
{{< content "install-docker-ce" >}}

### Install Docker Compose

{{< content "install-docker-compose.md" >}}
{{< content "install-docker-compose" >}}

## Prepare the Environment

Original file line number Diff line number Diff line change
@@ -29,7 +29,7 @@ Configuring the containers to communicate with each other and the host machine c

You will need a Linode with Docker CE installed to follow along with the steps in this guide.

{{< content "install-docker-ce.md" >}}
{{< content "install-docker-ce" >}}

## Example Node.js Application

Original file line number Diff line number Diff line change
@@ -130,7 +130,7 @@ If you are unable to ping any of your hosts by their hostnames or private IPs:

### Install Docker

{{< content "install-docker-ce.md" >}}
{{< content "install-docker-ce" >}}

### Install kubeadm, kubectl, and kubelet

Original file line number Diff line number Diff line change
@@ -38,7 +38,7 @@ The steps in this guide require root privileges. Be sure to run the steps below

## Install Docker

{{< content "install-docker-ce.md" >}}
{{< content "install-docker-ce" >}}

## Start and Enable Docker

Original file line number Diff line number Diff line change
@@ -29,11 +29,11 @@ Generally the containers in an application built using Docker Compose will all r

You will need a Linode with Docker CE installed to follow along with the steps in this guide.

{{< content "install-docker-ce.md" >}}
{{< content "install-docker-ce" >}}

### Install Docker Compose

{{< content "install-docker-compose.md" >}}
{{< content "install-docker-compose" >}}

## Basic Usage

Original file line number Diff line number Diff line change
@@ -10,7 +10,7 @@ modified_by:
name: Sam Foo
title: "How to Install Docker CE"
published: 2018-01-08
shortguide: true
headless: true
show_on_rss_feed: false
---

Original file line number Diff line number Diff line change
@@ -10,7 +10,7 @@ modified_by:
name: Sam Foo
title: "How to Install Docker Compose"
published: 2018-01-08
shortguide: true
headless: true
---

<!--- Installation instructions for Docker Compose -->
Original file line number Diff line number Diff line change
@@ -22,7 +22,7 @@ Node.js is a server-side, JavaScript package, often used for various cloud appli

## Install Docker

{{< content "install-docker-ce.md" >}}
{{< content "install-docker-ce" >}}

## Download the Docker Node.js Server Image
The Docker Hub user page for Linode can be accessed [here](https://hub.docker.com/u/linode/). Select the **server-node-js** image for configuration information.
Original file line number Diff line number Diff line change
@@ -26,7 +26,7 @@ This guide shows how to set up Subsonic on a Linode running Debian or Ubuntu. If

You will need Java installed on your system to run Subsonic.

{{< content "install-java-8-ppa.md" >}}
{{< content "install-java-8-ppa" >}}

## Install Subsonic

Original file line number Diff line number Diff line change
@@ -107,7 +107,7 @@ server {

Your Rocket.Chat site will use an SSL certificate from [Let's Encrypt](https://letsencrypt.org), which is a free certificate provider trusted by common web browsers. A popular tool called [Certbot](https://certbot.eff.org) makes getting and using a Let's Encrypt certificate easy:

{{< content "certbot-shortguide-ubuntu.md" >}}
{{< content "certbot-shortguide-ubuntu" >}}

## View Your Rocket.Chat Site

Original file line number Diff line number Diff line change
@@ -23,7 +23,7 @@ Apache Guacamole is an HTML5 application useful for accessing a remote desktop t
## Install Docker
The installation method presented here will install the latest version of Docker. Consult the official documentation to install a specific version or if Docker EE is needed.

{{< content "install-docker-ce.md" >}}
{{< content "install-docker-ce" >}}

## Initialize Guacamole Authentication with MySQL
MySQL will be used in this guide, but PostgreSQL and MariaDB are supported alternatives.
Original file line number Diff line number Diff line change
@@ -67,7 +67,7 @@ As of this writing, Elasticsearch requires Java 8.

### Elasticsearch

{{< content "install_elasticsearch_debian_ubuntu.md" >}}
{{< content "install_elasticsearch_debian_ubuntu" >}}

You are now ready to install and use Elasticsearch plugins.

Original file line number Diff line number Diff line change
@@ -10,7 +10,7 @@ modified_by:
name: Linode
title: "Install Elasticsearch on Fedora, Red Hat, and CentOS"
published: 2018-01-09
shortguide: true
headless: true
---

1. Trust the Elastic signing key:
Original file line number Diff line number Diff line change
@@ -10,7 +10,7 @@ modified_by:
name: Linode
title: "Install Elasticsearch on Debian and Ubuntu"
published: 2018-01-09
shortguide: true
headless: true
---

1. Install the official Elastic APT package signing key:
Original file line number Diff line number Diff line change
@@ -27,7 +27,7 @@ There are a number of additional databases that are supported from SQLite to Pos

### Java Runtime Environment

{{< content "install-java-8-ppa.md" >}}
{{< content "install-java-8-ppa" >}}

### MySQL Server

Original file line number Diff line number Diff line change
@@ -10,7 +10,7 @@ modified_by:
name: Linode
title: "Back up a MySQL database with mysqldump - Shortguide"
published: 2018-08-13
shortguide: true
headless: true
---

<!-- This shortguide assumes that there's a heading on the referring page -->
Original file line number Diff line number Diff line change
@@ -10,7 +10,7 @@ modified_by:
name: Linode
title: "Restore a MySQL database from mysqldump - Shortguide"
published: 2018-08-13
shortguide: true
headless: true
---

<!-- This shortguide assumes that there's a heading on the referring page -->
Original file line number Diff line number Diff line change
@@ -32,7 +32,7 @@ This guide will use a Raspberry Pi 3 with a [Sense HAT](https://www.raspberrypi.

ThingsBoard runs on Java 8, and the Oracle JDK is recommended.

{{< content "install-java-jdk.md" >}}
{{< content "install-java-jdk" >}}

### Set Up PostgreSQL

Original file line number Diff line number Diff line change
@@ -52,7 +52,7 @@ You will need a Linode with both Java 8 and NGINX. If these are already installe

### Install NGINX

{{< content "install-nginx-ubuntu-ppa.md" >}}
{{< content "install-nginx-ubuntu-ppa" >}}

## Install Spring Boot CLI
The Spring Boot CLI makes creating a scaffold for a project much easier. [SDKMAN!](http://sdkman.io/) is a tool that simplifies installation of the Spring CLI and build tools such as Gradle or Maven. Using the Spring Boot CLI, a new project can be created directly from the command line.
Original file line number Diff line number Diff line change
@@ -10,7 +10,7 @@ modified_by:
name: Sam Foo
title: "How to Install Java 8 JDK"
published: 2018-01-09
shortguide: true
headless: true
show_on_rss_feed: false
---
The steps in this section will install the Java 8 JDK on Ubuntu 16.04. For other distributions, see the [official docs](https://docs.oracle.com/javase/8/docs/technotes/guides/install/linux_jdk.html#BJFGGEFG).
Original file line number Diff line number Diff line change
@@ -10,7 +10,7 @@ modified_by:
name: Jared Kobos
title: "How to install JDK on Ubuntu"
published: 2018-01-30
shortguide: true
headless: true
show_on_rss_feed: false
---

Original file line number Diff line number Diff line change
@@ -23,7 +23,7 @@ File system monitoring through `inotify` can be interfaced through Python using

## Install Python 3

{{< content "install_python_miniconda.md" >}}
{{< content "install_python_miniconda" >}}

## Install Pyinotify

Original file line number Diff line number Diff line change
@@ -35,7 +35,7 @@ Install Java and other dependencies on each Linode that will be part of the Sele

### Install Java

{{< content "install-java-8-ppa.md" >}}
{{< content "install-java-8-ppa" >}}

### Install Dependencies

@@ -172,7 +172,7 @@ In this example, the test script will be run from your local development machine

This guide uses the NPM `selenium-webdriver` package, which contains Node.js bindings for Selenium.

{{< content "install-nodejs-nodesource.md" >}}
{{< content "install-nodejs-nodesource" >}}

### Create an Example Test Script

Original file line number Diff line number Diff line change
@@ -10,7 +10,7 @@ modified: 2018-03-26
modified_by:
name: Linode
title: 'Install Node.js from NodeSource on Debian or Ubuntu'
shortguide: true
headless: true
---

1. Use `curl` to download the setup script provided by NodeSource. Replace the Node version in the `curl` command with the [version you would like to install](https://github.com/nodesource/distributions/tree/master/deb):
Original file line number Diff line number Diff line change
@@ -9,7 +9,7 @@ modified_by:
name: Leslie Salazar
title: "How to install direnv"
published: 2018-06-12
shortguide: true
headless: true
show_on_rss_feed: false
---
<!-- Start direnv shortguide. -->
Original file line number Diff line number Diff line change
@@ -10,7 +10,7 @@ modified_by:
name: Sam Foo
title: "How to install Python 3 with Miniconda"
published: 2018-01-09
shortguide: true
headless: true
show_on_rss_feed: false
---
<!-- Installation instructions for Python 3. -->
4 changes: 2 additions & 2 deletions docs/development/python/introduction-to-pyspark/index.md
Original file line number Diff line number Diff line change
@@ -31,11 +31,11 @@ The installation process requires the installation of Scala, which has Java JDK

### Miniconda

{{< content "install_python_miniconda.md" >}}
{{< content "install_python_miniconda" >}}

### Java JDK 8

{{< content "install-java-8-ppa.md" >}}
{{< content "install-java-8-ppa" >}}

### Scala

Original file line number Diff line number Diff line change
@@ -39,7 +39,7 @@ This guide is written for a non-root user. Commands that require elevated privil

## Install a Python 3 Environment

{{< content "install_python_miniconda.md" >}}
{{< content "install_python_miniconda" >}}

## Install Celery

Original file line number Diff line number Diff line change
@@ -54,7 +54,7 @@ The steps in this section should be completed on your Linode.

### Install R

{{< content "install_r_ubuntu.md" >}}
{{< content "install_r_ubuntu" >}}

### Add the Shiny Package

Original file line number Diff line number Diff line change
@@ -23,7 +23,7 @@ Although R can be installed through the default Debian or Ubuntu repository, the

## Install R on Ubuntu 16.04 and Debian 9

{{< content "install_r_ubuntu.md" >}}
{{< content "install_r_ubuntu" >}}

## Download Packages from CRAN

Original file line number Diff line number Diff line change
@@ -10,7 +10,7 @@ modified_by:
name: Sam Foo
title: "How to Install R on Ubuntu"
published: 2018-02-07
shortguide: true
headless: true
show_on_rss_feed: false
---

Loading

0 comments on commit 94a49a2

Please sign in to comment.