Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
3e2bf54
Draft: Host static site on OS
leslitagordita Apr 9, 2019
dd4363b
Tech Edit
andystevensname Apr 15, 2019
4b7d124
Copy edit
nmelehan Apr 23, 2019
6b6f020
removed link to other object storage guide until that one is added
Jun 11, 2019
b711235
updating 4 guides with cap Markdown re Object Storage guide updated r…
Jun 11, 2019
271d571
updated endpoint url
Jun 11, 2019
3b3459a
updated url to offical object storage for static site pages
Jun 11, 2019
ac371a0
Rough Draft
andystevensname Apr 12, 2019
cdfa1e0
Vale fixes
andystevensname Apr 12, 2019
4987dd5
Include links to static site guide
andystevensname Apr 15, 2019
7b5424f
Added Static Site sections to each tool
andystevensname Apr 16, 2019
e3f94e5
Tech edit
nmelehan Apr 22, 2019
6311ffb
Fix instructions for recursive delete
nmelehan Apr 22, 2019
fc4c567
Fix anchor link
nmelehan Apr 23, 2019
245b1d5
Copy Edit
Apr 25, 2019
84700d7
Add dummy link to SSG Obj guide
leslitagordita May 9, 2019
df465ae
updated screenshots and urls with new cloud manager
Jun 11, 2019
93dd04d
updating twisted to 19.2.1 (#2537)
hzoppetti Jun 12, 2019
8a5ddb4
Merge pull request #2539 from hzoppetti/new-how-to-use-obj-store
hzoppetti Jun 12, 2019
c26318a
Merge pull request #2538 from hzoppetti/new-object-storage
hzoppetti Jun 12, 2019
19c60f1
Update Obj storage section description
leslitagordita Jun 12, 2019
04f0299
Update guide titles and descriptions
leslitagordita Jun 12, 2019
77812cf
Merge branch 'develop' into feature/objectstorage
leslitagordita Jun 12, 2019
77827a4
remove mentions to linode object storage cli
Jun 13, 2019
0a50d57
removed unneeded step for profile click
Jun 13, 2019
be8f840
Update placeholder links
nmelehan Jun 20, 2019
74181e6
Update Disclaimer with correct signup instructions
andystevensname Jun 24, 2019
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
1 change: 1 addition & 0 deletions ci/vale/dictionary.txt
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,7 @@ bootable
bootloader
bootup
bootups
boto
bounceback
brackley
bram
Expand Down
1 change: 1 addition & 0 deletions ci/vale/styles/Linode/Terms.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,5 +33,6 @@ swap:
yaml: YAML
urls: URLs
uris: URIs
markdown: Markdown
Cuda: CUDA
gpu: GPU
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Setting up these mechanisms offers an array of benefits:

## Development and Deployment Workflow

The static site generator used in this guide is [Hugo](https://gohugo.io), a fast framework written in Go. Static site generators compile [markdown](https://en.wikipedia.org/wiki/Markdown) or other content files into HTML files. This guide can easily be adapted to other frameworks.
The static site generator used in this guide is [Hugo](https://gohugo.io), a fast framework written in Go. Static site generators compile [Markdown](https://en.wikipedia.org/wiki/Markdown) or other content files into HTML files. This guide can easily be adapted to other frameworks.

Two Git repositories will be created: one will track changes to the Hugo site, and the other will track Salt's configuration files. Remote repositories will be created for both on GitHub.

Expand Down Expand Up @@ -482,7 +482,7 @@ The Salt minion's formula needs to be updated in order to serve the Hugo site. S

- Install Git and clone the Hugo site repository from GitHub.

- Install Hugo and build the HTML files from the markdown content.
- Install Hugo and build the HTML files from the Markdown content.

- Update the NGINX configuration to serve the built site.

Expand Down Expand Up @@ -993,7 +993,7 @@ Hook rules were not satisfied.⏎

hugo new post/test-post.md

1. This command creates a new partially filled in markdown document in `content/post/`. Open this file in your editor, remove the `draft: true` line from the [*frontmatter*](https://gohugo.io/content-management/front-matter/), and add some body text:
1. This command creates a new partially filled in Markdown document in `content/post/`. Open this file in your editor, remove the `draft: true` line from the [*frontmatter*](https://gohugo.io/content-management/front-matter/), and add some body text:

{{< file "example-hugo-site/content/post/test-post.md" >}}
---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ def hello_word():
{{< /file >}}


5. The `setup.cfg` file lets PyPI know the README is a markdown file:
5. The `setup.cfg` file lets PyPI know the README is a Markdown file:

{{< file "setup.cfg" >}}
[metadata]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ The steps in this section can be completed from either your local machine or fro

This section demonstrates some common features of a Jupyter Notebook that can be rendered as HTML on a Jekyll blog. There are four types of outputs from a Jupyter Notebook cell covered here: MathJex through LaTeX in Markdown, an HTML table, console output, and graphs from a plotting function. The Iris dataset will be used as an example to generate the output in this guide.

1. Open the notebook of interest, or use the code below to create an example notebook. Run all of the relevant cells so that the output you want to display on your Jekyll blog is visible on the page. Navigate to `File > Download As > Markdown (.md)`. The markdown file will save to the default `Downloads` folder of the browser.
1. Open the notebook of interest, or use the code below to create an example notebook. Run all of the relevant cells so that the output you want to display on your Jekyll blog is visible on the page. Navigate to `File > Download As > Markdown (.md)`. The Markdown file will save to the default `Downloads` folder of the browser.

![Jupyter Menu](jupyter_menu.png "Jupyter Menu")

Expand Down Expand Up @@ -175,11 +175,11 @@ sns.pairplot(x_vars=["petal-length"], y_vars=["petal-width"], data=iris, hue="cl
{{< /file >}}


3. Inside the `_posts` folder of the Jekyll project, create a new markdown file called `YYYY-MM-DD-example-post.md`. If the date format is incorrect, the post may not be displayed on the blog:
3. Inside the `_posts` folder of the Jekyll project, create a new Markdown file called `YYYY-MM-DD-example-post.md`. If the date format is incorrect, the post may not be displayed on the blog:

touch YYYY-MM-DD-example-post.md

4. The markdown file should begin with three dashes and contain headers which provide information for Jekyll to populate the post with the appropriate page data. The date must be in the format specified. The hours, minutes, seconds, and timezone adjustment are optional:
4. The Markdown file should begin with three dashes and contain headers which provide information for Jekyll to populate the post with the appropriate page data. The date must be in the format specified. The hours, minutes, seconds, and timezone adjustment are optional:

{{< file "YYYY-MM-DD-example-post.md" yaml >}}
---
Expand All @@ -193,7 +193,7 @@ categories:
{{< /file >}}


5. Copy the contents of the markdown file exported from Jupyter into the new post.
5. Copy the contents of the Markdown file exported from Jupyter into the new post.

To do this from the command line, use:

Expand Down Expand Up @@ -253,11 +253,11 @@ margin-bottom: 0; }

### Add an Image in Jekyll

Adding an image through markdown requires having the images stored in the project directory.
Adding an image through Markdown requires having the images stored in the project directory.

1. Move all of the images exported from Jupyter into the `/assets/images` folder.

2. Modify the references to images within the markdown to the appropriate path. Wrap the path in two curly braces and double quotes.
2. Modify the references to images within the Markdown to the appropriate path. Wrap the path in two curly braces and double quotes.

{{< file "YYYY-MM-DD-example-post.md" >}}
![png]({{ "/assets/images/example_notebook_5_0.png" }})
Expand Down
6 changes: 3 additions & 3 deletions docs/linode-writers-formatting-guide/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ We only accept new guides and authors through our guide submission process. To a

## General Layout

Linode Guides & Tutorials are written in [Markdown](https://en.wikipedia.org/wiki/Markdown). Our documentation site uses [Hugo](https://gohugo.io), a static site generator. Hugo-specific markdown formatting notes are given [further below](#markdown-formatting).
Linode Guides & Tutorials are written in [Markdown](https://en.wikipedia.org/wiki/Markdown). Our documentation site uses [Hugo](https://gohugo.io), a static site generator. Hugo-specific Markdown formatting notes are given [further below](#markdown-formatting).

### Header

Expand Down Expand Up @@ -209,7 +209,7 @@ If you wish to provide links to external sites for the user to review after goin

### Extend Markdown Using Shortguides

Using shortcodes, it is possible to extend a markdown file with another. For common tasks such as basic software installation, consider using the `content` shortcode. This allows our library to maintain consistent and up to date installation instructions for frequently used tools such as Python, MySQL, and Docker.
Using shortcodes, it is possible to extend a Markdown file with another. For common tasks such as basic software installation, consider using the `content` shortcode. This allows our library to maintain consistent and up to date installation instructions for frequently used tools such as Python, MySQL, and Docker.

Markdown files intended to be inserted into multiple guides are called shortguides. To create a shortguide, create a directory with the name of your shortguide anywhere within `docs/`, and then create an index.md within the directory for your content (e.g. `example-shortguide-name/index.md`).

Expand Down Expand Up @@ -270,7 +270,7 @@ Adding `os: ["mac", "linux", "windows"]` to the front matter inserts a jQuery sc

The shortcode should contain two parameters: filepath and operating system.

For example, `{{</* content "how-to-install-git-mac" mac */>}}` will insert a markdown snippet that will only be visible when the Mac button is in the active state.
For example, `{{</* content "how-to-install-git-mac" mac */>}}` will insert a Markdown snippet that will only be visible when the Mac button is in the active state.

### Files and File Excerpts

Expand Down
5 changes: 5 additions & 0 deletions docs/platform/object-storage/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
description: 'Content storage and delivery for unstructured data. Great for multimedia, static sites, software delivery, archives, and data backups.'
title: 'Linode Object Storage'
show_in_lists: true
---
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading