Skip to content

Commit e97fd38

Browse files
committed
Clarify links, add functions to catalog
1 parent 4be5d83 commit e97fd38

File tree

108 files changed

+763
-329
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

108 files changed

+763
-329
lines changed

Makefile

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,11 +74,15 @@ functions-examples-docker:
7474
docker build . -f functions/examples/Dockerfile -t gcr.io/kpt-dev/example-functions:v0.1.0
7575
docker push gcr.io/kpt-dev/example-functions:v0.1.0
7676

77+
gencatalog:
78+
rm site/content/en/guides/consumer/function/catalog/_index.md
79+
(cd site/content/en/guides/consumer/function/catalog/catalog && npm run gen-docs)
80+
7781
gendocs:
7882
rm -rf docs/
7983
(cd site && go run github.com/gohugoio/hugo)
8084

81-
docs: gendocs license
85+
docs: gencatalog gendocs license
8286

8387
servedocs:
8488
(cd site && go run github.com/gohugoio/hugo server)

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,12 +47,13 @@ chmod +x kpt
4747
GO111MODULE=on go get -v github.com/GoogleContainerTools/kpt
4848
```
4949

50-
### [Documentation](https://googlecontainertools.github.io/kpt)
50+
### [Documentation][docs]
5151

52-
See the [docs](https://googlecontainertools.github.io/kpt) for more information on how to use `kpt`.
52+
See the [docs] for more information on how to use `kpt`.
5353

5454
---
5555

5656
[linux]: https://storage.googleapis.com/kpt-dev/latest/linux_amd64/kpt
5757
[darwin]: https://storage.googleapis.com/kpt-dev/latest/darwin_amd64/kpt
5858
[windows]: https://storage.googleapis.com/kpt-dev/latest/windows_amd64/kpt.exe
59+
[docs]: https://googlecontainertools.github.io/kpt

docs/api-reference/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -301,7 +301,7 @@ <h5>
301301
<ul class="list-inline mb-0">
302302

303303
<li class="list-inline-item mx-2 h3" data-toggle="tooltip" data-placement="top" title="User mailing list" aria-label="User mailing list">
304-
<a class="text-white" target="_blank" href="https://groups.google.com/forum/#!forum/kpt-users">
304+
<a class="text-white" target="_blank" href="https://groups.google.com/g/kpt-users">
305305
<i class="fa fa-envelope"></i>
306306
</a>
307307
</li>

docs/api-reference/kptfile/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -320,7 +320,7 @@ <h1>Kptfile</h1>
320320
<ul class="list-inline mb-0">
321321

322322
<li class="list-inline-item mx-2 h3" data-toggle="tooltip" data-placement="top" title="User mailing list" aria-label="User mailing list">
323-
<a class="text-white" target="_blank" href="https://groups.google.com/forum/#!forum/kpt-users">
323+
<a class="text-white" target="_blank" href="https://groups.google.com/g/kpt-users">
324324
<i class="fa fa-envelope"></i>
325325
</a>
326326
</li>

docs/concepts/api-conventions/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -473,7 +473,7 @@ <h2 id="next-steps">Next Steps</h2>
473473
<ul class="list-inline mb-0">
474474

475475
<li class="list-inline-item mx-2 h3" data-toggle="tooltip" data-placement="top" title="User mailing list" aria-label="User mailing list">
476-
<a class="text-white" target="_blank" href="https://groups.google.com/forum/#!forum/kpt-users">
476+
<a class="text-white" target="_blank" href="https://groups.google.com/g/kpt-users">
477477
<i class="fa fa-envelope"></i>
478478
</a>
479479
</li>

docs/concepts/architecture/index.html

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -389,6 +389,9 @@ <h4 id="configuration-as-data">Configuration as data</h4>
389389
As configuration becomes complex, it becomes hard to read and understand.
390390
Our design philosophy is to keep configuration as data in order to manage this complexity.
391391
We do this by keeping resources serialized as either JSON or YAML configuration.</p>
392+
<ul>
393+
<li><a href="https://changelog.com/gotime/114#t=00:12:09.18">link</a></li>
394+
</ul>
392395
<h4 id="kpt-vs-kubernetes">kpt vs kubernetes:</h4>
393396
<ul>
394397
<li>While the Kubernetes control-plane reads / writes configuration data stored by the apiserver
@@ -585,7 +588,7 @@ <h3 id="targets">Targets</h3>
585588
<ul class="list-inline mb-0">
586589

587590
<li class="list-inline-item mx-2 h3" data-toggle="tooltip" data-placement="top" title="User mailing list" aria-label="User mailing list">
588-
<a class="text-white" target="_blank" href="https://groups.google.com/forum/#!forum/kpt-users">
591+
<a class="text-white" target="_blank" href="https://groups.google.com/g/kpt-users">
589592
<i class="fa fa-envelope"></i>
590593
</a>
591594
</li>

docs/concepts/functions/index.html

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -415,8 +415,9 @@ <h3 id="pipeline">Pipeline</h3>
415415

416416
<h2 id="next-steps">Next Steps</h2>
417417
<ul>
418+
<li>Get a quickstart on writing functions from the <a href="../../guides/producer/functions/">function producer docs</a>.</li>
418419
<li>See more examples of functions in the functions <a href="../../guides/consumer/function/catalog">catalog</a>.</li>
419-
<li>Consult the <a href="../../guides/producer/functions/">function producer docs</a> for more details on writing functions.</li>
420+
<li>Learn more ways of using the <code>kpt fn</code> command from the <a href="../../reference/fn/run/">reference</a> doc.</li>
420421
</ul>
421422

422423
<div class="section-index">
@@ -459,7 +460,7 @@ <h2 id="next-steps">Next Steps</h2>
459460
<ul class="list-inline mb-0">
460461

461462
<li class="list-inline-item mx-2 h3" data-toggle="tooltip" data-placement="top" title="User mailing list" aria-label="User mailing list">
462-
<a class="text-white" target="_blank" href="https://groups.google.com/forum/#!forum/kpt-users">
463+
<a class="text-white" target="_blank" href="https://groups.google.com/g/kpt-users">
463464
<i class="fa fa-envelope"></i>
464465
</a>
465466
</li>

docs/concepts/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -397,7 +397,7 @@ <h5>
397397
<ul class="list-inline mb-0">
398398

399399
<li class="list-inline-item mx-2 h3" data-toggle="tooltip" data-placement="top" title="User mailing list" aria-label="User mailing list">
400-
<a class="text-white" target="_blank" href="https://groups.google.com/forum/#!forum/kpt-users">
400+
<a class="text-white" target="_blank" href="https://groups.google.com/g/kpt-users">
401401
<i class="fa fa-envelope"></i>
402402
</a>
403403
</li>

docs/concepts/packaging/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -394,7 +394,7 @@ <h2 id="packaging">Packaging</h2>
394394
<ul class="list-inline mb-0">
395395

396396
<li class="list-inline-item mx-2 h3" data-toggle="tooltip" data-placement="top" title="User mailing list" aria-label="User mailing list">
397-
<a class="text-white" target="_blank" href="https://groups.google.com/forum/#!forum/kpt-users">
397+
<a class="text-white" target="_blank" href="https://groups.google.com/g/kpt-users">
398398
<i class="fa fa-envelope"></i>
399399
</a>
400400
</li>

docs/contact/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -237,7 +237,7 @@ <h1>Contact</h1>
237237
<p>We&rsquo;d love to hear from you!</p>
238238
<ul>
239239
<li>Join our <a href="https://kubernetes.slack.com/channels/kpt">Slack channel</a></li>
240-
<li>Join our <a href="https://groups.google.com/forum/#!forum/kpt-users">email list</a></li>
240+
<li>Join our <a href="https://groups.google.com/g/kpt-users">email list</a></li>
241241
</ul>
242242

243243
<div class="section-index">
@@ -272,7 +272,7 @@ <h1>Contact</h1>
272272
<ul class="list-inline mb-0">
273273

274274
<li class="list-inline-item mx-2 h3" data-toggle="tooltip" data-placement="top" title="User mailing list" aria-label="User mailing list">
275-
<a class="text-white" target="_blank" href="https://groups.google.com/forum/#!forum/kpt-users">
275+
<a class="text-white" target="_blank" href="https://groups.google.com/g/kpt-users">
276276
<i class="fa fa-envelope"></i>
277277
</a>
278278
</li>

0 commit comments

Comments
 (0)