You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This improves the existing doc "Using an External Type" to make it clearer what is internal vs external and how boilerplate files should be edited. This partially addresses #369.
Signed-off-by: Ryan Brainard <rbrainard@salesforce.com>
Copy file name to clipboardexpand all lines: docs/using_an_external_type.md
+34-25
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# Using an external Type
1
+
# Using an External Type
2
2
3
3
4
4
# Introduction
@@ -19,13 +19,15 @@ you will need to have several items of information.
19
19
20
20
The Domain and Group variables have been discussed in other parts of the documentation. The import path would be located in the project that installs the CR.
21
21
22
-
Example API Aggregation directory structure
22
+
This document uses `my` and `their` prefixes as a naming convention for repos, groups, and types to clearly distinguish between your own project and the external one you are referencing.
23
+
24
+
Example external API Aggregation directory structure
23
25
```
24
26
github.com
25
-
├── example
26
-
├── myproject
27
+
├── theiruser
28
+
├── theirproject
27
29
├── apis
28
-
├── mygroup
30
+
├── theirgroup
29
31
├── doc.go
30
32
├── install
31
33
│ ├── install.go
@@ -36,7 +38,7 @@ github.com
36
38
│ ├── zz_generated.deepcopy.go
37
39
```
38
40
39
-
In the case above the import path would be `github.com/example/myproject/apis/mygroup/v1alpha1`
41
+
In the case above the import path would be `github.com/theiruser/theirproject/apis/theirgroup/v1alpha1`
0 commit comments