Skip to content
Open
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
10 changes: 5 additions & 5 deletions _gen/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,11 @@ For package management we'll use jsonnet-bundler, please
> don't know how Kubernetes works, this isn't a requirement for understanding the Jsonnet
> examples.

1. [Write an extensible library](lesson1.md)
1. [Understanding Package management](lesson2.md)
1. [Exercise: rewrite a library with `k8s-libsonnet`](lesson3.md)
1. [Further developing libraries](lesson4.md)
1. [Providing documentation with Docsonnet](lesson5.md)
1. [Introduction exercise](lesson1.md)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
1. [Introduction exercise](lesson1.md)
1. [Introductory exercise](lesson1.md)

1. [Package management](lesson2.md)
1. [Refactoring exercise](lesson3.md)
1. [Wrapping libraries](lesson4.md)
1. [Documentation](lesson5.md)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

make this Documenting instead of `Documentation. That will tell me it is about how I do something.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

or better: Documenting Code.

1. [Unit testing](lesson6.md)


4 changes: 2 additions & 2 deletions _gen/lesson1.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Write an extensible library
# Introduction exercise
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# Introduction exercise
# Introductory exercise


Jsonnet gives us a lot of freedom to organize our libraries, there is no right or
wrong, however a well-organized library can get you a long way. While applying common
software development best-practices, we'll come up with an extensible library to
software development best-practices, we'll come up with an *extensible library* to
deploy a webserver on Kubernetes.


Expand Down
2 changes: 1 addition & 1 deletion _gen/lesson2.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Understanding Package management
# Package management

There are a ton of Jsonnet libraries out there, ranging from big generated libraries
to manually curated for a very specific purpose. Let's have a look at how to find and
Expand Down
2 changes: 1 addition & 1 deletion _gen/lesson3.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Exercise: rewrite a library with `k8s-libsonnet`
# Refactoring exercise

In the first lesson we've written a extensible library and in the second lesson we've
covered package management with jsonnet-bundler. In this lesson we'll combine what
Expand Down
2 changes: 1 addition & 1 deletion _gen/lesson4.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Further developing libraries
# Wrapping libraries

When starting out with Jsonnet, it is very likely that you'll with existing code and
dependencies. Developing on these can seem confusing and tedious, however there are
Expand Down
2 changes: 1 addition & 1 deletion _gen/lesson5.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Providing documentation with Docsonnet
# Documentation
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# Documentation
# Documenting Code


[Docsonnet](https://github.com/jsonnet-libs/docsonnet) provides a way to consistently
add docstrings to Jsonnet code. As Docsonnet docstrings are written as Jsonnet
Expand Down
10 changes: 5 additions & 5 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,11 @@ <h2>Lessons</h2>
examples.</p>
</blockquote>
<ol>
<li><a href="lesson1.html">Write an extensible library</a></li>
<li><a href="lesson2.html">Understanding Package management</a></li>
<li><a href="lesson3.html">Exercise: rewrite a library with <code>k8s-libsonnet</code></a></li>
<li><a href="lesson4.html">Further developing libraries</a></li>
<li><a href="lesson5.html">Providing documentation with Docsonnet</a></li>
<li><a href="lesson1.html">Introduction exercise</a></li>
<li><a href="lesson2.html">Package management</a></li>
<li><a href="lesson3.html">Refactoring exercise</a></li>
<li><a href="lesson4.html">Wrapping libraries</a></li>
<li><a href="lesson5.html">Documentation</a></li>
<li><a href="lesson6.html">Unit testing</a></li>
</ol>
</main>
Expand Down
6 changes: 3 additions & 3 deletions docs/lesson1.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html>
<head>
<title>Write an extensible library - Jsonnet Training Course</title>
<title>Introduction exercise - Jsonnet Training Course</title>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="md2html">
Expand All @@ -15,10 +15,10 @@

<main>
<p><span class="nav index"><a href="index.html">index</a></span> <span class="nav next"><a href="lesson2.html">next »</a></span></p>
<h1>Write an extensible library</h1>
<h1>Introduction exercise</h1>
<p>Jsonnet gives us a lot of freedom to organize our libraries, there is no right or
wrong, however a well-organized library can get you a long way. While applying common
software development best-practices, we'll come up with an extensible library to
software development best-practices, we'll come up with an <em>extensible library</em> to
deploy a webserver on Kubernetes.</p>
<h2>Objectives</h2>
<ul>
Expand Down
4 changes: 2 additions & 2 deletions docs/lesson2.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html>
<head>
<title>Understanding Package management - Jsonnet Training Course</title>
<title>Package management - Jsonnet Training Course</title>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="md2html">
Expand All @@ -15,7 +15,7 @@

<main>
<p><span class="nav previous"><a href="lesson1.html">« previous</a></span> <span class="nav index"><a href="index.html">index</a></span> <span class="nav next"><a href="lesson3.html">next »</a></span></p>
<h1>Understanding Package management</h1>
<h1>Package management</h1>
<p>There are a ton of Jsonnet libraries out there, ranging from big generated libraries
to manually curated for a very specific purpose. Let's have a look at how to find and
vendor them.</p>
Expand Down
4 changes: 2 additions & 2 deletions docs/lesson3.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html>
<head>
<title>Exercise: rewrite a library with `k8s-libsonnet` - Jsonnet Training Course</title>
<title>Refactoring exercise - Jsonnet Training Course</title>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="md2html">
Expand All @@ -15,7 +15,7 @@

<main>
<p><span class="nav previous"><a href="lesson2.html">« previous</a></span> <span class="nav index"><a href="index.html">index</a></span> <span class="nav next"><a href="lesson4.html">next »</a></span></p>
<h1>Exercise: rewrite a library with <code>k8s-libsonnet</code></h1>
<h1>Refactoring exercise</h1>
<p>In the first lesson we've written a extensible library and in the second lesson we've
covered package management with jsonnet-bundler. In this lesson we'll combine what
we've learned and rewrite that library.</p>
Expand Down
4 changes: 2 additions & 2 deletions docs/lesson4.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html>
<head>
<title>Further developing libraries - Jsonnet Training Course</title>
<title>Wrapping libraries - Jsonnet Training Course</title>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="md2html">
Expand All @@ -15,7 +15,7 @@

<main>
<p><span class="nav previous"><a href="lesson3.html">« previous</a></span> <span class="nav index"><a href="index.html">index</a></span> <span class="nav next"><a href="lesson5.html">next »</a></span></p>
<h1>Further developing libraries</h1>
<h1>Wrapping libraries</h1>
<p>When starting out with Jsonnet, it is very likely that you'll with existing code and
dependencies. Developing on these can seem confusing and tedious, however there are
several techniques that can help us iterate at different velocities.</p>
Expand Down
4 changes: 2 additions & 2 deletions docs/lesson5.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<html>
<head>
<title>Providing documentation with Docsonnet - Jsonnet Training Course</title>
<title>Documentation - Jsonnet Training Course</title>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="md2html">
Expand All @@ -15,7 +15,7 @@

<main>
<p><span class="nav previous"><a href="lesson4.html">« previous</a></span> <span class="nav index"><a href="index.html">index</a></span> <span class="nav next"><a href="lesson6.html">next »</a></span></p>
<h1>Providing documentation with Docsonnet</h1>
<h1>Documentation</h1>
<p><a href="https://github.com/jsonnet-libs/docsonnet">Docsonnet</a> provides a way to consistently
add docstrings to Jsonnet code. As Docsonnet docstrings are written as Jsonnet
attributes, it can also natively render user-friendly documentation in Markdown.</p>
Expand Down
4 changes: 2 additions & 2 deletions lessons/lesson1/main.jsonnet
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ local examples = import './examples.jsonnet';

lesson.new(
'lesson1',
'Write an extensible library',
'Introduction exercise',
|||
Jsonnet gives us a lot of freedom to organize our libraries, there is no right or
wrong, however a well-organized library can get you a long way. While applying common
software development best-practices, we'll come up with an extensible library to
software development best-practices, we'll come up with an *extensible library* to
deploy a webserver on Kubernetes.
|||,
[
Expand Down
2 changes: 1 addition & 1 deletion lessons/lesson2/main.jsonnet
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ local examples = import './examples.jsonnet';

lesson.new(
'lesson2',
'Understanding Package management',
'Package management',
|||
There are a ton of Jsonnet libraries out there, ranging from big generated libraries
to manually curated for a very specific purpose. Let's have a look at how to find and
Expand Down
2 changes: 1 addition & 1 deletion lessons/lesson3/main.jsonnet
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ local examples = import './examples.jsonnet';

lesson.new(
'lesson3',
'Exercise: rewrite a library with `k8s-libsonnet`',
'Refactoring exercise',
|||
In the first lesson we've written a extensible library and in the second lesson we've
covered package management with jsonnet-bundler. In this lesson we'll combine what
Expand Down
2 changes: 1 addition & 1 deletion lessons/lesson4/main.jsonnet
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ local examples = import './examples.jsonnet';

lesson.new(
'lesson4',
'Further developing libraries',
'Wrapping libraries',
|||
When starting out with Jsonnet, it is very likely that you'll with existing code and
dependencies. Developing on these can seem confusing and tedious, however there are
Expand Down
2 changes: 1 addition & 1 deletion lessons/lesson5/main.jsonnet
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ local examples =

lesson.new(
'lesson5',
'Providing documentation with Docsonnet',
'Documentation',
|||
[Docsonnet](https://github.com/jsonnet-libs/docsonnet) provides a way to consistently
add docstrings to Jsonnet code. As Docsonnet docstrings are written as Jsonnet
Expand Down