Skip to content

Commit efe587b

Browse files
authored
Merge pull request #35 from negz/link-get
Link guide, package docs
2 parents c05a20b + 73cfd7d commit efe587b

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,15 @@ guidelines] as Crossplane.
1010

1111
To learn how to use this SDK:
1212

13+
* [Follow the guide to writing a composition function in Python][function guide]
1314
* [Learn about how composition functions work][functions]
14-
* [Learn about Python code generated from protocol buffers][python-protobuf]
15+
* [Read the package documentation][package docs]
1516

1617
The `RunFunctionRequest` and `RunFunctionResponse` types provided by this SDK
1718
are generated from a proto3 protocol buffer schema. Their fields behave
1819
similarly to built-in Python types like lists and dictionaries, but there are
19-
some differences. Read the generated code documentation to familiarize yourself
20-
with the the differences.
20+
some differences. Read the [generated code documentation][python-protobuf] to
21+
familiarize yourself with the the differences.
2122

2223
If you just want to jump in and get started, consider using the
2324
[function-template-python] template repository.
@@ -47,5 +48,7 @@ hatch build
4748
[functions]: https://docs.crossplane.io/latest/concepts/composition-functions
4849
[python-protobuf]: https://protobuf.dev/reference/python/python-generated/
4950
[function-template-python]: https://github.com/crossplane/function-template-python
51+
[function guide]: https://docs.crossplane.io/knowledge-base/guides/write-a-composition-function-in-python
52+
[package docs]: https://crossplane.github.io/function-sdk-python
5053
[contributing guidelines]: https://github.com/crossplane/crossplane/tree/master/contributing
5154
[hatch]: https://github.com/pypa/hatch

0 commit comments

Comments
 (0)