Skip to content

Style fixes from Vale #1490

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 6, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -746,7 +746,7 @@ The values represented in this guide are current as of publication, but are subj
If the process fails, ensure that you do not already have an existing Storm image with the same name in the Linode Manager. If you do, delete it and run the command again, or recreate this image with a different name.

{{< note >}}
During this process, a short-lived 2GB linode is created and deleted. This will entail a small cost in the monthly invoice and trigger an event notification email to be sent to the address you have registered with Linode. This is expected behavior.
During this process, a short-lived 2GB Linode is created and deleted. This will entail a small cost in the monthly invoice and trigger an event notification email to be sent to the address you have registered with Linode. This is expected behavior.
{{< /note >}}

### Create a Storm Cluster
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ title: 'How to Install a Turtl Server on Ubuntu'

[Turtl](https://turtlapp.com/docs) is an open-source alternative to cloud-based storage services. With a focus on privacy, Turtl offers a place to store and access your passwords, bookmarks and pictures. Hosting your own Turtl server on a secure Linode allows you to monitor your own security.

The Turtl server is written in Common Lisp, and the low-level encryption is derived from the Stanford Javascript Crypto Library. If encryption is important to you, read over the [encryption specifics](https://turtlapp.com/docs/security/encryption-specifics/) section of the official documentation.
The Turtl server is written in Common Lisp, and the low-level encryption is derived from the Stanford JavaScript Crypto Library. If encryption is important to you, read over the [encryption specifics](https://turtlapp.com/docs/security/encryption-specifics/) section of the official documentation.


## Before You Begin
Expand Down Expand Up @@ -45,16 +45,16 @@ The Turtl server has to be built from source. Download all of the dependencies a

Download the Libuv package from the official repository:

wget https://dist.libuv.org/dist/v1.13.0/libuv-v1.13.0.tar.gz
tar -xvf libuv-v1.13.0.tar.gz
wget https://dist.libuv.org/dist/v1.13.0/libuv-v1.13.0.tar.gz
tar -xvf libuv-v1.13.0.tar.gz

Build the package from source:

cd libuv-v1.13.0
sudo sh autogen.sh
sudo ./configure
sudo make
sudo make install
sudo ./configure
sudo make
sudo make install

After the package is built, run `sudo ldconfig` to maintain the shared libracy cache.

Expand Down Expand Up @@ -98,13 +98,13 @@ According to the CCL [documentation](https://ccl.clozure.com/download.html), you
Quickly check if CCL has been installed correctly by updating the sources:

cd ccl
svn update
svn update

Move `ccl` to `/usr/bin` so `ccl` can run from the command line:

cd ..
sudo cp -r ccl/ /usr/local/src
sudo cp /usr/local/src/ccl/scripts/ccl64 /usr/local/bin
sudo cp /usr/local/src/ccl/scripts/ccl64 /usr/local/bin

Now, running `ccl64`, or `ccl` depending on your system, will launch a Lisp environment:

Expand Down Expand Up @@ -163,8 +163,8 @@ Download ASDF:
Load and install `asdf.lisp` in your CCL environment:

ccl64 --load quicklisp.lisp
(load (compile-file "asdf.lisp"))
(quit)
(load (compile-file "asdf.lisp"))
(quit)


### Install Turtl
Expand All @@ -191,7 +191,7 @@ Turtl does not ship with all of its dependencies. Instead, the Turtl community p
Edit the `/home/turtl/.ccl-init.lisp` to include:

(cwd "/home/turtl/api")
(load "/home/turtl/api/launch")
(load "/home/turtl/api/launch")

The first line tells Lisp to use the `cl-cwd` package that you cloned to change the current working directory to `/home/turtl/api`. You can change this to anything, but your naming conventions should be consistent. The second line loads your `launch.lisp`, loading `asdf` so that Turtl can run.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ To understand how Hiera works, consider this excerpt from the default `hiera.yam
{{< /file-excerpt >}}


This Hiera configuration instructs Puppet to accept variable values from `nodes/%{::trusted.certname}.yaml`. If your Linode's hostname is `examplehostname`, define a file called `nodes/examplehostname.yaml`). Any variables found in yaml files higher in the hierarchy are preferred, while any variable names that do not exist in those files will fall-through to files lower in the hierarchy (in this example, `common.yaml`).
This Hiera configuration instructs Puppet to accept variable values from `nodes/%{::trusted.certname}.yaml`. If your Linode's hostname is `examplehostname`, define a file called `nodes/examplehostname.yaml`). Any variables found in YAML files higher in the hierarchy are preferred, while any variable names that do not exist in those files will fall-through to files lower in the hierarchy (in this example, `common.yaml`).

The following configuration will define Puppet variables in `common.yaml` to inject variables into the `mysql::server` class.

Expand All @@ -122,7 +122,7 @@ class { '::mysql::server':
}
{{< /file >}}

We can also define the root password with the following Hiera configuration file. Create the following yaml file and note how the `root_password` parameter is defined as Hiera yaml:
We can also define the root password with the following Hiera configuration file. Create the following YAML file and note how the `root_password` parameter is defined as Hiera yaml:

{{< file "/etc/puppetlabs/code/environments/production/hieradata/common.yaml" >}}
mysql::server::root_password: examplepassword
Expand All @@ -146,14 +146,14 @@ Enter the password and MySQL returns its version:

### Define MySQL Resources

Using Hiera, we can define the rest of the MySQL configuration entirely in yaml. The following steps will create a database and user for use in a Wordpress installation.
Using Hiera, we can define the rest of the MySQL configuration entirely in yaml. The following steps will create a database and user for use in a WordPress installation.

1. Create a pre-hashed MySQL password. Replace the password `wordpresspassword` in this example, and when prompted for a the root MySQL password, use the first root password chosen in the previous section to authenticate. Note the string starting with a `*` that the command returns for Step 2:

mysql -u root -p -NBe 'select password("wordpresspassword")'
*E62D3F829F44A91CC231C76347712772B3B9DABC

2. With the MySQL password hash ready, we can define Hiera values. The following yaml defines parameters to create a database called `wordpress` and a user named `wpuser` that has permission to connect from `localhost`. The yaml also defines a `GRANT` allowing `wpuser` to operate on the `wordpress` database with `ALL` permissions:
2. With the MySQL password hash ready, we can define Hiera values. The following YAML defines parameters to create a database called `wordpress` and a user named `wpuser` that has permission to connect from `localhost`. The YAML also defines a `GRANT` allowing `wpuser` to operate on the `wordpress` database with `ALL` permissions:

{{< file "/etc/puppetlabs/code/environments/production/hieradata/common.yaml" yaml >}}
mysql::server::root_password: examplepassword
Expand Down Expand Up @@ -207,7 +207,7 @@ In the following example, Puppet will configure the MySQL server with one additi

This change instructs Hiera to look for Puppet parameters first in `"%{facts.os.family}.yaml"` and then in `common.yaml`. The first, fact-based element of the hierarchy is dynamic, and dependent upon the host that Puppet and Hiera control. In this Ubuntu-based example, Hiera will look for `Debian.yaml`, while on a distribution such as CentOS, the file `RedHat.yaml` will automatically be referenced instead.

2. Create the following yaml file:
2. Create the following YAML file:

{{< file "/etc/puppetlabs/code/environments/production/hieradata/Debian.yaml" yaml >}}
lookup_options:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ SSL (Secure Sockets Layer) is the standard security technology for establishing

![Linode API](/docs/assets/configuration-management/laravel_forge_adding_ssl.png)

Laravel Forge comes with LetsEncrypt which help us generate a free SSL certificate.
Laravel Forge comes with Let's Encrypt which help us generate a free SSL certificate.

4. If you already have an SSL certificate, click on the Install Existing Certificate. Otherwise, select **LetsEncrypt (Beta)**.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Node.js is a server-side, JavaScript package, often used for various cloud appli
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.

{{< note >}}
Docker images made for one operating system can be used on servers running a different OS. The **server-node-js** Ubuntu 14.04 image was tested on Debian 7, Ubuntu 14.04, Centos 7 and Fedora 21. After Docker installation on Centos and Fedora, run the `sudo service docker start` command.
Docker images made for one operating system can be used on servers running a different OS. The **server-node-js** Ubuntu 14.04 image was tested on Debian 7, Ubuntu 14.04, CentOS 7 and Fedora 21. After Docker installation on CentOS and Fedora, run the `sudo service docker start` command.
{{< /note >}}

1. Search for **linode** images:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -267,7 +267,7 @@ Adding an image through markdown requires having the images stored in the projec

![GG Plot](/docs/assets/jekyll/jekyll_ggplot.png "GG Plot")

This is just an example. Adding interactive graphs using Javascript libraries is beyond the scope of this guide.
This is just an example. Adding interactive graphs using JavaScript libraries is beyond the scope of this guide.

### Use a CDN to Support MathJax

Expand Down
2 changes: 1 addition & 1 deletion docs/databases/postgresql/centos-5.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ local all all md5
{{< /file-excerpt >}}


As root, restart the Postgresql service:
As root, restart the PostgreSQL service:

service postgresql restart

Expand Down
2 changes: 1 addition & 1 deletion docs/databases/postgresql/fedora-12.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ local all all md5
{{< /file-excerpt >}}


As root, restart the Postgresql service:
As root, restart the PostgreSQL service:

service postgresql restart

Expand Down
2 changes: 1 addition & 1 deletion docs/databases/postgresql/fedora-13.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ local all all md5
{{< /file-excerpt >}}


As root, restart the Postgresql service:
As root, restart the PostgreSQL service:

service postgresql restart

Expand Down
4 changes: 2 additions & 2 deletions docs/databases/postgresql/fedora-14.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ The current version of the database server will be installed, along with several

# Configure PostgreSQL

### Set the Postgresql Password
### Set the PostgreSQL Password

Set a password for the "postgres" user by issuing the following command (be sure to substitute your postgres password for "CHANGME" below):

Expand Down Expand Up @@ -128,7 +128,7 @@ Change it to the following to use password authentication:
local all all md5
{{< /file-excerpt >}}

As root, restart the Postgresql service:
As root, restart the PostgreSQL service:

service postgresql restart

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ external_resources:
- '[PostgreSQL Documentation](http://www.postgresql.org/docs/)'
---

PgAdmin is a free, open-source PostgreSQL database administration GUI for Microsoft Windows, Apple MacOS X and Linux systems. It offers database server information retrieval, development, testing, and ongoing maintenance. This guide will help you install pgAdmin on Windows, providing secure, remote access to PostgreSQL databases. It is assumed that you have already installed PostgreSQL on your Linode in accordance with our [PostgreSQL installation guides](/docs/databases/postgresql/).
PgAdmin is a free, open-source PostgreSQL database administration GUI for Microsoft Windows, Mac OS X, and Linux systems. It offers database server information retrieval, development, testing, and ongoing maintenance. This guide will help you install pgAdmin on Windows, providing secure, remote access to PostgreSQL databases. It is assumed that you have already installed PostgreSQL on your Linode in accordance with our [PostgreSQL installation guides](/docs/databases/postgresql/).

## Install pgAdmin

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -401,7 +401,7 @@ While specific settings and privileges can be applied to a role when it's create

ALTER ROLE examplerole CREATEDB;

A number of permissions can be applied when creating or altering a role. See the [PostgeSQL Documentation](https://www.postgresql.org/docs/9.2/static/sql-createrole.html) for more details.
A number of permissions can be applied when creating or altering a role. See the [PostgreSQL Documentation](https://www.postgresql.org/docs/9.2/static/sql-createrole.html) for more details.

3. Use `\du` to confirm your changes. You'll see that the "Create DB" attribute is listed next to the `examplerole` user:

Expand Down
2 changes: 1 addition & 1 deletion docs/databases/postgresql/ubuntu-10-04-lucid.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ local all all md5
{{< /file-excerpt >}}


If you changed the authentication method as shown above, restart Postgresql with the following command:
If you changed the authentication method as shown above, restart PostgreSQL with the following command:

/etc/init.d/postgresql-8.4 restart

Expand Down
2 changes: 1 addition & 1 deletion docs/databases/postgresql/ubuntu-10-10-maverick.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ local all all md5
{{< /file-excerpt >}}


If you changed the authentication method as shown above, restart Postgresql with the following command:
If you changed the authentication method as shown above, restart PostgreSQL with the following command:

/etc/init.d/postgresql-8.4 restart

Expand Down
2 changes: 1 addition & 1 deletion docs/databases/postgresql/ubuntu-9-10-karmic.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ local all all md5
{{< /file-excerpt >}}


If you changed the authentication method as shown above, restart Postgresql with the following command:
If you changed the authentication method as shown above, restart PostgreSQL with the following command:

/etc/init.d/postgresql-8.4 restart

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ local all all md5
{{< /file-excerpt >}}


If you changed the authentication method as shown above, restart Postgresql with the following command:
If you changed the authentication method as shown above, restart PostgreSQL with the following command:

service postgresql restart

Expand Down
24 changes: 12 additions & 12 deletions docs/development/ci/automate-builds-with-jenkins-on-ubuntu.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,11 +64,11 @@ Before starting automating your entire workflow, it's necessary to understand th

As you can see the most basic process consist of three phases: build - test - deploy. Each time you make changes on your distributed version control system you trigger an automation cycle on the Jenkins server. The entire set of instructions for running the process is on the `Jenkinsfile` located at the root of your source repository. That single file tells the server *what* to do, *when* to do it and *how* you want those tasks to be performed.

## Write an Example NodeJS Application
## Write an Example Node.js Application

As mentioned in the previous section, the automation process starts by making a commit to a Version Control System.

Create a new repository in GitHub. This guide will use a simple NodeJS application to showcase how Jenkins Pipelines works, select your `.gitignore` accordingly and don't forget to initialize it with a `README`:
Create a new repository in GitHub. This guide will use a simple Node.js application to showcase how Jenkins Pipelines works, select your `.gitignore` accordingly and don't forget to initialize it with a `README`:

![New GitHub repository](/docs/assets/jenkins/jenkins-gh-new-repo.png)

Expand Down Expand Up @@ -145,7 +145,7 @@ This example will use two Docker containers, one to serve `app.js` using Express

2. Create the `Dockerfile` and `package.json` for the `express-image`.

{{< file "~/jenkins-guide/express-image/Dockerfile" >}}
{{< file "~/jenkins-guide/express-image/Dockerfile" >}}
FROM node:6-alpine

# Create server working directory
Expand All @@ -165,11 +165,11 @@ EXPOSE 9000
CMD ["npm", "start"]
{{< /file >}}

This image runs by default `app.js` when launched. You can think of it as the "dockerized" version of the web application.
This image runs by default `app.js` when launched. You can think of it as the "dockerized" version of the web application.

3. The Dockerfile copies a `package.json` file from the root of your project directory into the new image; create this file and add the following content:

{{< file "~/jenkins-guide/express-image/package.json" json >}}
{{< file "~/jenkins-guide/express-image/package.json" json >}}
{
"name": "express-image",
"version": "1.0.0",
Expand All @@ -192,7 +192,7 @@ CMD ["npm", "start"]
4. Create the `Dockerfile` for the `test-image`.


{{< file "~/jenkins-guide/test-image/Dockerfile" conf >}}
{{< file "~/jenkins-guide/test-image/Dockerfile" conf >}}
FROM node:6-alpine

# Create Reports directory
Expand All @@ -214,11 +214,11 @@ EXPOSE 9000
CMD ["npm", "test"]
{{< /file >}}

This image creates a Report folder (which will be used later) and installs dependencies from `package.json`. On start, it executes the Mocha tests.
This image creates a Report folder (which will be used later) and installs dependencies from `package.json`. On start, it executes the Mocha tests.

5. Add a `package.json` file for your testing image:

{{< file "~/jenkins-guide/test-image/package.json" conf >}}
{{< file "~/jenkins-guide/test-image/package.json" conf >}}
{
"name": "test-image",
"version": "1.0.0",
Expand Down Expand Up @@ -246,7 +246,7 @@ CMD ["npm", "test"]
}
{{< /file >}}

This JSON file contains all the necessary dependencies, including `mocha-junit-reporter` that will be needed by Jenkins for tests storage. Notice that the test script is configured with the `mochaFile` option that uses the image's report folder specified in the `Dockerfile`.
This JSON file contains all the necessary dependencies, including `mocha-junit-reporter` that will be needed by Jenkins for tests storage. Notice that the test script is configured with the `mochaFile` option that uses the image's report folder specified in the `Dockerfile`.

Your final project distribution will be similar to this:

Expand Down Expand Up @@ -345,7 +345,7 @@ Using the package maintained by the Jenkins project allows you to use a more rec

7. Use the Linode Manager to reboot your server to apply these changes.

{{< caution >}}
{{< caution >}}
It's out of the scope of this guide to establish security parameters for Jenkins remote installation. However, be aware of these critical points that need to be addressed in a production environment:

- When you add `jenkins` user to the Docker group you are technically giving it `root` permissions.
Expand Down Expand Up @@ -511,7 +511,7 @@ From here you can obtain valuable information regarding: 1) your build number, 2

### Automate Your Entire Process with Jenkins

The `Jenkinsfile` template uses a very basic pipeline structure with only three stages. You can customize it to accommodate as many stages as needed. The final Pipeline structure is dictated by the project complexity and the development guidelines you must follow. Since you've already walked through the NodeJS example, you know how to design a pipeline that automates each stage. For the purpose of this guide, the resulting pipeline should:
The `Jenkinsfile` template uses a very basic pipeline structure with only three stages. You can customize it to accommodate as many stages as needed. The final Pipeline structure is dictated by the project complexity and the development guidelines you must follow. Since you've already walked through the Node.js example, you know how to design a pipeline that automates each stage. For the purpose of this guide, the resulting pipeline should:

* Build Stage
- Create both images and abort any further testing or deployment if an error is encountered.
Expand Down Expand Up @@ -831,7 +831,7 @@ Now, induce an error on the `BUILD` stage.

1. Edit your `express-image/package.json`. Change the express package name to `express-ERROR` to simulate a mistyping.

{{< file-excerpt "~/jenkins-guide/express-image/package.json" json >}}
{{< file-excerpt "~/jenkins-guide/express-image/package.json" json >}}
"dependencies": {
"express-ERROR": "^4.13.3"
}
Expand Down
Loading