From 5929b0ca1fd0d9dac66420f5ba81590437a5a5b9 Mon Sep 17 00:00:00 2001 From: Duologic Date: Thu, 29 Sep 2022 14:18:25 +0200 Subject: [PATCH 1/2] refactor: shorter titles --- _gen/index.md | 10 +++++----- _gen/lesson1.md | 4 ++-- _gen/lesson2.md | 2 +- _gen/lesson3.md | 2 +- _gen/lesson4.md | 2 +- _gen/lesson5.md | 2 +- docs/index.html | 10 +++++----- docs/lesson1.html | 6 +++--- docs/lesson2.html | 4 ++-- docs/lesson3.html | 4 ++-- docs/lesson4.html | 4 ++-- docs/lesson5.html | 4 ++-- lessons/lesson1/main.jsonnet | 4 ++-- lessons/lesson2/main.jsonnet | 2 +- lessons/lesson3/main.jsonnet | 2 +- lessons/lesson4/main.jsonnet | 2 +- lessons/lesson5/main.jsonnet | 2 +- 17 files changed, 33 insertions(+), 33 deletions(-) diff --git a/_gen/index.md b/_gen/index.md index 9dcc447..98b9761 100644 --- a/_gen/index.md +++ b/_gen/index.md @@ -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) +1. [Package management](lesson2.md) +1. [Refactoring Exercise](lesson3.md) +1. [Wrapping libraries](lesson4.md) +1. [Documentation](lesson5.md) 1. [Unit testing](lesson6.md) diff --git a/_gen/lesson1.md b/_gen/lesson1.md index e355a8e..7bedddc 100644 --- a/_gen/lesson1.md +++ b/_gen/lesson1.md @@ -1,8 +1,8 @@ -# 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. diff --git a/_gen/lesson2.md b/_gen/lesson2.md index 4bebbad..5de5cff 100644 --- a/_gen/lesson2.md +++ b/_gen/lesson2.md @@ -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 diff --git a/_gen/lesson3.md b/_gen/lesson3.md index d92052b..57e1bbd 100644 --- a/_gen/lesson3.md +++ b/_gen/lesson3.md @@ -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 diff --git a/_gen/lesson4.md b/_gen/lesson4.md index 3d39a24..a7d04ad 100644 --- a/_gen/lesson4.md +++ b/_gen/lesson4.md @@ -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 diff --git a/_gen/lesson5.md b/_gen/lesson5.md index bd062e6..9174bf4 100644 --- a/_gen/lesson5.md +++ b/_gen/lesson5.md @@ -1,4 +1,4 @@ -# 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 diff --git a/docs/index.html b/docs/index.html index bacb3f8..6a25ed5 100644 --- a/docs/index.html +++ b/docs/index.html @@ -40,11 +40,11 @@

Lessons

examples.

    -
  1. Write an extensible library
    2. -
  2. Understanding Package management
    3. -
  3. Exercise: rewrite a library with k8s-libsonnet
    4. -
  4. Further developing libraries
    5. -
  5. Providing documentation with Docsonnet
    6. +
  6. Introduction Exercise
    7. +
  7. Package management
    8. +
  8. Refactoring Exercise
    9. +
  9. Wrapping libraries
    10. +
  10. Documentation
  11. Unit testing
diff --git a/docs/lesson1.html b/docs/lesson1.html index 425267b..6254d4e 100644 --- a/docs/lesson1.html +++ b/docs/lesson1.html @@ -1,7 +1,7 @@ -Write an extensible library - Jsonnet Training Course +Introduction Exercise - Jsonnet Training Course @@ -15,10 +15,10 @@

index next »

-

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.

Objectives