[GitHub] JaredTan95 commented on a change in pull request #2015: OAL tool module established

[GitBox <gi...@apache.org>]

JaredTan95 commented on a change in pull request #2015: OAL tool module established
URL: https://github.com/apache/incubator-skywalking/pull/2015#discussion_r239491160
 
 

 ##########
 File path: docs/en/guides/write-oal.md
 ##########
 @@ -0,0 +1,15 @@
+# Write OAL script
+Read [OAL overview](../concepts-and-designs/oal.md) to understand the oal script.
+
+## Find oal script in source codes
+The official official_analysis.oal is [here](../../../oap-server/generated-analysis/src/main/resources/official_analysis.oal).
+
+## Generate tool
+The `oap-server/generate-tool` module includes the source codes of compiling tool. This tool is already integrated
+maven compile phase. So, unless you want to change the tool source codes, you don't need to set anything.
+
+Run `./mvnw compile` or `./mvnw package`, the generated codes of the oal script are in `oap-server/generate-tool/target/generated-sources/oal/*`.
+
+## Write and recompile
+You could change the `official_analysis.oal` script, then recompile codes.
 
 Review comment:
   How about adding the same `we only recommend you to do this when you plan to build your own UI based on the customization analysis core.`  thing here? :-D

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services