xyhhx / docs

Linode guides and tutorials.

Guides and Tutorials

Contributing | Formatting Guide

Linode maintains a library of tutorials hosted at https://www.linode.com/docs/. The guides serve as an easy to follow reference for Linux, web servers, development, and more.

Quickstart

1. Fork and clone this repository.

2. Download and install Hugo version v0.105.0. Installation instructions for different operating systems are available in the Hugo documentation library.

3. In your terminal, navigate into the cloned docs repository.

4. Use the Node Version Manager (NVM) to install and use version 14.18.1 of Node:

    nvm install 14.18.1
    nvm use 14.18.1
   

5. Install the Node dependencies:

    npm install
   

6. Start the local Hugo web server:

    hugo server
   

   Note: The first time Hugo is run on your workstation, it needs to compile a cache of web-optimized images for each guide in the documentation library. This process can take 10-20 minutes. If you run Hugo again in the future, the cache from your first build is reused and the startup time is much faster.

7. In a web browser, navigate to localhost:1313/docs/.

How can I write a guide?

We are constantly looking to improve the quality of our library. Visit our Contribute Page.

More detailed instructions on submitting a pull request can be found here.