Skip to content
Merged
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
19 changes: 7 additions & 12 deletions README-DEV.adoc → README-DEV.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,11 @@ Modifying the tutorial
The tutorial is written in asciidoc and can be updated using any text editor.
You can preview changes as you make them as follows:

1. Install the `antora` website generator and `gulp` build system
+
....
npm install @antora/cli @antora/site-generator-default gulp@^3.9.1 gulp-connect yaml-js
....

2. Create a `dev-site.yml` file (the `site.yml` file is for the public website)
+
.dev-site.yml
....
1. Install the `antora` website generator and the `gulp` build system
$ npm install @antora/cli @antora/site-generator-default gulp@^3.9.1 gulp-connect yaml-js

2. Create a `dev-site.yml` file (the `site.yml` file is for the public website) with the following contents:

runtime:
cache_dir: ./.cache/antora

Expand All @@ -27,6 +22,7 @@ content:
- url: .
branches: HEAD
start_path: documentation

asciidoc:
attributes:
tutorial-namespace: knativetutorial
Expand All @@ -41,8 +37,7 @@ ui:

output:
dir: ./gh-pages
....

3. Run `node_modules/.bin/gulp`

This will generate HTML, start a local web server at `localhost:5373`, open the server index in a browser, and automatically update the HTML when the asciidoc source changes.
This will generate HTML, start a local web server at `localhost:5373`, which you can open in your browser, and automatically update the HTML when the asciidoc source changes. If you are not seeing your source changes reflected in the browser, try cleaning browser cache.
4 changes: 2 additions & 2 deletions documentation/modules/ROOT/pages/02-basic-fundas.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -257,7 +257,7 @@ Let us redeploy the greeter service by pinning it to the first revision that was
[#run-pinned-revision]
[source,bash,subs="+macros,+attributes"]
----
PIN_REVISION=`kubectl get rev -n knativetutorial -l serving.knative.dev/service=greeter -l serving.knative.dev/configurationGeneration=1 | awk 'NR==2{print $1}'` && \
PIN_REVISION=`kubectl get rev -n {tutorial-namespace} -l serving.knative.dev/service=greeter -l serving.knative.dev/configurationGeneration=1 | awk 'NR==2{print $1}'` && \
cat service-pinned.yaml | yq w - "spec.release.revisions[+]" $PIN_REVISION | kubectl -n {tutorial-namespace} apply -f -
----
copyToClipboard::run-pinned-revision[]
Expand All @@ -267,7 +267,7 @@ copyToClipboard::run-pinned-revision[]
[#run-oc-pinned-revision]
[source,bash,subs="+macros,+attributes"]
----
PIN_REVISION=`oc get rev -l serving.knative.dev/service=greeter -l serving.knative.dev/configurationGeneration=1 | awk 'NR==2{print $1}'` && \
PIN_REVISION=`oc get rev -n {tutorial-namespace} -l serving.knative.dev/service=greeter -l serving.knative.dev/configurationGeneration=1 | awk 'NR==2{print $1}'` && \
cat service-pinned.yaml | yq w - "spec.release.revisions[+]" $PIN_REVISION | oc -n {tutorial-namespace} apply -f -
----
copyToClipboard::run-oc-pinned-revision[]
Expand Down