Skip to content

Commit 19929ec

Browse files
committed
Add links to tutorial source to book
This adds to both tutorials' sources to the book, so that people can find the finished project more easily.
1 parent 863e785 commit 19929ec

File tree

3 files changed

+36
-1
lines changed

3 files changed

+36
-1
lines changed

docs/book/src/cronjob-tutorial/cronjob-tutorial.md

+17
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,23 @@ once, seeing them to completion.
1919
Instead of trying to tackle rewriting the Job controller as well, we'll
2020
use this as an opportunity to see how to interact with external types.
2121

22+
<aside class="note">
23+
24+
<h1>Following Along vs Jumping Ahead</h1>
25+
26+
Note that most of this tutorial is generated from literate Go files that
27+
live in the book source directory:
28+
[docs/book/src/cronjob-tutorial/testdata][tutorial-source]. The full,
29+
runnable project lives in [project][tutorial-project-source], while
30+
intermediate files live directly under the [testdata][tutorial-source]
31+
directory.
32+
33+
[tutorial-source]: https://github.com/kubernetes-sigs/kubebuilder/tree/master/docs/book/src/cronjob-tutorial/testdata
34+
35+
[tutorial-project-source]: https://github.com/kubernetes-sigs/kubebuilder/tree/master/docs/book/src/cronjob-tutorial/testdata/project
36+
37+
</aside>
38+
2239
## Scaffolding Out Our Project
2340

2441
As covered in the [quick start](../quick-start.md), we'll need to scaffold

docs/book/src/multiversion-tutorial/tutorial.md

+17-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,21 @@ different versions are supported by our CronJob project.
1111
If you haven't already, make sure you've gone through the base [CronJob
1212
Tutorial](/cronjob-tutorial/cronjob-tutorial.md).
1313

14-
## Aside: Kubernetes Versions
14+
<aside class="note">
15+
16+
<h1>Following Along vs Jumping Ahead</h1>
17+
18+
Note that most of this tutorial is generated from literate Go files that
19+
form a runnable project, and live in the book source directory:
20+
[docs/book/src/multiversion-tutorial/testdata/project][tutorial-source].
21+
22+
[tutorial-source]: https://github.com/kubernetes-sigs/kubebuilder/tree/master/docs/book/src/multiversion-tutorial/testdata/project
23+
24+
</aside>
25+
26+
<aside class="note warning">
27+
28+
<h1>Minimum Kubernetes Versions Incoming!</h1>
1529

1630
CRD conversion support was introduced as an alpha feature in Kubernetes
1731
1.13 (which means it's not on by default, and needs to be enabled via
@@ -23,6 +37,8 @@ If you're on Kubernetes 1.12 or below, you'll need a new cluster to use
2337
conversion. Check out the [KinD instructions](/reference/kind.md) for
2438
instructions on how to set up a all-in-one cluster.
2539

40+
</aside>
41+
2642
Next, let's figure out what changes we want to make...
2743

2844
[kube-feature-gates]: https://kubernetes.io/docs/reference/command-line-tools-reference/feature-gates/ "Kubernetes Feature Gates"

docs/book/theme/css/general.css

+2
Original file line numberDiff line numberDiff line change
@@ -402,6 +402,7 @@ main > details.collapse-code > summary::after {
402402
aside.note {
403403
border: 1px solid var(--searchbar-border-color);
404404
border-radius: 3px;
405+
margin-top: 1em;
405406
}
406407

407408
aside.note > * {
@@ -416,6 +417,7 @@ aside.note > h1 {
416417
padding: 0.5em 1em;
417418
font-size: 100%;
418419
font-weight: normal;
420+
background: var(--quote-bg);
419421
}
420422

421423
/* warning notes */

0 commit comments

Comments
 (0)