Creating README.md file in $HOME for s3 storage projects (#761)

Co-authored-by: Tejas Kashinath <[email protected]>

Author: tejaskash

template/v2/dirs/etc/sagemaker-ui/project-storage/README.md

@@ -0,0 +1,24 @@
+## SageMaker Unified Studio Space
+
+Welcome to your project space
+This is the root folder for your project files. It contains:
+- A shared folder for collaborative work
+- Your personal local folder for private development
+
+### Personal local folder
+Your personal local folder:
+- Includes this root folder and any subfolders (except shared)
+- Allows you to work on files privately
+- Ideal for frequent file access and modification
+- Is visible only in this space
+
+### Shared folder
+The shared folder:
+- Contains files visible to all project members
+- Is accessible across all your tools
+- Updates immediately when any member adds or modifies files
+- Not well-suited for heavy file read/write workloads due to remote Amazon S3 origin of this folder and potential additional costs associated with frequent Amazon S3 access
+- If two individuals are modifying the same file in this folder at the same time that might result in losing some changes
+
+
+To share your files with other project members, copy or move them to the shared folder when ready.

template/v2/dirs/etc/sagemaker-ui/project-storage/create-storage-readme.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+
+if [ ! -f "$HOME/README.md" ]; then
+  echo "README file not found in $HOME, creating"
+
+  cat /etc/sagemaker-ui/project-storage/README.md > "$HOME/README.md"
+else
+  echo "README already exists, skipping"
+fi
+

template/v2/dirs/etc/sagemaker-ui/sagemaker_ui_post_startup.sh

@@ -195,7 +195,8 @@ if [ $is_s3_storage_flag -ne 0 ]; then
   git config --global user.email "$email"
   git config --global user.name "$username"
 else
-  echo "Project is using Non-Git storage, skipping git repository setup and ~/src dir creation"
+  echo "Project is using Non-Git storage, skipping git repository setup and ~/src dir creation and creating README"
+  bash /etc/sagemaker-ui/project-storage/create-storage-readme.sh
 fi
 
 # MLFlow tracking server uses the LOGNAME environment variable to track identity. Set the LOGNAME to the username of the user associated with the space

template/v3/dirs/etc/sagemaker-ui/project-storage/README.md

@@ -0,0 +1,24 @@
+## SageMaker Unified Studio Space
+
+Welcome to your project space
+This is the root folder for your project files. It contains:
+- A shared folder for collaborative work
+- Your personal local folder for private development
+
+### Personal local folder
+Your personal local folder:
+- Includes this root folder and any subfolders (except shared)
+- Allows you to work on files privately
+- Ideal for frequent file access and modification
+- Is visible only in this space
+
+### Shared folder
+The shared folder:
+- Contains files visible to all project members
+- Is accessible across all your tools
+- Updates immediately when any member adds or modifies files
+- Not well-suited for heavy file read/write workloads due to remote Amazon S3 origin of this folder and potential additional costs associated with frequent Amazon S3 access
+- If two individuals are modifying the same file in this folder at the same time that might result in losing some changes
+
+
+To share your files with other project members, copy or move them to the shared folder when ready.

template/v3/dirs/etc/sagemaker-ui/project-storage/create-storage-readme.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+
+if [ ! -f "$HOME/README.md" ]; then
+  echo "README file not found in $HOME, creating"
+
+  cat /etc/sagemaker-ui/project-storage/README.md > "$HOME/README.md"
+else
+  echo "README already exists, skipping"
+fi
+

template/v3/dirs/etc/sagemaker-ui/sagemaker_ui_post_startup.sh

@@ -195,7 +195,8 @@ if [ $is_s3_storage_flag -ne 0 ]; then
   git config --global user.email "$email"
   git config --global user.name "$username"
 else
-  echo "Project is using Non-Git storage, skipping git repository setup and ~/src dir creation"
+  echo "Project is using Non-Git storage, skipping git repository setup and ~/src dir creation and creating README"
+  bash /etc/sagemaker-ui/project-storage/create-storage-readme.sh
 fi
 
 # MLFlow tracking server uses the LOGNAME environment variable to track identity. Set the LOGNAME to the username of the user associated with the space