Smaller refactoring, adding readmes to folders (#3183)

* remove binder folder * add a contrib readme file * add notebooks readme * utils readme * moving the k8s doc to the official docs and kill the folder
google · Sep 20, 2024 · 9f98556 · 9f98556
1 parent fb8a633
commit 9f98556
Show file tree

Hide file tree

Showing 6 changed files with 21 additions and 11 deletions.
diff --git a/binder/requirements.txt b/binder/requirements.txt
diff --git a/contrib/README.md b/contrib/README.md
@@ -0,0 +1,8 @@
+# Contrib
+
+This folder contains various scripts, templates and pieces contributed from the community.
+
+## Disclaimer
+
+None of the content of this folder is maintained by the Timesketch-dev team.
+Using it is at your own risk.
diff --git a/docs/guides/admin/install.md b/docs/guides/admin/install.md
@@ -155,3 +155,9 @@ Congratulations, your Timesketch system is operational and ready to use.
 ### Set up users
 
 After system is set up, look at [here](/guides/admin/admin-cli/) to add users.
+
+# Timesketch K8s Installation
+
+Please refer to
+[OSDFIR Infrastructure](https://github.com/google/osdfir-infrastructure)
+repository for official installation instructions.
diff --git a/k8s/README.md b/k8s/README.md
diff --git a/notebooks/README.md b/notebooks/README.md
@@ -0,0 +1,4 @@
+# Notebooks
+
+This folder contains various Jupyter notebooks to show how interaction with the
+Timesketch API works.
diff --git a/utils/README.md b/utils/README.md
@@ -0,0 +1,3 @@
+# utils
+
+This folder contains tools and utils used and maintained by the Timesketch-dev team.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# utils

		This folder contains tools and utils used and maintained by the Timesketch-dev team.