Dataproc Metastore

Tutorial x

This text is in the overview block. It has no heading and appears directly after the page title. Use the overview block to provide a detailed overview of what the tutorial is about.

After the overview block, the following blocks appear in this order (note that the block name and actual header title may not be the same):

  • objectives, which has the title Objectives.
  • costs, which has the title Costs. Omitted in subsequent pages of multi-page tutorials.
  • prerequisites, which has the title Before you begin. Omitted in subsequent pages of multi-page tutorials.
  • lessoncontent, which has no title.
  • cleanup, which has the title Clean up. In a multi-page tutorial, include this block on the final page.
  • whatsnext, which has the title What's next. In a multi-page tutorial, include this block on the final page.

Here is the source for this page.

Here is the Django template. It extends this template.

Objectives

This is the objectives block. Help the reader understand what they'll learn. Omitted after first page of multi-page tutorials.

  • Learn how the tutorial template works.
  • See how the tutorial template renders on the staging site.

Costs

This is the costs block. It's required. If the tutorial incurs no costs, simply state that the tutorial is free to run and briefly explain why. Omitted after first page of multi-page tutorials.

This tutorial uses billable components of Google Cloud, including:

  • Compute Engine

Use the pricing calculator to generate a cost estimate based on your projected usage. New Google Cloud users might be eligible for a free trial.

Before you begin

This is the prerequisites block. Use it to tell the user what software to install or configure before they start the tutorial. Omitted after first page of multi-page tutorials.

  1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.
  2. In the Google Cloud Console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  3. Make sure that billing is enabled for your Cloud project. Learn how to confirm that billing is enabled for your project.

This is the lessoncontent block. It has no default heading, so write some:

Starting at H2

This is where you write your tutorial steps.

  1. Write headings as gerunds.
  2. Write your numbered steps using imperative mood.
  3. Remember to use additional headings.

Prepare the environment

If the reader has to clone a repository, run a script to initialize environment variables, select a region and zone, or perform another task to get ready for subsequent steps, include a Preparing your Google Cloud working environment section and include procedures for these tasks.

Using additional headings to segment the work

Introduce the steps, provide some information about what's going on.

  1. Do this.
  2. Now do that.

Use subheadings

If the steps get really long, say more than 5-7, consider breaking them up into subsections. Use imperative mood in lower-level headings.

Using the GitHub widget

The widget includes code from GitHub. It's the best way to show example code.

For example:

{% include "cloud/_docwidgets/_github_include.html" with project="python-docs-samples"  file="appengine/standard/flask/hello_world/main.py" region_tag="app" %}

Which would render as:

import logging

from flask import Flask


app = Flask(__name__)


@app.route('/')
def hello():
    return 'Hello World!'


@app.errorhandler(500)
def server_error(e):
    # Log the error and stacktrace.
    logging.exception('An error occurred during a request.')
    return 'An internal error occurred.', 500

Be sure to explain what the code is doing and why.

Cleaning up

To avoid incurring charges to your Google Cloud account for the resources used in this tutorial, either delete the project that contains the resources, or keep the project and delete the individual resources.

This is the cleanup block. It's required if there are costs associated with the tutorial. To hide the block, set the cleanup variable to empty at the top of this file and delete this entire section.

In a multi-page tutorial, include this block on the final page.

The cleanup block includes an introductory sentence by default. To hide the sentence, set the no_incurring_charges variable to 1 at the top of this file.

You can use the static includes, as shown here.

Note that if you use the overview variable, you must specify a string for the tutorial name in a parameter to the include directive:

{% include "_shared/_delete_tutorial_resources.html" with name="[YOUR_TUTORIAL_NAME]" %}

You should also set the no_incurring_charges variable to 1 in the header to avoid having two introductions.

Here is the text for the overview variable:

After you've finished the tutorial doc type template tutorial, you can clean up the resources that you created on Google Cloud so they won't take up quota and you won't be billed for them in the future. The following sections describe how to delete or turn off these resources.

Other variables show up in the following sections. The headings are not part of the variables.

Deleting the project

The easiest way to eliminate billing is to delete the project that you created for the tutorial.

To delete the project:

  1. In the Cloud Console, go to the Manage resources page.

    Go to Manage resources

  2. In the project list, select the project that you want to delete, and then click Delete.
  3. In the dialog, type the project ID, and then click Shut down to delete the project.

Deleting instances

To delete a Compute Engine instance:

  1. In the Cloud Console, go to the VM instances page.

    Go to VM instances

  2. Select the checkbox for the instance that you want to delete.
  3. To delete the instance, click More actions, click Delete, and then follow the instructions.

Deleting firewall rules for the default network

To delete a firewall rule:

  1. In the Cloud Console, go to the Firewall page.

    Go to Firewall

  2. Select the checkbox for the firewall rule that you want to delete.
  3. To delete the firewall rule, click Delete.

What's next

This is the whatsnext block. It's required and should have at least the link to the tutorial index page, as shown below. In a multi-page tutorial, show this block only on the last page. To hide it, set the whatsnext variable to empty at the top of this page.

  • Work through the tutorial.
  • Look through code samples.
  • Explore reference architectures, diagrams, tutorials, and best practices about Google Cloud. Take a look at our Cloud Architecture Center.