diff --git a/doc/api/content/algo/getting-started/development.md b/doc/api/content/algo/getting-started/development.md index e75ef5176..1b001a128 100644 --- a/doc/api/content/algo/getting-started/development.md +++ b/doc/api/content/algo/getting-started/development.md @@ -3,4 +3,13 @@ title = "Development" weight = 3 +++ -todo: write some code \ No newline at end of file +# Visual Studio Code + +In this section we're going to use a special feature of Visual Studio Code to do our editing. If you are using a different editor skip to the other editor section. + + + + +# Other Editor + +Good luck. 🦁🐯🐻 \ No newline at end of file diff --git a/doc/api/content/algo/getting-started/docker_config.png b/doc/api/content/algo/getting-started/docker_config.png new file mode 100644 index 000000000..d8fb57ac1 Binary files /dev/null and b/doc/api/content/algo/getting-started/docker_config.png differ diff --git a/doc/api/content/algo/getting-started/docker_tray.png b/doc/api/content/algo/getting-started/docker_tray.png new file mode 100644 index 000000000..f180c7a94 Binary files /dev/null and b/doc/api/content/algo/getting-started/docker_tray.png differ diff --git a/doc/api/content/algo/getting-started/download.md b/doc/api/content/algo/getting-started/download.md index dc385af80..49db5a307 100644 --- a/doc/api/content/algo/getting-started/download.md +++ b/doc/api/content/algo/getting-started/download.md @@ -3,8 +3,64 @@ title = "Download SDK" weight = 2 +++ -* Request access +## Request Access 🔑 -* Download .tar file +To start using the BTS Spark SDK you will need to request access though our sales department. Please email info@bluetradesys.com or call (919) 913-0850 and we will provide download credentials. -* unzip and `docker import` +## Download + +Download the latest SDK image here: spark_sdk.zip + +Unzip that folder into a working directory. Inside you should see something like this: + +``` +spark_sdk.img +spark_installer.exe +devcontainer.json +algo_template/ +bin/ +``` + +## Import + +Import the spark_sdk image into docker using the `docker load` command. +``` +docker load < spark_sdk.img +``` + +
## Editor
-* Install an editor
\ No newline at end of file
+
+This documentation assumes you are going to use the
+Visual Studio Code
+editor to develop your Algo. The Spark SDK comes with a complete configuration for C++ development with VSCode so this is the simplest way to get started. However, if you are already familiar with a different editor you are welcome to use it.
+
+
diff --git a/doc/api/content/algo/ref/lifecycle.md b/doc/api/content/algo/ref/lifecycle.md
new file mode 100644
index 000000000..7b0b37456
--- /dev/null
+++ b/doc/api/content/algo/ref/lifecycle.md
@@ -0,0 +1,6 @@
++++
+title = "Algo Lifecycle"
+weight = 0
++++
+
+todo
diff --git a/doc/api/sass/_base.scss b/doc/api/sass/_base.scss
index 4805659a9..f5ad65103 100644
--- a/doc/api/sass/_base.scss
+++ b/doc/api/sass/_base.scss
@@ -86,8 +86,8 @@ pre {
p code, li code {
background-color: #f5f5f5;
white-space: pre-wrap;
- padding: 5px;
- border-radius: 5px;
+ padding: 3px;
+ border-radius: 3px;
font-size: 0.85rem;
box-shadow: 0 1px 3px rgba(0,0,0,.1), 0 1px 1px rgba(0,0,0,.1), 0 2px 1px -1px rgba(0,0,0,.12);
}
diff --git a/doc/api/sass/_layout.scss b/doc/api/sass/_layout.scss
index c917f7fe3..fbd1bc483 100644
--- a/doc/api/sass/_layout.scss
+++ b/doc/api/sass/_layout.scss
@@ -22,6 +22,20 @@ header {
}
}
+.linux {
+ padding: 25px 15px;
+ background: #eff0f1;
+ border-radius: 5px;
+ border: 1px solid #0072a2;
+}
+
+.info {
+ padding: 25px 15px;
+ background: #ffffe0;
+ border-radius: 5px;
+ border: 1px solid #383838;
+}
+
footer {
text-align: center;
diff --git a/doc/api/templates/shortcodes/linux.html b/doc/api/templates/shortcodes/linux.html
new file mode 100644
index 000000000..7c931f3dd
--- /dev/null
+++ b/doc/api/templates/shortcodes/linux.html
@@ -0,0 +1,3 @@
+