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
docs: fix stale core/ directory paths in contribution docs (#6111)
### What changes were proposed in this PR?
Docs still referenced the pre-ASF `core/` source tree. This PR updates
every such path to the current layout:
| Stale | Current |
| --- | --- |
| `core/workflow-operator/.../edu/uci/ics/amber/operator` |
`common/workflow-operator/.../org/apache/texera/amber/operator` |
| `core/gui`, `/core/new-gui` (operator images) |
`frontend/src/assets/operator_images` |
| `cd core` / `cd core/gui` (test instructions) | repo root / `cd
frontend` |
| `config/src/main/resources/...` |
`common/config/src/main/resources/...` |
| `core/amber/.../generator_operator.py` (renamed) |
`amber/.../generator_operator_integer.py` |
Also removes `docs/contribution-guidelines/micro-services-local-dev.md`:
it documents the now-finished `core/micro-services` migration and build
scripts that no longer exist; local development is covered by the
developer guide and `bin/local-dev.sh`. No other doc links to that page.
### Any related issues, documentation, discussions?
Closes#6105
### How was this PR tested?
Docs-only change. Every new path/link target was verified to exist in
the repo:
```
ls common/workflow-operator/src/main/scala/org/apache/texera/amber/operator/{regex,huggingFace,map,filter,flatmap,aggregate}
ls frontend/src/assets/operator_images
ls amber/src/main/python/pytexera/udf/examples/generator_operator_integer.py
grep -rn "core/" docs/contribution-guidelines docs/tutorials # no stale hits remain
```
### Was this PR authored or co-authored using generative AI tooling?
Generated-by: Claude Code (Claude Fable 5)
(backported from commit 6829fae)
Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: docs/contribution-guidelines/guide-for-developers.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -263,7 +263,7 @@ This command will optimize the frontend code to make it run faster. This step wi
263
263
## 3. Email Notification (Optional)
264
264
</summary>
265
265
266
-
1. Set `smtp` in `config/src/main/resources/user-system.conf`. You need an App password if the account has 2FA.
266
+
1. Set `smtp` in `common/config/src/main/resources/user-system.conf`. You need an App password if the account has 2FA.
267
267
2. Log in to Texera with an admin account.
268
268
3. Open the Gmail dashboard under the admin tab.
269
269
5. Send a test email.
@@ -286,10 +286,10 @@ This part is optional; you only need to do this if you are working on a specific
286
286
Note: Jooq creates DAO for simple operations if the requested SQL query is complex, then the developer can use the generated Table classes to implement the operation
287
287
288
288
### Disable password login
289
-
Edit `config/src/main/resources/gui.conf`, change `local-login` to `false`.
289
+
Edit `common/config/src/main/resources/gui.conf`, change `local-login` to `false`.
290
290
291
291
### Enforce invite only
292
-
Edit `config/src/main/resources/user-system.conf`, change `invite-only` to `true`.
292
+
Edit `common/config/src/main/resources/user-system.conf`, change `invite-only` to `true`.
293
293
294
294
### Backend endpoints Role Annotation
295
295
There are two types of permissions for the backend endpoints:
Copy file name to clipboardExpand all lines: docs/contribution-guidelines/guide-to-implement-java-operator.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ In this page, we'll explain the basic concepts in Texera and use examples to sho
8
8
9
9
### Code structure of every operator:
10
10
11
-
Every operator ideally has three classes that are found in each operator package in `core\workflow-operator\src\main\scala\edu\uci\ics\amber\operator`
11
+
Every operator ideally has three classes that are found in each operator package in `common/workflow-operator/src/main/scala/org/apache/texera/amber/operator`
A regular expression operator matches a regular expression (regex) on each input tuple. For example, if we search the regex "weather" on the `tweet` attribute, then only tuple 2 will be the result. In other words, the regular expression operator is a kind of `filter()` operation in many programming languages.
51
51
52
-
To implement a regular expression operator, you will first need to write an `LogicalOp`. The following code is part of class [`RegexOpDesc`](https://github.com/apache/texera/blob/main/core/workflow-operator/src/main/scala/edu/uci/ics/amber/operator/regex/RegexOpDesc.scala) .
52
+
To implement a regular expression operator, you will first need to write an `LogicalOp`. The following code is part of class [`RegexOpDesc`](https://github.com/apache/texera/blob/main/common/workflow-operator/src/main/scala/org/apache/texera/amber/operator/regex/RegexOpDesc.scala) .
53
53
54
54
```scala
55
55
classRegexOpDescextendsFilterOpDesc {
@@ -127,7 +127,7 @@ abstract class LogicalOp extends PortDescriptor with Serializable {
127
127
128
128
Now this operator will be automatically available in the frontend. We can now start the system and test this operator.
129
129
130
-
To add an image for this operator, go to `core/gui/src/assets/operator_images`, then add an image with the _**SAME NAME**_ as what's specified in the operator registration. The image file should be in `png` format, with a transparent background, black and white, and should be square.
130
+
To add an image for this operator, go to `frontend/src/assets/operator_images`, then add an image with the _**SAME NAME**_ as what's specified in the operator registration. The image file should be in `png` format, with a transparent background, black and white, and should be square.
131
131
132
132
For example, for the regex operator, the code `new Type(value = classOf[RegexOpDesc], name = "Regex")` specified a name `Regex`, then the image file name should be `Regex.png`.
133
133
@@ -146,7 +146,7 @@ id tweet sentiment
146
146
```
147
147
148
148
149
-
The following code is the implementation of class [`SentimentAnalysisOpDesc`](https://github.com/apache/texera/blob/main/core/workflow-operator/src/main/scala/edu/uci/ics/amber/operator/huggingFace/HuggingFaceSentimentAnalysisOpDesc.scala) in Java.
149
+
The following code is the implementation of class [`SentimentAnalysisOpDesc`](https://github.com/apache/texera/blob/main/common/workflow-operator/src/main/scala/org/apache/texera/amber/operator/huggingFace/HuggingFaceSentimentAnalysisOpDesc.scala) in Java.
@@ -202,7 +202,7 @@ In Texera, currently we have 4 pre-defined operations you can extend.
202
202
-`flatmap()`: for each input tuple, transforms it to a list of output tuples.
203
203
-`aggregate()`: performs an aggregation, such as sum, count, average, etc.
204
204
205
-
To implement an operator, you can first check if your operator can be implemented using the 4 pre-defined operations. You can find these pre-defined operations under [`texera/workflow/common/operators`](https://github.com/Texera/texera/tree/master/core/amber/src/main/scala/edu/uci/ics/texera/workflow/common/operators). Your own operator implementation should be in [`texera/workflow/operators/youroperator`](https://github.com/Texera/texera/tree/master/core/amber/src/main/scala/edu/uci/ics/texera/workflow/operators).
205
+
To implement an operator, you can first check if your operator can be implemented using the 4 pre-defined operations. You can find these pre-defined operations under [`common/workflow-operator`](https://github.com/apache/texera/tree/main/common/workflow-operator/src/main/scala/org/apache/texera/amber/operator) (e.g., the `map`, `filter`, `flatmap`, and `aggregate` packages). Your own operator implementation should be in its own package under [the same directory](https://github.com/apache/texera/tree/main/common/workflow-operator/src/main/scala/org/apache/texera/amber/operator).
206
206
207
207
### Low-level OperatorExecutor API
208
208
For more complicated operators, if they cannot be implemented using these operations, then you need to implement `OperatorExecutor` using the following low-level interface.
@@ -278,6 +278,6 @@ Texera's backend is responsible for determining the UI information to the fronte
278
278
```
279
279
280
280
### Registration and icon
281
-
In the file`amber/src/main/scala/edu/uci/ics/texera/workflow/common/operators/LogicalOp.scala`, you will find a list of all registered operators, complete with their descriptor classes and names. After adding an operator's information, you can assign an icon to it. All operator icons are stored in the `/core/new-gui/src/assets/operator_images` directory. It's essential to ensure that the icon filename matches its respective operator descriptor name.
281
+
In the file`common/workflow-operator/src/main/scala/org/apache/texera/amber/operator/LogicalOp.scala`, you will find a list of all registered operators, complete with their descriptor classes and names. After adding an operator's information, you can assign an icon to it. All operator icons are stored in the `frontend/src/assets/operator_images` directory. It's essential to ensure that the icon filename matches its respective operator descriptor name.
Copy file name to clipboardExpand all lines: docs/tutorials/guide-to-use-python-udf.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -137,7 +137,7 @@ class GenerateOperator(UDFSourceOperator):
137
137
138
138
This `produce()` API returns an iterator of `TupleLike`, `TableLike`, or simply `None`.
139
139
140
-
See [Generator Operator](https://github.com/Texera/texera/blob/master/core/amber/src/main/python/pytexera/udf/examples/generator_operator.py) for an example of 1-out UDF.
140
+
See [Generator Operator](https://github.com/apache/texera/blob/main/amber/src/main/python/pytexera/udf/examples/generator_operator_integer.py) for an example of 1-out UDF.
0 commit comments