213 lines
8.7 KiB
HTML
213 lines
8.7 KiB
HTML
<!DOCTYPE html>
|
||
|
||
<html lang="en">
|
||
<head>
|
||
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||
|
||
<title>Create a new tutorial — SeisComP Release documentation</title>
|
||
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
|
||
<link rel="stylesheet" href="../../_static/seiscomp.css" type="text/css" />
|
||
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=72bcf2f2" />
|
||
<link rel="stylesheet" type="text/css" href="../../_static/seiscomp.css?v=c6da7ce6" />
|
||
<link rel="stylesheet" type="text/css" href="../../_static/graphviz.css?v=eafc0fe6" />
|
||
<script type="text/javascript" src="../../_static/seiscomp.js"></script>
|
||
<script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
|
||
<script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js?v=823bb831"></script>
|
||
<script src="../../_static/doctools.js?v=888ff710"></script>
|
||
<script src="../../_static/sphinx_highlight.js?v=4825356b"></script>
|
||
<link rel="index" title="Index" href="../../genindex.html" />
|
||
<link rel="search" title="Search" href="../../search.html" />
|
||
<link rel="next" title="Graphical User Interfaces" href="../../gui.html" />
|
||
<link rel="prev" title="Help! I’m stuck! Now what?" href="help.html" />
|
||
</head>
|
||
<body>
|
||
<div class="header">
|
||
<div class="container">
|
||
<div class="brand">
|
||
<img class="logo" src="../../_static/brands/seiscomp/text/white.svg"/>
|
||
<!-- span class="title">SeisComP Release</span -->
|
||
<span class="version">6.9.0</span>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="nav">
|
||
<div class="container">
|
||
<div class="content"><a class="pull-right" id="sidebar-toggle">TOC</a>
|
||
|
||
<div class="related" role="navigation" aria-label="related navigation">
|
||
<ul>
|
||
<li class="right">
|
||
<a href="../../genindex.html" title="General Index"
|
||
accesskey="I">
|
||
index
|
||
</a>
|
||
</li>
|
||
<li class="right">
|
||
<a href="../../gui.html" title="Graphical User Interfaces"
|
||
accesskey="N">
|
||
next
|
||
</a>
|
||
</li>
|
||
<li class="right">
|
||
<a href="help.html" title="Help! I’m stuck! Now what?"
|
||
accesskey="P">
|
||
previous
|
||
</a>
|
||
</li>
|
||
<li class="nav-item nav-item-0">
|
||
<a href="../../index.html">Home</a>
|
||
</li>
|
||
<li class="nav-item nav-item-1">
|
||
<a href="../tutorials.html" accesskey="U">Tutorials</a>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="container">
|
||
<div class="fitted content" id="anchors-container">
|
||
<div class="body" role="main">
|
||
|
||
<section id="create-a-new-tutorial">
|
||
<span id="tutorials-template"></span><h1>Create a new tutorial<a class="headerlink" href="#create-a-new-tutorial" title="Permalink to this heading">¶</a></h1>
|
||
<p>You will …</p>
|
||
<ul class="simple">
|
||
<li><p>Add something</p></li>
|
||
<li><p>Configure something else</p></li>
|
||
</ul>
|
||
<p>Pre-requisites for this tutorial:</p>
|
||
<ul class="simple">
|
||
<li><p>Have the source code of SeisComP available</p></li>
|
||
</ul>
|
||
<p>Afterwards/Results/Outcomes:</p>
|
||
<ul class="simple">
|
||
<li><p>A new tutorial</p></li>
|
||
</ul>
|
||
<p>Time range estimate:</p>
|
||
<ul class="simple">
|
||
<li><p>30 minutes</p></li>
|
||
</ul>
|
||
<hr class="docutils" />
|
||
<section id="set-up">
|
||
<h2>Set-up<a class="headerlink" href="#set-up" title="Permalink to this heading">¶</a></h2>
|
||
<p>To use this template, you’ll need to:</p>
|
||
<ol class="arabic simple">
|
||
<li><p>Get the source code of the SeisComP documentation, e.g. from
|
||
<span id="id1"><em>SeisComP on GitHub</em> [<a class="reference internal" href="../references.html#id258" title="Seiscomp on github. URL: https://github.com/SeisComP.">1</a>]</span></p></li>
|
||
<li><p>Copy this tutorial file (<code class="file docutils literal notranslate"><span class="pre">doc/base/tutorials/template.rst</span></code>) to the tutorials directory
|
||
with a new name, <code class="file docutils literal notranslate"><span class="pre">doc/base/tutorials/</span><em><span class="pre">nn</span></em><span class="pre">_</span><em><span class="pre">something</span></em><span class="pre">.rst</span></code>.</p></li>
|
||
<li><p>Change the reference at the top (first line); it must be
|
||
<em>.. _tutorials_{something}</em>.</p></li>
|
||
<li><p>Change the title: start with a verb, describe what the student is
|
||
trying to do.</p></li>
|
||
<li><p>Set the tutorial task and a final confirmation action for the student
|
||
to verify check that it worked correctly.</p></li>
|
||
<li><p>Add the file name without the ending <em>.rst</em> to the table of contents in <code class="file docutils literal notranslate"><span class="pre">doc/base/tutorials.rst</span></code>
|
||
assigning a position for your new tutorial within the sequence of
|
||
existing tutorials.</p></li>
|
||
<li><p>Build the HTML documentation for viewing and <a class="reference internal" href="#tutorials-template-testing"><span class="std std-ref">testing</span></a>.</p></li>
|
||
<li><p>Optionally, provide your new tutorial to the public repository:</p>
|
||
<ul class="simple">
|
||
<li><p>Create a new git branch</p></li>
|
||
<li><p>Push the new branch to GitHub</p></li>
|
||
<li><p>Create a merge request to get your branch merged into the master branch</p></li>
|
||
</ul>
|
||
</li>
|
||
</ol>
|
||
</section>
|
||
<section id="final-tests">
|
||
<span id="tutorials-template-testing"></span><h2>Final Tests<a class="headerlink" href="#final-tests" title="Permalink to this heading">¶</a></h2>
|
||
<ul>
|
||
<li><p>If you’ve applied this template,</p>
|
||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>ls<span class="w"> </span>doc/base/tutorials
|
||
</pre></div>
|
||
</div>
|
||
<p>will show your new tutorial.</p>
|
||
</li>
|
||
<li><p>Rebuild the documentation</p>
|
||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span><span class="nb">cd</span><span class="w"> </span>doc
|
||
$<span class="w"> </span>python3<span class="w"> </span>build-doc.py
|
||
</pre></div>
|
||
</div>
|
||
</li>
|
||
<li><p>View the new files in <cite>build-doc/base/html/tutorials</cite> using a web browser, e.g. firefox:</p>
|
||
<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>firefox<span class="w"> </span>build-doc/html/basetutorials.html
|
||
</pre></div>
|
||
</div>
|
||
</li>
|
||
</ul>
|
||
</section>
|
||
</section>
|
||
|
||
|
||
<div id="anchors-bottom"></div>
|
||
</div>
|
||
|
||
<div class="sidebar" role="navigation" aria-label="main navigation">
|
||
<div id="anchors-top"></div>
|
||
<div id="anchors" class="content">
|
||
<div id="searchbox" style="display: none" role="search">
|
||
<h3 id="searchlabel">Quick search</h3>
|
||
<div class="searchformwrapper">
|
||
<form class="search" action="../../search.html" method="get">
|
||
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
||
<input type="submit" value="Go" />
|
||
</form>
|
||
</div>
|
||
</div>
|
||
<script>document.getElementById('searchbox').style.display = "block"</script>
|
||
<div>
|
||
<h3><a href="../../index.html">Table of Contents</a></h3>
|
||
<ul>
|
||
<li><a class="reference internal" href="#">Create a new tutorial</a><ul>
|
||
<li><a class="reference internal" href="#set-up">Set-up</a></li>
|
||
<li><a class="reference internal" href="#final-tests">Final Tests</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
|
||
</div>
|
||
<div>
|
||
<h4>Previous topic</h4>
|
||
<p class="topless"><a href="help.html"
|
||
title="previous chapter">Help! I’m stuck! Now what?</a></p>
|
||
</div>
|
||
<div>
|
||
<h4>Next topic</h4>
|
||
<p class="topless"><a href="../../gui.html"
|
||
title="next chapter">Graphical User Interfaces</a></p>
|
||
</div>
|
||
<div role="note" aria-label="source link">
|
||
<h3>This Page</h3>
|
||
<ul class="this-page-menu">
|
||
<li><a href="../../_sources/base/tutorials/template.rst.txt"
|
||
rel="nofollow">Show Source</a></li>
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="footer">
|
||
<div class="container">
|
||
<div class="horizontal layout content">
|
||
<a class="fade-in" href="https://www.gempa.de" target="_blank">
|
||
<img class="brand" src="../../_static/brands/gempa.svg"/>
|
||
</a>
|
||
<div class="stretched align-center fitted content">
|
||
<div>
|
||
Version <b>6.9.0</b> Release
|
||
</div>
|
||
<div class="copyright">
|
||
Copyright © gempa GmbH, GFZ Potsdam.
|
||
</div>
|
||
</div>
|
||
<a class="fade-in" href="https://www.gfz-potsdam.de" target="_blank">
|
||
<img class="brand" src="../../_static/brands/gfz.svg"/>
|
||
</a>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</body>
|
||
</html> |