Skip to content

Commit 634b1bb

Browse files
Merge pull request #125 from syedriko/readme_dev_fixes_20190409
#119
2 parents 038d5ed + 01dfc6f commit 634b1bb

File tree

2 files changed

+9
-14
lines changed

2 files changed

+9
-14
lines changed

README-DEV.adoc renamed to README-DEV.txt

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,11 @@ Modifying the tutorial
44
The tutorial is written in asciidoc and can be updated using any text editor.
55
You can preview changes as you make them as follows:
66

7-
1. Install the `antora` website generator and `gulp` build system
8-
+
9-
....
10-
npm install @antora/cli @antora/site-generator-default gulp@^3.9.1 gulp-connect yaml-js
11-
....
12-
13-
2. Create a `dev-site.yml` file (the `site.yml` file is for the public website)
14-
+
15-
.dev-site.yml
16-
....
7+
1. Install the `antora` website generator and the `gulp` build system
8+
$ npm install @antora/cli @antora/site-generator-default gulp@^3.9.1 gulp-connect yaml-js
9+
10+
2. Create a `dev-site.yml` file (the `site.yml` file is for the public website) with the following contents:
11+
1712
runtime:
1813
cache_dir: ./.cache/antora
1914

@@ -27,6 +22,7 @@ content:
2722
- url: .
2823
branches: HEAD
2924
start_path: documentation
25+
3026
asciidoc:
3127
attributes:
3228
tutorial-namespace: knativetutorial
@@ -41,8 +37,7 @@ ui:
4137

4238
output:
4339
dir: ./gh-pages
44-
....
4540

4641
3. Run `node_modules/.bin/gulp`
4742

48-
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.
43+
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.

documentation/modules/ROOT/pages/02-basic-fundas.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -257,7 +257,7 @@ Let us redeploy the greeter service by pinning it to the first revision that was
257257
[#run-pinned-revision]
258258
[source,bash,subs="+macros,+attributes"]
259259
----
260-
PIN_REVISION=`kubectl get rev -n knativetutorial -l serving.knative.dev/service=greeter -l serving.knative.dev/configurationGeneration=1 | awk 'NR==2{print $1}'` && \
260+
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}'` && \
261261
cat service-pinned.yaml | yq w - "spec.release.revisions[+]" $PIN_REVISION | kubectl -n {tutorial-namespace} apply -f -
262262
----
263263
copyToClipboard::run-pinned-revision[]
@@ -267,7 +267,7 @@ copyToClipboard::run-pinned-revision[]
267267
[#run-oc-pinned-revision]
268268
[source,bash,subs="+macros,+attributes"]
269269
----
270-
PIN_REVISION=`oc get rev -l serving.knative.dev/service=greeter -l serving.knative.dev/configurationGeneration=1 | awk 'NR==2{print $1}'` && \
270+
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}'` && \
271271
cat service-pinned.yaml | yq w - "spec.release.revisions[+]" $PIN_REVISION | oc -n {tutorial-namespace} apply -f -
272272
----
273273
copyToClipboard::run-oc-pinned-revision[]

0 commit comments

Comments
 (0)