Cleaned up the readme file

Author: sachin-pikle

oci-list-compartments-python/README.md

@@ -2,7 +2,7 @@
 
 This function uses Resource Principals to securely authorize a function to make
 API calls to OCI services using the [OCI Python SDK](https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/index.html).
-It returns a list of all compartments within the tenancy regardless of region.
+It returns a list of all compartments within the tenancy.
 
 The function calls the following OCI Python SDK classes:
 * [Resource Principals Signer](https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/api/signing.html#resource-principals-signer) to authenticate
@@ -13,74 +13,41 @@ Whenever you see it, it's time for you to perform an action.
 
 
 ## Prerequisites
-1. Start by making sure all of your policies are correct from this [guide](https://docs.cloud.oracle.com/iaas/Content/Functions/Tasks/functionscreatingpolicies.htm?tocpath=Services%7CFunctions%7CPreparing%20for%20Oracle%20Functions%7CConfiguring%20Your%20Tenancy%20for%20Function%20Development%7C_____4)
 
-2. Have [Fn CLI setup with Oracle Functions](https://docs.cloud.oracle.com/iaas/Content/Functions/Tasks/functionsconfiguringclient.htm?tocpath=Services%7CFunctions%7CPreparing%20for%20Oracle%20Functions%7CConfiguring%20Your%20Client%20Environment%20for%20Function%20Development%7C_____0)
+Before you deploy this sample function, make sure you have run steps A, B 
+and C of the [Oracle Functions Quick Start Guide for Cloud Shell](https://www.oracle.com/webfolder/technetwork/tutorials/infographics/oci_faas_gettingstarted_quickview/functions_quickview_top/functions_quickview/index.html)
+* A - Set up your tenancy
+* B - Create application
+* C - Set up your Cloud Shell dev environment
 
 
-## Context
-Switch to the correct context
+## List Applications 
+
+Assuming you have successfully completed the prerequisites, you should see your 
+application in the list of applications.
 
-![user input icon](../images/userinput.png)
-```
-fn use context <your context name>
-```
-Check using
 ```
 fn ls apps
 ```
 
 
 ## Create or Update your Dynamic Group
-In order to use and retrieve information about other OCI Services, your function
-must be part of a dynamic group. For information on how to create a dynamic group,
-click [here](https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingdynamicgroups.htm#To).
 
-![user input icon](../images/userinput.png)
+In order to use other OCI Services, your function must be part of a dynamic 
+group. For information on how to create a dynamic group, refer to the 
+[documentation](https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingdynamicgroups.htm#To).
 
-When specifying the *Matching Rules*, consider the following examples:
-* If you want all functions in a compartment to be able to access a resource,
-enter a rule similar to the following that adds all functions in the compartment
-with the specified compartment OCID to the dynamic group:
+When specifying the *Matching Rules*, we suggest matching all functions in a compartment with:
 ```
-ALL {resource.type = 'fnfunc', resource.compartment.id = 'ocid1.compartment.oc1..aaaaaaaa23______smwa'}
-```
-* If you want a specific function to be able to access a resource, enter a rule
-similar to the following that adds the function with the specified OCID to the
-dynamic group:
-```
-resource.id = 'ocid1.fnfunc.oc1.iad.aaaaaaaaacq______dnya'
-```
-* If you want all functions with a specific defined tag (free-form tags are
-not supported) to be able to access a resource, enter a rule similar to the
-following that adds all functions with the defined tag to the dynamic group :
-```
-ALL {resource.type = 'fnfunc', tag.department.operations.value = '45'}
+ALL {resource.type = 'fnfunc', resource.compartment.id = 'ocid1.compartment.oc1..aaaaaxxxxx'}
 ```
 
 
 ## Create or Update Policies
 This function does not require any particular IAM policy.
 
 
-## Create an Application to run your function
-You can use an application already created or create a new one as follow:
-![user input icon](../images/userinput.png)
-```
-fn create app <app-name> --annotation oracle.com/oci/subnetIds='["<subnet-ocid>"]'
-```
-You can find the subnet-ocid by logging on to [cloud.oracle.com](https://cloud.oracle.com/en_US/sign-in),
-navigating to Core Infrastructure > Networking > Virtual Cloud Networks. Make
-sure you are in the correct Region and Compartment, click on your VCN and
-select the subnet you wish to use.
-
-e.g.
-```
-fn create app myapp --annotation oracle.com/oci/subnetIds='["ocid1.subnet.oc1.phx.aaaaaaaacnh..."]'
-```
-
-
-## Review and customize your function
+## Review and customize the function
 Review the following files in the current folder:
 - [requirements.txt](./requirements.txt) which specifies all the dependencies for your function
 - [func.yaml](./func.yaml) which contains metadata about your function and declares properties
@@ -90,9 +57,14 @@ The name of your function *oci-list-compartments-python* is specified in [func.y
 
 
 ## Deploy the function
+
+In Cloud Shell, run the *fn deploy* command to build the function and its dependencies as a Docker image, 
+push the image to the specified Docker registry, and deploy the function to Oracle Functions 
+in the application created earlier:
+
 ![user input icon](../images/userinput.png)
 ```
-fn -v deploy --app <your app name>
+fn -v deploy --app <app-name>
 ```
 e.g.
 ```
@@ -103,10 +75,10 @@ fn -v deploy --app myapp
 ## Invoke the function
 ![user input icon](../images/userinput.png)
 ```
-fn invoke <your app name> <your function name>
+fn invoke <app-name> <function-name>
 ```
 e.g.
 ```
 fn invoke myapp oci-list-compartments-python
 ```
-Upon success, you should see all of the compartments in your tenancy appear in your terminal.
+You should see all the compartments in your tenancy listed in the terminal.

oci-objectstorage-get-object-java/README.md

@@ -13,7 +13,6 @@ Whenever you see it, it's time for you to perform an action.
 
 
 ## Prerequisites
-![user input icon](./images/userinput.png)
 
 1. Before you deploy this sample function, make sure you have run steps A, B 
 and C of the [Oracle Functions Quick Start Guide for Cloud Shell](https://www.oracle.com/webfolder/technetwork/tutorials/infographics/oci_functions_cloudshell_quickview/functions_quickview_top/functions_quickview/index.html)
@@ -28,9 +27,8 @@ is shown there.
 
 
 ## List Applications 
-![user input icon](../images/userinput.png)
 
-Assuming your have successfully completed the prerequisites, you should see your 
+Assuming you have successfully completed the prerequisites, you should see your 
 application in the list of applications.
 
 ```
@@ -39,41 +37,35 @@ fn ls apps
 
 
 ## Create or Update your Dynamic Group
-In order to use and retrieve information about other OCI Services, your function
-must be part of a dynamic group. For information on how to create a dynamic group,
-click [here](https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingdynamicgroups.htm#To).
-
-![user input icon](../images/userinput.png)
+In order to use other OCI Services, your function must be part of a dynamic 
+group. For information on how to create a dynamic group, refer to the 
+[documentation](https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingdynamicgroups.htm#To).
 
-When specifying the *Matching Rules*, consider the following example:
-* If you want all functions in a compartment to be able to access a resource,
-enter a rule similar to the following that adds all functions in the compartment
-with the specified compartment OCID to the dynamic group:
+When specifying the *Matching Rules*, we suggest matching all functions in a compartment with:
 ```
-ALL {resource.type = 'fnfunc', resource.compartment.id = 'ocid1.compartment.oc1..aaaaaaaa23______smwa'}
+ALL {resource.type = 'fnfunc', resource.compartment.id = 'ocid1.compartment.oc1..aaaaaxxxxx'}
 ```
 
 
 ## Create or Update Policies
-Now that your dynamic group is created, create a new policy that allows the
-dynamic group to read any resources you are interested in receiving
-information about, in this case we will grant access to `object-family` in
+Create a new policy that allows the dynamic group to read `object-family` in
 the functions related compartment.
 
 ![user input icon](../images/userinput.png)
 
 Your policy should look something like this:
 ```
-Allow dynamic-group <your dynamic group name> to read object-family in compartment <your compartment name>
+Allow dynamic-group <dynamic-group-name> to read object-family in compartment <compartment-name>
 ```
 e.g.
 ```
 Allow dynamic-group demo-func-dyn-group to read object-family in compartment demo-func-compartment
 ```
-For more information on how to create policies, go [here](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/policysyntax.htm).
+For more information on how to create policies, check the 
+[documentation](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/policysyntax.htm).
 
 
-## Review the function
+## Review and customize the function
 Review the following files in the current folder:
 - [pom.xml](./pom.xml) specifies all the dependencies for your function
 - [func.yaml](./func.yaml) that contains metadata about your function and declares properties
@@ -83,15 +75,15 @@ The name of your function *oci-objectstorage-get-object-java* is specified in [f
 
 
 ## Deploy the function
+
+In Cloud Shell, run the *fn deploy* command to build the function and its dependencies as a Docker image, 
+push the image to the specified Docker registry, and deploy the function to Oracle Functions 
+in the application created earlier:
+
 ![user input icon](../images/userinput.png)
 
-From the current folder, run the following command:
-```
-fn -v deploy --app <your app name>
-```
-e.g.
 ```
-fn -v deploy --app object-crud
+fn -v deploy --app <app-name>
 ```
 
 
@@ -100,33 +92,29 @@ The function requires the config value *NAMESPACE* to be set.
 
 ![user input icon](../images/userinput.png)
 
-Use the *fn* CLI to set the config value:
-```
-fn config function <your app name> <function name> NAMESPACE <your namespace>
-```
-e.g.
-```
-fn config function object-crud get-object NAMESPACE mytenancy
-```
-Note that the config value can also be set at the application level:
+Use the *fn* CLI to set the config value at the application level (if multiple 
+functions need the same config value):
+
 ```
-fn config app <your app name> NAMESPACE <your namespace>
+fn config app <app-name> NAMESPACE <object-storage-namespace>
 ```
 e.g.
 ```
-fn config app object-crud NAMESPACE mytenancy
+fn config app myapp NAMESPACE mynamespace
 ```
 
+Note that the config value can also be set at the function level.
+
 
-## Invoke the function
-Use the *fn* CLI to invoke your function with your own object name, bucket name and app name:
+## Test
+Use the *fn* CLI to test your function with your own object name, bucket name and app name:
 
 ![user input icon](../images/userinput.png)
 ```
-echo -n '{"name": "<object_name>", "bucketName":"<bucket_name>"}' | fn invoke <app_name> <function_name>
+echo -n '{"name": "<object-name>", "bucketName":"<bucket-name>"}' | fn invoke <app-name> <function-name>
 ```
 e.g.
 ```
 echo -n '{"name": "file1.txt", "bucketName":"mybucket"}' | fn invoke object-crud oci-objectstorage-get-object-java
 ```
-Upon success, you should see the content of the object appear in your terminal.
+You should see the contents of the object appear in the terminal.