Added links to naming standards document

andre-senna · Nov 27, 2018 · dfabaa4 · dfabaa4
1 parent 170a715
commit dfabaa4
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 5 deletions.
diff --git a/guidelines/serviceIntegrationGuidelines.md b/guidelines/serviceIntegrationGuidelines.md
@@ -11,6 +11,7 @@
 [python-tutorial]: https://github.com/singnet/wiki/tree/master/tutorials/howToWritePythonService
 [opencog-tutorial]: https://github.com/singnet/wiki/tree/master/tutorials/howToWriteOpencogService
 [service-tutorial]: https://github.com/singnet/wiki/tree/master/tutorials/howToPublishService
+[naming-standards]: https://github.com/singnet/wiki/blob/master/doc/Naming-Standards.md
 [grpc]: https://grpc.io/
 [grpc-docs]: https://grpc.io/docs/
 [opencog]: https://opencog.org/
@@ -59,6 +60,8 @@ SingularityNET:
 
 - [How to publish a service][service-tutorial]
 
+Make sure you follow our [naming standardisation guidelines][naming-standards].
+
 ## <a name="frameworks"></a> AI frameworks
 
 There are a couple of AI frameworks integrated to SingularityNET so you

diff --git a/tutorials/howToPublishService/README.md b/tutorials/howToPublishService/README.md
@@ -1,3 +1,5 @@
+[naming-standards]: https://github.com/singnet/wiki/blob/master/doc/Naming-Standards.md
+
 # Tutorial - How to Publish a SingularityNET Service
 
 -------------------------------
@@ -61,7 +63,7 @@ Create an organization and add your key to it.
 # snet organization create ORGANIZATION_NAME
 ```
 
-Replace ORGANIZATION_NAME by a name of your choice.
+Replace ORGANIZATION_NAME by a name of your choice. Make sure you follow our [naming standardisation guidelines][naming-standards].
 
 If you want to join an existing organization (e.g. SNET), ask the owner to add your public key into it before proceeding.
 
@@ -75,7 +77,8 @@ In this tutorial we use a simple service implemented in [DNN Model Services](htt
 # git clone https://github.com/singnet/dnn-model-services.git
 # cd dnn-model-services/Services/gRPC/Basic_Template/service/
 ```
-To build the JSON configuration file, execute the following command and enter the requested information.
+To build the JSON configuration file, execute the following command and enter the requested information. Make sure you follow our [naming standardisation guidelines][naming-standards].
+
 
 ```
 # snet service metadata_init SERVICE_PROTOBUF_DIR SERVICE_DISPLAY_NAME PAYMENT_ADDRESS

diff --git a/tutorials/howToWriteOpencogService/README.md b/tutorials/howToWriteOpencogService/README.md
@@ -3,7 +3,7 @@
 [services-readme]: https://github.com/singnet/opencog-services/blob/master/README.md
 [contribution-guidelines]: https://github.com/singnet/wiki/blob/master/guidelines/CONTRIBUTING.md
 
-# Tutorial - How to write an Opencog service to SingularityNET
+# Tutorial - How to write an Opencog service for SingularityNET
 
 -------------------------------
 
@@ -158,8 +158,14 @@ load new modules, define several global variables or helper functions etc.
 The only requisite is that you nned to define a function with the exact name of the
 command expecting a list of arguments as the only parameter.
 
-**Important:** Anything the command send to `stdout` (e.g. by calling the 
-function `(display)`) will be considered as part of the output.
+**Important notes:** 
+
+- Anything the command send to `stdout` (e.g. by calling the function
+  `(display)`) will be considered as part of the output.
+- Any arguments starting with `http:` or `https:` **will not** be passed to
+  the command. The target file will be fetched instead (it's supposed to be in
+  [Atomese][atomese]) and fed into the AtomSpace. If you need to pass an URL to
+  the command, you can quote it or prefix it in some other way.
 
 So we're done with the Scheme command.