Merge pull request #18 from brianmajor/main

Populate index.md

docs/index.md

@@ -1,17 +1,32 @@
-# Welcome to MkDocs
+# [CANFAR Science Platform](https://www.canfar.net) User Containers
 
-For full documentation visit [mkdocs.org](https://www.mkdocs.org).
+This repository includes build recipes for containers to be launched on the CANFAR science-platform. 
+Please feel free to contribute.
 
-## Commands
+## CANFAR-maintained Containers
+Curently the repository contains basic build system to build a hierarchy of default containers supported by CANFAR:
 
-* `mkdocs new [dir-name]` - Create a new project.
-* `mkdocs serve` - Start the live-reloading docs server.
-* `mkdocs build` - Build the documentation site.
-* `mkdocs -h` - Print help message and exit.
+``` py
+	                    Ubuntu LTS
+	                    	|
+		            base (headless)
+	                    	|
+		_____________________ _ _ _ _ _ _ _
+		|                                  | 
+astroml (headless)			Desktop Application (desktop-app)
+		|
+astroml-notebook (notebook) 
+astroml-vscode   (contributed)
+astroml-desktop  (desktop-app)
+```
 
-## Project layout
+- The `base` is a `headless` container are built from a vanilla Ubutu LTS, with extra operating system installed (compilers, development libraries), and conda install.
+- The `astroml` is another `headless` container and is built with a large set of astronomy, machine learning, deep learning, visualisations and data science libraries. 
+- The `astroml-*` add visualisation and interactivity software. They can be launched as a `notebook` session, a `contributed` VSCode session, or a terminal through a `desktop` session.
+- The `Desktop Application` containers do not typically derive from `astroml` and sometimes not from `base` containers, as they are legacy and may rely on now unsupported OS.
 
-    mkdocs.yml    # The configuration file.
-    docs/
-        index.md  # The documentation homepage.
-        ...       # Other markdown pages, images and other files.
+There are CUDA-enabled versions of the containers, which include NVIDIA software and CUDA-powered libraries. They are built and named as `*-gpu`, i.e. `astroml-gpu`, `astroml-gpu-notebook`.
+
+## CANFAR User Customised Container
+If you want to build your own containers, documentation can be found in the [docs directory](docs).
+This directory also contains the building of the [CANFAR usage documentation](https://canfar-scienceportal.readthedocs.io/en/latest/) in the readthedocs style.