From d0614477bdba478e88a5a3af2e069e5e280acfd7 Mon Sep 17 00:00:00 2001 From: Julian Molina Date: Fri, 1 Nov 2019 14:37:11 +0100 Subject: [PATCH 01/16] Update CONTRIBUTING.md --- CONTRIBUTING.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1d1736260..3ce2930de 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,6 +4,16 @@ We are thrilled you are interested in contributing to this repository. Your help Superalgos is a collective project, currently at a very early stage. We not only welcome contributions but may even choose to incentivize relevant contributions via the project's native crypto token. -Please read the [Join the Dev Team]( https://superalgos.org/developers-join-dev-team.shtml) page in our website to learn more about how you may become a relevant member of the Community and even make a living out of contributing code to the project. +Please read the [Join the Dev Team]( https://superalgos.org/developers-join-dev-team.shtml) page in our website to learn more about how you may become a relevant member of the Superalgos Project and even make a living out of contributing code. -Contributions are deemed _voluntary work_, irrespective of the incentives that may be in place, and are subject to the conditions described in the LICENSE \ No newline at end of file +Contributions are deemed _voluntary work_, irrespective of the incentives that may be in place, and are subject to the conditions described in the software [LICENSE](https://github.com/Superalgos/DesktopApp/blob/master/LICENSE). + +## Getting Started + +First step is to download, install and start using the app. The release includes all source code which constitutes your development environment right out of the package. + +The priority at this moment is the stabilization of existing functionality. Your first contribution will be using and testing the app, and reporting any bugs you may find. + +You may debug de code and remove bugs your self, and submit pull requests to the corresponding repositories. The name of the folder containing the code maps each of the repositories involved in the release. + +As you engage with other developers and the Core Team, we will get to know you and develop a relationship, so that you may later participate in core development tasks. From b71dafec7ff5f60adf99a7fe35214ec6967ecd13 Mon Sep 17 00:00:00 2001 From: Julian Molina Date: Fri, 1 Nov 2019 14:47:31 +0100 Subject: [PATCH 02/16] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3ce2930de..5c880162f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,6 +14,6 @@ First step is to download, install and start using the app. The release includes The priority at this moment is the stabilization of existing functionality. Your first contribution will be using and testing the app, and reporting any bugs you may find. -You may debug de code and remove bugs your self, and submit pull requests to the corresponding repositories. The name of the folder containing the code maps each of the repositories involved in the release. +You may debug and remove bugs yourself, and submit pull requests to the corresponding repositories. The name of the folder containing the code maps each of the repositories involved in the release. As you engage with other developers and the Core Team, we will get to know you and develop a relationship, so that you may later participate in core development tasks. From 0dfa78815ba2f9002fd28f04bdb4349ef2f06c5f Mon Sep 17 00:00:00 2001 From: Julian Molina Date: Fri, 1 Nov 2019 18:06:26 +0100 Subject: [PATCH 03/16] Update CONTRIBUTING.md --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5c880162f..816cffab1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,10 +1,10 @@ # Contributing -We are thrilled you are interested in contributing to this repository. Your help may be essential to the project's success and we want you in! +We are thrilled you are interested in contributing to this project. Your help may be essential to the project's success and we want you in! Superalgos is a collective project, currently at a very early stage. We not only welcome contributions but may even choose to incentivize relevant contributions via the project's native crypto token. -Please read the [Join the Dev Team]( https://superalgos.org/developers-join-dev-team.shtml) page in our website to learn more about how you may become a relevant member of the Superalgos Project and even make a living out of contributing code. +Please read the [Join the Dev Team]( https://superalgos.org/developers-join-dev-team.shtml) page in our website to learn more about how you may become a relevant member of the Superalgos Project and even make a living of contributing code. Contributions are deemed _voluntary work_, irrespective of the incentives that may be in place, and are subject to the conditions described in the software [LICENSE](https://github.com/Superalgos/DesktopApp/blob/master/LICENSE). From 520d8d0f3b27e87e9c4cb78b74fe9befda3ade92 Mon Sep 17 00:00:00 2001 From: Julian Molina Date: Fri, 1 Nov 2019 20:19:02 +0100 Subject: [PATCH 04/16] Update CONTRIBUTING.md --- CONTRIBUTING.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 816cffab1..719a78b8d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,10 +10,14 @@ Contributions are deemed _voluntary work_, irrespective of the incentives that m ## Getting Started -First step is to download, install and start using the app. The release includes all source code which constitutes your development environment right out of the package. +First step is to download, install and start using the app. The release includes all source code which constitutes your development environment right out of the package. The app runs uncompilled on the actual code. -The priority at this moment is the stabilization of existing functionality. Your first contribution will be using and testing the app, and reporting any bugs you may find. +* The priority at this moment is the stabilization of existing functionality. Your first contribution will be using and testing the app, and reporting any bugs you may find. -You may debug and remove bugs yourself, and submit pull requests to the corresponding repositories. The name of the folder containing the code maps each of the repositories involved in the release. +* You may debug and remove bugs yourself, and submit pull requests to the corresponding repositories. The name of the folder containing the code maps each of the repositories involved in the release. + +* Additionally, you may contribute helping improve the README and building the documentation in each of the repositories involved. As you engage with other developers and the Core Team, we will get to know you and develop a relationship, so that you may later participate in core development tasks. + +Please join the [Develop Telkegram Group](https://t.me/superalgosdevelop) and let us know about your progress. From 18e2afe6530d91228f933b85b9a38625cd350f97 Mon Sep 17 00:00:00 2001 From: Julian Molina Date: Fri, 1 Nov 2019 20:19:33 +0100 Subject: [PATCH 05/16] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 719a78b8d..b364a1397 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -20,4 +20,4 @@ First step is to download, install and start using the app. The release includes As you engage with other developers and the Core Team, we will get to know you and develop a relationship, so that you may later participate in core development tasks. -Please join the [Develop Telkegram Group](https://t.me/superalgosdevelop) and let us know about your progress. +Please join the [Develop Telkegram Group](https://t.me/superalgosdevelop), let us know about your progress and ask any questions you may have. From a4d2cea259e613ebb75086b0d7d3cbb0c9227ba2 Mon Sep 17 00:00:00 2001 From: Julian Molina Date: Fri, 1 Nov 2019 20:19:56 +0100 Subject: [PATCH 06/16] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b364a1397..32b8d6b4a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -20,4 +20,4 @@ First step is to download, install and start using the app. The release includes As you engage with other developers and the Core Team, we will get to know you and develop a relationship, so that you may later participate in core development tasks. -Please join the [Develop Telkegram Group](https://t.me/superalgosdevelop), let us know about your progress and ask any questions you may have. +Please join the [Develop Telegram Group](https://t.me/superalgosdevelop), let us know about your progress and ask any questions you may have. From 054cf522ac628118cd27fe3c2550e59bbabf7d78 Mon Sep 17 00:00:00 2001 From: Julian Molina Date: Fri, 1 Nov 2019 20:21:03 +0100 Subject: [PATCH 07/16] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 32b8d6b4a..4bb656a53 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -20,4 +20,4 @@ First step is to download, install and start using the app. The release includes As you engage with other developers and the Core Team, we will get to know you and develop a relationship, so that you may later participate in core development tasks. -Please join the [Develop Telegram Group](https://t.me/superalgosdevelop), let us know about your progress and ask any questions you may have. +Please join the [Develop Telegram Group](https://t.me/superalgosdevelop), let us know about your progress and ask any questions you may have. Feel free to let us know about yourself and your personal interests. From 854a16f5927083e682a2acace2a6eebdebff3fe7 Mon Sep 17 00:00:00 2001 From: Julian Molina Date: Fri, 1 Nov 2019 20:50:02 +0100 Subject: [PATCH 08/16] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4bb656a53..7ca941931 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -20,4 +20,4 @@ First step is to download, install and start using the app. The release includes As you engage with other developers and the Core Team, we will get to know you and develop a relationship, so that you may later participate in core development tasks. -Please join the [Develop Telegram Group](https://t.me/superalgosdevelop), let us know about your progress and ask any questions you may have. Feel free to let us know about yourself and your personal interests. +Please join the [Superalgos Develop](https://t.me/superalgosdevelop) Telegram group, let us know about your progress and ask any questions you may have. Feel free to let us know about yourself and your personal interests. From 73f213f64b742e92a7c1e97250fcfb28e4aeb46b Mon Sep 17 00:00:00 2001 From: Julian Molina Date: Mon, 9 Dec 2019 11:18:53 +0100 Subject: [PATCH 09/16] Platform --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index d46df53e5..957feefed 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ -# Superalgos Desktop App +# Superalgos Platform -The Superalgos Desktop App is the client application of the Superalgos Platform suite and provides a visual environment for developing, testing and automating crypto-trading strategies. +The Superalgos Platform provides a visual environment for developing, testing and automating crypto-trading strategies as well as processing markets data and building indicators. ![Illustration](https://user-images.githubusercontent.com/13994516/63528460-4550ae80-c503-11e9-8db6-22995e0b9c16.gif) -## User's Guide +## Users Manual -Visit the [User's Guide](https://github.com/Superalgos/DesktopApp/wiki) for instructions on how to download, install, fire up and use the app. +Visit the [Users Manual](https://github.com/Superalgos/Platform/wiki) for instructions on how to download, install, fire up and use the app. ## Code and Development Environment @@ -16,8 +16,8 @@ The concerned code is distributed with the app's release and constitutes a fully ## Contributing -We'd love you to join us in the Dev Team. Please see [CONTRIBUTING.md](https://github.com/Superalgos/DesktopApp/blob/master/CONTRIBUTING.md) for the details on how to engage with it. +We'd love you to join us in the Dev Team. Please see [CONTRIBUTING.md](https://github.com/Superalgos/Platform/blob/master/CONTRIBUTING.md) for the details on how to engage with it. ## License -The Superalgos Desktop App is open-source software released under [Apache License 2.0](https://github.com/Superalgos/DesktopApp/blob/master/LICENSE). +The Superalgos Desktop App is open-source software released under [Apache License 2.0](https://github.com/Superalgos/Platform/blob/master/LICENSE). From dd55aeb6638655cd14798e2ac55fc752391bae7f Mon Sep 17 00:00:00 2001 From: Julian Molina Date: Mon, 9 Dec 2019 11:20:46 +0100 Subject: [PATCH 10/16] Platform --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 957feefed..0928d9827 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ Visit the [Users Manual](https://github.com/Superalgos/Platform/wiki) for instru ## Code and Development Environment -The Superalgos Desktop App draws code from several repositories within the Superalgos Github organization, as well as from organizations belonging to Teams. +The Superalgos Platform draws code from several repositories within the Superalgos Github organization, as well as from organizations belonging to Teams. The concerned code is distributed with the app's release and constitutes a fully functional development environment right out of the package. The app runs uncompilled on the actual code. From 6eaa86630a71354d265f44b1c1f841d06f27f360 Mon Sep 17 00:00:00 2001 From: Julian Molina Date: Sat, 18 Jan 2020 16:42:05 +0100 Subject: [PATCH 11/16] Site creation --- docs/.gitignore | 5 ++ docs/404.html | 25 ++++++ docs/Gemfile | 30 +++++++ docs/Gemfile.lock | 84 +++++++++++++++++++ docs/_config.yml | 55 ++++++++++++ .../2020-01-18-welcome-to-jekyll.markdown | 29 +++++++ docs/about.markdown | 18 ++++ docs/index.markdown | 6 ++ 8 files changed, 252 insertions(+) create mode 100644 docs/.gitignore create mode 100644 docs/404.html create mode 100644 docs/Gemfile create mode 100644 docs/Gemfile.lock create mode 100644 docs/_config.yml create mode 100644 docs/_posts/2020-01-18-welcome-to-jekyll.markdown create mode 100644 docs/about.markdown create mode 100644 docs/index.markdown diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 000000000..f40fbd8ba --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1,5 @@ +_site +.sass-cache +.jekyll-cache +.jekyll-metadata +vendor diff --git a/docs/404.html b/docs/404.html new file mode 100644 index 000000000..086a5c9ea --- /dev/null +++ b/docs/404.html @@ -0,0 +1,25 @@ +--- +permalink: /404.html +layout: default +--- + + + +
+

404

+ +

Page not found :(

+

The requested page could not be found.

+
diff --git a/docs/Gemfile b/docs/Gemfile new file mode 100644 index 000000000..6dc48a17e --- /dev/null +++ b/docs/Gemfile @@ -0,0 +1,30 @@ +source "https://rubygems.org" +# Hello! This is where you manage which Jekyll version is used to run. +# When you want to use a different version, change it below, save the +# file and run `bundle install`. Run Jekyll with `bundle exec`, like so: +# +# bundle exec jekyll serve +# +# This will help ensure the proper Jekyll version is running. +# Happy Jekylling! +# gem "jekyll", "~> 4.0.0" +# This is the default theme for new Jekyll sites. You may change this to anything you like. +gem "minima", "~> 2.5" +# If you want to use GitHub Pages, remove the "gem "jekyll"" above and +# uncomment the line below. To upgrade, run `bundle update github-pages`. +gem "github-pages", "~> 203", group: :jekyll_plugins +# If you have any plugins, put them here! +group :jekyll_plugins do + gem "jekyll-feed", "~> 0.12" +end + +# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem +# and associated library. +install_if -> { RUBY_PLATFORM =~ %r!mingw|mswin|java! } do + gem "tzinfo", "~> 1.2" + gem "tzinfo-data" +end + +# Performance-booster for watching directories on Windows +gem "wdm", "~> 0.1.1", :install_if => Gem.win_platform? + diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock new file mode 100644 index 000000000..b90bf5378 --- /dev/null +++ b/docs/Gemfile.lock @@ -0,0 +1,84 @@ +GEM + remote: https://rubygems.org/ + specs: + addressable (2.7.0) + public_suffix (>= 2.0.2, < 5.0) + colorator (1.1.0) + concurrent-ruby (1.1.5) + em-websocket (0.5.1) + eventmachine (>= 0.12.9) + http_parser.rb (~> 0.6.0) + eventmachine (1.2.7-x64-mingw32) + ffi (1.12.1-x64-mingw32) + forwardable-extended (2.6.0) + http_parser.rb (0.6.0) + i18n (1.8.2) + concurrent-ruby (~> 1.0) + jekyll (4.0.0) + addressable (~> 2.4) + colorator (~> 1.0) + em-websocket (~> 0.5) + i18n (>= 0.9.5, < 2) + jekyll-sass-converter (~> 2.0) + jekyll-watch (~> 2.0) + kramdown (~> 2.1) + kramdown-parser-gfm (~> 1.0) + liquid (~> 4.0) + mercenary (~> 0.3.3) + pathutil (~> 0.9) + rouge (~> 3.0) + safe_yaml (~> 1.0) + terminal-table (~> 1.8) + jekyll-feed (0.13.0) + jekyll (>= 3.7, < 5.0) + jekyll-sass-converter (2.0.1) + sassc (> 2.0.1, < 3.0) + jekyll-seo-tag (2.6.1) + jekyll (>= 3.3, < 5.0) + jekyll-watch (2.2.1) + listen (~> 3.0) + kramdown (2.1.0) + kramdown-parser-gfm (1.1.0) + kramdown (~> 2.0) + liquid (4.0.3) + listen (3.2.1) + rb-fsevent (~> 0.10, >= 0.10.3) + rb-inotify (~> 0.9, >= 0.9.10) + mercenary (0.3.6) + minima (2.5.1) + jekyll (>= 3.5, < 5.0) + jekyll-feed (~> 0.9) + jekyll-seo-tag (~> 2.1) + pathutil (0.16.2) + forwardable-extended (~> 2.6) + public_suffix (4.0.3) + rb-fsevent (0.10.3) + rb-inotify (0.10.1) + ffi (~> 1.0) + rouge (3.15.0) + safe_yaml (1.0.5) + sassc (2.2.1-x64-mingw32) + ffi (~> 1.9) + terminal-table (1.8.0) + unicode-display_width (~> 1.1, >= 1.1.1) + thread_safe (0.3.6) + tzinfo (1.2.6) + thread_safe (~> 0.1) + tzinfo-data (1.2019.3) + tzinfo (>= 1.0.0) + unicode-display_width (1.6.1) + wdm (0.1.1) + +PLATFORMS + x64-mingw32 + +DEPENDENCIES + jekyll (~> 4.0.0) + jekyll-feed (~> 0.12) + minima (~> 2.5) + tzinfo (~> 1.2) + tzinfo-data + wdm (~> 0.1.1) + +BUNDLED WITH + 2.1.4 diff --git a/docs/_config.yml b/docs/_config.yml new file mode 100644 index 000000000..60e14aa77 --- /dev/null +++ b/docs/_config.yml @@ -0,0 +1,55 @@ +# Welcome to Jekyll! +# +# This config file is meant for settings that affect your whole blog, values +# which you are expected to set up once and rarely edit after that. If you find +# yourself editing this file very often, consider using Jekyll's data files +# feature for the data you need to update frequently. +# +# For technical reasons, this file is *NOT* reloaded automatically when you use +# 'bundle exec jekyll serve'. If you change this file, please restart the server process. +# +# If you need help with YAML syntax, here are some quick references for you: +# https://learn-the-web.algonquindesign.ca/topics/markdown-yaml-cheat-sheet/#yaml +# https://learnxinyminutes.com/docs/yaml/ +# +# Site settings +# These are used to personalize your new site. If you look in the HTML files, +# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on. +# You can create any custom variable you would like, and they will be accessible +# in the templates via {{ site.myvariable }}. + +title: Your awesome title +email: your-email@example.com +description: >- # this means to ignore newlines until "baseurl:" + Write an awesome description for your new site here. You can edit this + line in _config.yml. It will appear in your document head meta (for + Google search results) and in your feed.xml site description. +baseurl: "" # the subpath of your site, e.g. /blog +url: "" # the base hostname & protocol for your site, e.g. http://example.com +twitter_username: jekyllrb +github_username: jekyll + +# Build settings +theme: minima +plugins: + - jekyll-feed + +# Exclude from processing. +# The following items will not be processed, by default. +# Any item listed under the `exclude:` key here will be automatically added to +# the internal "default list". +# +# Excluded items can be processed by explicitly listing the directories or +# their entries' file path in the `include:` list. +# +# exclude: +# - .sass-cache/ +# - .jekyll-cache/ +# - gemfiles/ +# - Gemfile +# - Gemfile.lock +# - node_modules/ +# - vendor/bundle/ +# - vendor/cache/ +# - vendor/gems/ +# - vendor/ruby/ diff --git a/docs/_posts/2020-01-18-welcome-to-jekyll.markdown b/docs/_posts/2020-01-18-welcome-to-jekyll.markdown new file mode 100644 index 000000000..0c7171fb0 --- /dev/null +++ b/docs/_posts/2020-01-18-welcome-to-jekyll.markdown @@ -0,0 +1,29 @@ +--- +layout: post +title: "Welcome to Jekyll!" +date: 2020-01-18 16:30:38 +0100 +categories: jekyll update +--- +You’ll find this post in your `_posts` directory. Go ahead and edit it and re-build the site to see your changes. You can rebuild the site in many different ways, but the most common way is to run `jekyll serve`, which launches a web server and auto-regenerates your site when a file is updated. + +Jekyll requires blog post files to be named according to the following format: + +`YEAR-MONTH-DAY-title.MARKUP` + +Where `YEAR` is a four-digit number, `MONTH` and `DAY` are both two-digit numbers, and `MARKUP` is the file extension representing the format used in the file. After that, include the necessary front matter. Take a look at the source for this post to get an idea about how it works. + +Jekyll also offers powerful support for code snippets: + +{% highlight ruby %} +def print_hi(name) + puts "Hi, #{name}" +end +print_hi('Tom') +#=> prints 'Hi, Tom' to STDOUT. +{% endhighlight %} + +Check out the [Jekyll docs][jekyll-docs] for more info on how to get the most out of Jekyll. File all bugs/feature requests at [Jekyll’s GitHub repo][jekyll-gh]. If you have questions, you can ask them on [Jekyll Talk][jekyll-talk]. + +[jekyll-docs]: https://jekyllrb.com/docs/home +[jekyll-gh]: https://github.com/jekyll/jekyll +[jekyll-talk]: https://talk.jekyllrb.com/ diff --git a/docs/about.markdown b/docs/about.markdown new file mode 100644 index 000000000..8b4e0b28c --- /dev/null +++ b/docs/about.markdown @@ -0,0 +1,18 @@ +--- +layout: page +title: About +permalink: /about/ +--- + +This is the base Jekyll theme. You can find out more info about customizing your Jekyll theme, as well as basic Jekyll usage documentation at [jekyllrb.com](https://jekyllrb.com/) + +You can find the source code for Minima at GitHub: +[jekyll][jekyll-organization] / +[minima](https://github.com/jekyll/minima) + +You can find the source code for Jekyll at GitHub: +[jekyll][jekyll-organization] / +[jekyll](https://github.com/jekyll/jekyll) + + +[jekyll-organization]: https://github.com/jekyll diff --git a/docs/index.markdown b/docs/index.markdown new file mode 100644 index 000000000..067150784 --- /dev/null +++ b/docs/index.markdown @@ -0,0 +1,6 @@ +--- +# Feel free to add content and custom Front Matter to this file. +# To modify the layout, see https://jekyllrb.com/docs/themes/#overriding-theme-defaults + +layout: home +--- From 8f184d16fb61f9c5b1e42e31839f575a13018a54 Mon Sep 17 00:00:00 2001 From: Julian Molina Date: Sat, 18 Jan 2020 16:51:04 +0100 Subject: [PATCH 12/16] Set theme jekyll-theme-minimal --- docs/_config.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/_config.yml b/docs/_config.yml index 60e14aa77..2435c872f 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -30,7 +30,7 @@ twitter_username: jekyllrb github_username: jekyll # Build settings -theme: minima +theme: jekyll-theme-minimal plugins: - jekyll-feed From 00412ff3c9c01b6d214f4a0bce34676baa64f773 Mon Sep 17 00:00:00 2001 From: Julian Molina Date: Sat, 18 Jan 2020 17:05:46 +0100 Subject: [PATCH 13/16] Set theme jekyll-theme-cayman --- docs/_config.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/_config.yml b/docs/_config.yml index 2435c872f..2ff63ab0f 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -30,7 +30,7 @@ twitter_username: jekyllrb github_username: jekyll # Build settings -theme: jekyll-theme-minimal +theme: jekyll-theme-cayman plugins: - jekyll-feed From 640cd0919a219191ac13aa732bcfad9c81fdfd11 Mon Sep 17 00:00:00 2001 From: Julian Molina Date: Sat, 18 Jan 2020 17:09:13 +0100 Subject: [PATCH 14/16] Update _config.yml --- docs/_config.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/_config.yml b/docs/_config.yml index 2ff63ab0f..60e14aa77 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -30,7 +30,7 @@ twitter_username: jekyllrb github_username: jekyll # Build settings -theme: jekyll-theme-cayman +theme: minima plugins: - jekyll-feed From f73443a9e3b6fac99654fe14130dd55a08c33919 Mon Sep 17 00:00:00 2001 From: Julian Molina Date: Sat, 18 Jan 2020 18:31:29 +0100 Subject: [PATCH 15/16] Test --- docs/Advanced-Backtesting.md | 107 +++++++++ docs/Anatomy-of-an-Indicator.md | 40 ++++ docs/Backups.md | 65 ++++++ docs/Gemfile.lock | 208 ++++++++++++++++-- .../2020-01-18-welcome-to-jekyll.markdown | 55 ++++- 5 files changed, 456 insertions(+), 19 deletions(-) create mode 100644 docs/Advanced-Backtesting.md create mode 100644 docs/Anatomy-of-an-Indicator.md create mode 100644 docs/Backups.md diff --git a/docs/Advanced-Backtesting.md b/docs/Advanced-Backtesting.md new file mode 100644 index 000000000..3ea80162f --- /dev/null +++ b/docs/Advanced-Backtesting.md @@ -0,0 +1,107 @@ +--- + +layout: page + +title: Advanced Backtesting + +--- + +## Topics + +* [Adding new sessions](#adding-new-sessions) +* [Linking processes and sessions](#linking-processes-and-sessions) +* [Sessions folder name](#sessions-folder-name) +* [Testing logic variations](#testing-logic-variations) +* [Testing on non-linear date ranges](#testing-on-non-linear-date-ranges) + +## Adding New Sessions + +The platform allows for having multiple testing sessions. You may add and work with multiple sessions in two different ways: + +**1. Independent Task** + +Each task is an independent process at the *operating system* level, which handles its own memory allotment, and may be controlled and killed independently. + +A process running under its own task may not be affected by errors occurring on other processes. + +For the reasons above, you may choose to run each testing session on separate tasks. + +The easiest way to create sessions under this configuration is by cloning an existing task and dropping the cloned file back on the Designer. Once the new task is on the Designer, you may chain it to your preferred task manager. + +[![Sessions-01-Duplicate](https://user-images.githubusercontent.com/13994516/70354911-23d8c000-1871-11ea-8a6c-552ab6e206ce.gif)](https://user-images.githubusercontent.com/13994516/70354911-23d8c000-1871-11ea-8a6c-552ab6e206ce.gif) + +> **NOTE:** You may even choose to set up an independent task manager. Simply go to the *My Computer* network node and click *Add Task Manager*. + +**2. Shared Task** + +You may decide that you don't need independent tasks for each of your backtesting sessions or prefer to handle multiple sessions under one task. + +To create new sessions under such configuration you need to clone the process that runs one of the existing sessions, and drop the clone on to the Designer. Then, structure of nodes the process to the trading bot instance and give the session a new name. + +[![Network-05-Multiple-Backtests](https://user-images.githubusercontent.com/13994516/67272829-90644f00-f4bd-11e9-9559-3f01233ecee8.gif)](https://user-images.githubusercontent.com/13994516/67272829-90644f00-f4bd-11e9-9559-3f01233ecee8.gif) + +The number of backtesting sessions you may run simultaneously is capped by your machine's processing capacity. Current tests indicate that a dual-core processor at 2.4GHz may process up to 5 sessions at the same time without compromising the machine's performance. + +Running more sessions than the optimal number your machine may process efficiently may result in the sessions taking more time to process than if they were run in a sequence. + +## Linking Processes and Sessions + +If you followed the above process, cloning the whole task or process structure of nodes to duplicate a session, you do not need to do anything else... your new session is already up and running. + +However, if you decide to create a new structure of nodes by creating each individual node at the time, you will need to continue with the following steps. + +### Process + +Every time you create a new session you need to establish a reference from the process instance to the *Multi-Period* process of *Jason*, the trading bot. Jason *lives* within the *Masters* team. + +To do this, you first need to locate Jason. Hit Ctrl or ⌘ + Alt + M (*M* for *Masters*) and click ![plus](https://user-images.githubusercontent.com/13994516/70042962-121cc180-15c0-11ea-8322-018f78524f39.PNG) on the menu. + +Now hit Ctrl or ⌘ + Alt + J (*J* for *Jason*) and click ![plus](https://user-images.githubusercontent.com/13994516/70042962-121cc180-15c0-11ea-8322-018f78524f39.PNG) on the menu. Look around among Jason's offspring nodes and find the *Multi-Period* process definition. + +Now you need to drag your process all the way here and establish teh reference with Jason's *Multi-Period* process definition by pulling it close using the right button of the mouse. Once the reference is established, you may let your process drift back to where it belongs. + +The easy way to drag the process all across the workspace is to right-click it, and use the keyboard Ctrl or ⌘ + ↑ and ← to start panning in the direction of Jason. Just follow the rest of the grey lines corresponding to the references of other processes to find your destination. + +Once you are in the vicinity of Jason, stop, take a pause and pin the data process so that it doesn't fly back to its parent node. Now locate the *Multi-Period* process definition, right-click on the process instance you just dragged and establish the reference. Make sure you unpin the process instance so that it flys back home. + +[![Sessions-02-Link-Process](https://user-images.githubusercontent.com/13994516/70355145-b2e5d800-1871-11ea-9bb3-49148772307c.gif)](https://user-images.githubusercontent.com/13994516/70355145-b2e5d800-1871-11ea-9bb3-49148772307c.gif) + +> **PRO TIP:** if you need to link several processes, you may want to reverse the procedure and drag Jason's *Multi-Period* process definition towards the area where you created the new sessions instead. + +### Session + +You also need to establish a reference between the session and the definition you inted to run the session on. The procedure is similar to the above. Drag the session towards the definition you intend to test on and pull it closer using the right button of the mouse to establish the reference. + +[![Sessions-03-Link-Session](https://user-images.githubusercontent.com/13994516/70355703-0e649580-1873-11ea-925e-1f0250148d2c.gif)](https://user-images.githubusercontent.com/13994516/70355703-0e649580-1873-11ea-925e-1f0250148d2c.gif) + +## Sessions Folder Name + +Before you use the new session, you may want to edit the configuration by clicking *Edit Session* on the menu: + +```js +{ +"folderName": "Session-Name" +} +``` + +The session name you use in the configuration will be taken to name the folder in which the trading bot will store the simulations corresponding to this session. This may be useful should you ever need to look directly into the data. + +## Testing Logic Variations + +Being able to run multiple backtesting sessions allows you to speed up the strategy tuning stage. + +For instance, you may want to check how different variations of a condition in the *take position event* affect the results. To tests all variations at the same time, you would: + +**1.** Replicate a backtesting session by cloning the corresponding *process* node (along with its offspring) and dropping the clone back on your workspace, as many times as you require, [attaching it](Designer-Interface#detachment-and-attachment-of-nodes) to an available trading bot. + +**2.** Rename each backtesting session with a significant name that is related to the different variations of the condition you wish to test. + +**3.** Set up the first variation of the condition and run the corresponding backtesting session. Replace the first variation with the second one, and launch the second backtesting session. Repeat as many times as desired. + +## Testing on Non-Linear Date Ranges + +It is a known fact that testing and optimizing a strategy over a complete dataset may lead to [overfitting](https://en.wikipedia.org/wiki/Overfitting). + +Being able to set up multiple backtesting operations allows you to segment your dataset as you may consider appropriate, for instance, creating sessions to test only on odd months, every three or six months, or in a more random-like arrangement. + +The system provides enough flexibility to accommodate different backtesting criteria and styles. It is up to you how to set it up. \ No newline at end of file diff --git a/docs/Anatomy-of-an-Indicator.md b/docs/Anatomy-of-an-Indicator.md new file mode 100644 index 000000000..fb6dce26e --- /dev/null +++ b/docs/Anatomy-of-an-Indicator.md @@ -0,0 +1,40 @@ +The tools available for you to turn an existing dataset into a new, value-added product, are scattered througout the definitions of the indicator itself. + +We will dive into Paula and Chris—two of the indicators that ship with the platform—to learn how these bots are structured. + +| Masters Team | Paula | Chris | +| :---: | :---: | :---: | +| ![team](https://user-images.githubusercontent.com/13994516/70050816-24066080-15d0-11ea-83c4-f16b71007ecb.png) | ![bot-indicator](https://user-images.githubusercontent.com/13994516/67079733-000fcc80-f194-11e9-98d7-3426dd956d65.png) | ![bot-indicator](https://user-images.githubusercontent.com/13994516/67079733-000fcc80-f194-11e9-98d7-3426dd956d65.png) | + +It is highly recommended that you follow this exploration directly on the platform, so that you may clearly see the relationship among nodes and play with the hierachy as we advance. + +Paula and Chris are offspring nodes of the Masters Team hierarchy. + +To find the Masters team, hit Ctrl or ⌘ + Alt + M (*M* for *Masters*) and click ![plus](https://user-images.githubusercontent.com/13994516/70042962-121cc180-15c0-11ea-8322-018f78524f39.PNG) on the menu. + +To find Paula, hit Ctrl or ⌘ + Alt + P (*P* for *Paula*). + +To find Chris, hit Ctrl or ⌘ + Alt + C (*C* for *Chris*). + +> **NOTE:** At this moment, only Paula's definitions are complete and fully set up in the Masters Team. You may explore the indicators in the Sparta Team for more examples (hit Ctrl or ⌘ + Alt + S (*C* for *Sparta*)). + +## Top Level Structure + +Paula is the indicator building Bollinger Channels and Bollinger SubChannels (along with chanels and subchannel objects, used by plotters), based on the Bollinger Bands created by Chris. + +| Process Definition | Product Definition | +| :---: | :---: | +| ![process-definition](https://user-images.githubusercontent.com/13994516/68941695-e075bf00-07a6-11ea-9386-3fd0f3979719.png) | ![product-definition](https://user-images.githubusercontent.com/13994516/68941696-e075bf00-07a6-11ea-9a6c-8c2b7d8dd6f7.png) | + +We established earlier that bots run *processes* which create *products*. As such, the first order of business to describe an indicator bot is to define its processes and products. + +[![image](https://user-images.githubusercontent.com/13994516/68942711-8cb8a500-07a9-11ea-9e87-8fac12e3a143.png)](https://user-images.githubusercontent.com/13994516/68942711-8cb8a500-07a9-11ea-9e87-8fac12e3a143.png) + +> **NOTE:** When we analyze the way in which nodes are represented within a hierarchy, it may be important to note the *order* in which they are displayed around its parent object. In this case, the first child node of Paula is the Multi-Period-Market Process Definition, as it is the first in the clock-wise direction from the line chaining Paula to its parent node, the Masters Team. In most cases, the order of nodes around its parent determine the order of execution, or the order in which nodes are computed in whatever process is involved. + +An indicator may have several several processes and several products. In the case of Paula, she has two processes and four products. + +The reason why Paula has two processes is related to the products Paula creates and the way each dataset is structured. + +The Multi-Period-Market process stores data in *market files* while the Multi-Period-Daily process stores files in the *daily file* type of dataset. This is a common occurence in most indicators. The reason is that this is the desired behavior so that data may be consumed efficiently both in the lower and higher frequency time periods. + diff --git a/docs/Backups.md b/docs/Backups.md new file mode 100644 index 000000000..e9589aa27 --- /dev/null +++ b/docs/Backups.md @@ -0,0 +1,65 @@ +## Topics + +* [Introduction](#introduction) +* [Outgoing references](#outgoing-references) +* [Incoming references](#incoming-references) +* [Internal references](#internal-references) +* [Conclusion](#conclusion) + +> **NOTE:** To understand backups, you first need to be familiar with [*references*](References). + +## Introduction + +When you back up a single node, a structure of nodes, a complete hierarchy or even the workspace, all existing references are stored in the resulting JSON file. + +When you restore a workspace backup, the current workspace is discarded entirely and replaced with the backup. Now, let's see what happens when you restore anything other than a workspace, that is, any of the data structures contained in the workspace. + +In particular, what we want to analyze is what happens with each type of reference that may be present in the structure. + +What happens with each type of reference when the back up is restored varies depending on one factor: the original structure is present in the workspace, or instead, it has been deleted prior to restoring the backup. + +## Outgoing References + +**Outgoing references are kept no matter if the original structure of nodes still exists or not.** + +For example, in a task set up for running a testing session, the trading bot process instance references to the trading bot Multi-Period process, and the session references a definition. + +[![Backups-01-Task](https://user-images.githubusercontent.com/13994516/71101855-b2293c00-21b7-11ea-864e-817f74e17a34.gif)](https://user-images.githubusercontent.com/13994516/71101855-b2293c00-21b7-11ea-864e-817f74e17a34.gif) + +As the capture above shows, when restoring the backup of a task, both outgoing references are maintained, even when the original task has not been deleted. + +This means that restoring a back up is a viable way to duplicate structure of nodes with outgoing references when you expect outgoing references to be preserved. + +## Incoming References + +**Incoming references are restored only when the original structure of nodes is deleted before restoring the backup.** + +Let's take a definition as an example. Definitions usually have several incoming references originating at different testing and live trading sessions. + +[![Backups-02-Incoming-references](https://user-images.githubusercontent.com/13994516/71103003-ac345a80-21b9-11ea-947c-6e2c59c299c5.gif)](https://user-images.githubusercontent.com/13994516/71103003-ac345a80-21b9-11ea-947c-6e2c59c299c5.gif) + +The capture above shows that restoring a backup of a definition when the orginal definition is still in the workspace causes the incoming references to be lost. + +However, as the capture below shows, if the original structure of nodes is deleted before the backup is restored, then the incoming references are restored as well. + +[![Backups-03-Incoming-references](https://user-images.githubusercontent.com/13994516/71103005-ac345a80-21b9-11ea-8c0f-5ee78f15aa7a.gif)](https://user-images.githubusercontent.com/13994516/71103005-ac345a80-21b9-11ea-8c0f-5ee78f15aa7a.gif) + +## Internal References + +**Internal references are kept *internally* only when the original structure of nodes is deleted before restoring the backup. If the original structure of nodes is present, then the references will point to the original nodes on the original structure of nodes.** + +Continuing with the example explored earlier, on the [references](References) page, let's see what happens when we restore a backup of a *shapes* node without deleting the original node first: + +[![Backups-05-Internal-references-restore](https://user-images.githubusercontent.com/13994516/71107152-de958600-21c0-11ea-8667-d7d56ed24bfb.gif)](https://user-images.githubusercontent.com/13994516/71107152-de958600-21c0-11ea-8667-d7d56ed24bfb.gif) + +As expected, the references from vertices in the restored backup do not point to the points in the same structure, but instead point to the original points in the original strucutre. + +On the other hand, if the original structure of nodes is deleted before restoring the backup, then the references point to the nodes within the same structure: + +[![Backups-06-Internal-references-delete-restore](https://user-images.githubusercontent.com/13994516/71107153-de958600-21c0-11ea-9855-532e2d0631d2.gif)](https://user-images.githubusercontent.com/13994516/71107153-de958600-21c0-11ea-9855-532e2d0631d2.gif) + +## Conclusion + +The backup feature is designed to preserve the integrity of references as you would expect when you wish to restore a data structure to a previous state of affairs. + +However, the tool's particular behavior when restoring a backup without deleting the original structure may be of use in certain ocassions. This is particularly true because in such cases, the backup feature behaves differently than the clone feature, as you will learn on the next page. \ No newline at end of file diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock index b90bf5378..6bdc330bc 100644 --- a/docs/Gemfile.lock +++ b/docs/Gemfile.lock @@ -1,79 +1,251 @@ GEM remote: https://rubygems.org/ specs: + activesupport (6.0.2.1) + concurrent-ruby (~> 1.0, >= 1.0.2) + i18n (>= 0.7, < 2) + minitest (~> 5.1) + tzinfo (~> 1.1) + zeitwerk (~> 2.2) addressable (2.7.0) public_suffix (>= 2.0.2, < 5.0) + coffee-script (2.4.1) + coffee-script-source + execjs + coffee-script-source (1.11.1) colorator (1.1.0) + commonmarker (0.17.13) + ruby-enum (~> 0.5) concurrent-ruby (1.1.5) + dnsruby (1.61.3) + addressable (~> 2.5) em-websocket (0.5.1) eventmachine (>= 0.12.9) http_parser.rb (~> 0.6.0) + ethon (0.12.0) + ffi (>= 1.3.0) eventmachine (1.2.7-x64-mingw32) + execjs (2.7.0) + faraday (1.0.0) + multipart-post (>= 1.2, < 3) ffi (1.12.1-x64-mingw32) forwardable-extended (2.6.0) + gemoji (3.0.1) + github-pages (203) + github-pages-health-check (= 1.16.1) + jekyll (= 3.8.5) + jekyll-avatar (= 0.7.0) + jekyll-coffeescript (= 1.1.1) + jekyll-commonmark-ghpages (= 0.1.6) + jekyll-default-layout (= 0.1.4) + jekyll-feed (= 0.13.0) + jekyll-gist (= 1.5.0) + jekyll-github-metadata (= 2.12.1) + jekyll-mentions (= 1.5.1) + jekyll-optional-front-matter (= 0.3.2) + jekyll-paginate (= 1.1.0) + jekyll-readme-index (= 0.3.0) + jekyll-redirect-from (= 0.15.0) + jekyll-relative-links (= 0.6.1) + jekyll-remote-theme (= 0.4.1) + jekyll-sass-converter (= 1.5.2) + jekyll-seo-tag (= 2.6.1) + jekyll-sitemap (= 1.4.0) + jekyll-swiss (= 1.0.0) + jekyll-theme-architect (= 0.1.1) + jekyll-theme-cayman (= 0.1.1) + jekyll-theme-dinky (= 0.1.1) + jekyll-theme-hacker (= 0.1.1) + jekyll-theme-leap-day (= 0.1.1) + jekyll-theme-merlot (= 0.1.1) + jekyll-theme-midnight (= 0.1.1) + jekyll-theme-minimal (= 0.1.1) + jekyll-theme-modernist (= 0.1.1) + jekyll-theme-primer (= 0.5.4) + jekyll-theme-slate (= 0.1.1) + jekyll-theme-tactile (= 0.1.1) + jekyll-theme-time-machine (= 0.1.1) + jekyll-titles-from-headings (= 0.5.3) + jemoji (= 0.11.1) + kramdown (= 1.17.0) + liquid (= 4.0.3) + mercenary (~> 0.3) + minima (= 2.5.1) + nokogiri (>= 1.10.4, < 2.0) + rouge (= 3.13.0) + terminal-table (~> 1.4) + github-pages-health-check (1.16.1) + addressable (~> 2.3) + dnsruby (~> 1.60) + octokit (~> 4.0) + public_suffix (~> 3.0) + typhoeus (~> 1.3) + html-pipeline (2.12.3) + activesupport (>= 2) + nokogiri (>= 1.4) http_parser.rb (0.6.0) - i18n (1.8.2) + i18n (0.9.5) concurrent-ruby (~> 1.0) - jekyll (4.0.0) + jekyll (3.8.5) addressable (~> 2.4) colorator (~> 1.0) em-websocket (~> 0.5) - i18n (>= 0.9.5, < 2) - jekyll-sass-converter (~> 2.0) + i18n (~> 0.7) + jekyll-sass-converter (~> 1.0) jekyll-watch (~> 2.0) - kramdown (~> 2.1) - kramdown-parser-gfm (~> 1.0) + kramdown (~> 1.14) liquid (~> 4.0) mercenary (~> 0.3.3) pathutil (~> 0.9) - rouge (~> 3.0) + rouge (>= 1.7, < 4) safe_yaml (~> 1.0) - terminal-table (~> 1.8) + jekyll-avatar (0.7.0) + jekyll (>= 3.0, < 5.0) + jekyll-coffeescript (1.1.1) + coffee-script (~> 2.2) + coffee-script-source (~> 1.11.1) + jekyll-commonmark (1.3.1) + commonmarker (~> 0.14) + jekyll (>= 3.7, < 5.0) + jekyll-commonmark-ghpages (0.1.6) + commonmarker (~> 0.17.6) + jekyll-commonmark (~> 1.2) + rouge (>= 2.0, < 4.0) + jekyll-default-layout (0.1.4) + jekyll (~> 3.0) jekyll-feed (0.13.0) jekyll (>= 3.7, < 5.0) - jekyll-sass-converter (2.0.1) - sassc (> 2.0.1, < 3.0) + jekyll-gist (1.5.0) + octokit (~> 4.2) + jekyll-github-metadata (2.12.1) + jekyll (~> 3.4) + octokit (~> 4.0, != 4.4.0) + jekyll-mentions (1.5.1) + html-pipeline (~> 2.3) + jekyll (>= 3.7, < 5.0) + jekyll-optional-front-matter (0.3.2) + jekyll (>= 3.0, < 5.0) + jekyll-paginate (1.1.0) + jekyll-readme-index (0.3.0) + jekyll (>= 3.0, < 5.0) + jekyll-redirect-from (0.15.0) + jekyll (>= 3.3, < 5.0) + jekyll-relative-links (0.6.1) + jekyll (>= 3.3, < 5.0) + jekyll-remote-theme (0.4.1) + addressable (~> 2.0) + jekyll (>= 3.5, < 5.0) + rubyzip (>= 1.3.0) + jekyll-sass-converter (1.5.2) + sass (~> 3.4) jekyll-seo-tag (2.6.1) jekyll (>= 3.3, < 5.0) + jekyll-sitemap (1.4.0) + jekyll (>= 3.7, < 5.0) + jekyll-swiss (1.0.0) + jekyll-theme-architect (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-cayman (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-dinky (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-hacker (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-leap-day (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-merlot (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-midnight (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-minimal (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-modernist (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-primer (0.5.4) + jekyll (> 3.5, < 5.0) + jekyll-github-metadata (~> 2.9) + jekyll-seo-tag (~> 2.0) + jekyll-theme-slate (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-tactile (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-time-machine (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-titles-from-headings (0.5.3) + jekyll (>= 3.3, < 5.0) jekyll-watch (2.2.1) listen (~> 3.0) - kramdown (2.1.0) - kramdown-parser-gfm (1.1.0) - kramdown (~> 2.0) + jemoji (0.11.1) + gemoji (~> 3.0) + html-pipeline (~> 2.2) + jekyll (>= 3.0, < 5.0) + kramdown (1.17.0) liquid (4.0.3) listen (3.2.1) rb-fsevent (~> 0.10, >= 0.10.3) rb-inotify (~> 0.9, >= 0.9.10) mercenary (0.3.6) + mini_portile2 (2.4.0) minima (2.5.1) jekyll (>= 3.5, < 5.0) jekyll-feed (~> 0.9) jekyll-seo-tag (~> 2.1) + minitest (5.14.0) + multipart-post (2.1.1) + nokogiri (1.10.7-x64-mingw32) + mini_portile2 (~> 2.4.0) + octokit (4.15.0) + faraday (>= 0.9) + sawyer (~> 0.8.0, >= 0.5.3) pathutil (0.16.2) forwardable-extended (~> 2.6) - public_suffix (4.0.3) + public_suffix (3.1.1) rb-fsevent (0.10.3) rb-inotify (0.10.1) ffi (~> 1.0) - rouge (3.15.0) + rouge (3.13.0) + ruby-enum (0.7.2) + i18n + rubyzip (2.0.0) safe_yaml (1.0.5) - sassc (2.2.1-x64-mingw32) - ffi (~> 1.9) + sass (3.7.4) + sass-listen (~> 4.0.0) + sass-listen (4.0.0) + rb-fsevent (~> 0.9, >= 0.9.4) + rb-inotify (~> 0.9, >= 0.9.7) + sawyer (0.8.2) + addressable (>= 2.3.5) + faraday (> 0.8, < 2.0) terminal-table (1.8.0) unicode-display_width (~> 1.1, >= 1.1.1) thread_safe (0.3.6) + typhoeus (1.3.1) + ethon (>= 0.9.0) tzinfo (1.2.6) thread_safe (~> 0.1) tzinfo-data (1.2019.3) tzinfo (>= 1.0.0) unicode-display_width (1.6.1) wdm (0.1.1) + zeitwerk (2.2.2) PLATFORMS x64-mingw32 DEPENDENCIES - jekyll (~> 4.0.0) + github-pages (~> 203) jekyll-feed (~> 0.12) minima (~> 2.5) tzinfo (~> 1.2) diff --git a/docs/_posts/2020-01-18-welcome-to-jekyll.markdown b/docs/_posts/2020-01-18-welcome-to-jekyll.markdown index 0c7171fb0..c356ee139 100644 --- a/docs/_posts/2020-01-18-welcome-to-jekyll.markdown +++ b/docs/_posts/2020-01-18-welcome-to-jekyll.markdown @@ -1,4 +1,4 @@ ---- +--- layout: post title: "Welcome to Jekyll!" date: 2020-01-18 16:30:38 +0100 @@ -22,6 +22,59 @@ print_hi('Tom') #=> prints 'Hi, Tom' to STDOUT. {% endhighlight %} +Check out the [Jekyll docs][jekyll-docs] for more info on how to get the most out of Jekyll. File all bugs/feature requests at [Jekyll’s GitHub repo][jekyll-gh]. If you have questions, you can ask them on [Jekyll Talk][jekyll-talk]. +Jekyll requires blog post files to be named according to the following format: + +`YEAR-MONTH-DAY-title.MARKUP` + +Where `YEAR` is a four-digit number, `MONTH` and `DAY` are both two-digit numbers, and `MARKUP` is the file extension representing the format used in the file. After that, include the necessary front matter. Take a look at the source for this post to get an idea about how it works. + +Jekyll also offers powerful support for code snippets: + +{% highlight ruby %} +def print_hi(name) + puts "Hi, #{name}" +end +print_hi('Tom') +#=> prints 'Hi, Tom' to STDOUT. +{% endhighlight %} + +Check out the [Jekyll docs][jekyll-docs] for more info on how to get the most out of Jekyll. File all bugs/feature requests at [Jekyll’s GitHub repo][jekyll-gh]. If you have questions, you can ask them on [Jekyll Talk][jekyll-talk]. + +Jekyll requires blog post files to be named according to the following format: + +`YEAR-MONTH-DAY-title.MARKUP` + +Where `YEAR` is a four-digit number, `MONTH` and `DAY` are both two-digit numbers, and `MARKUP` is the file extension representing the format used in the file. After that, include the necessary front matter. Take a look at the source for this post to get an idea about how it works. + +Jekyll also offers powerful support for code snippets: + +{% highlight ruby %} +def print_hi(name) + puts "Hi, #{name}" +end +print_hi('Tom') +#=> prints 'Hi, Tom' to STDOUT. +{% endhighlight %} + +Check out the [Jekyll docs][jekyll-docs] for more info on how to get the most out of Jekyll. File all bugs/feature requests at [Jekyll’s GitHub repo][jekyll-gh]. If you have questions, you can ask them on [Jekyll Talk][jekyll-talk]. + +Jekyll requires blog post files to be named according to the following format: + +`YEAR-MONTH-DAY-title.MARKUP` + +Where `YEAR` is a four-digit number, `MONTH` and `DAY` are both two-digit numbers, and `MARKUP` is the file extension representing the format used in the file. After that, include the necessary front matter. Take a look at the source for this post to get an idea about how it works. + +Jekyll also offers powerful support for code snippets: + +{% highlight ruby %} +def print_hi(name) + puts "Hi, #{name}" +end +print_hi('Tom') +#=> prints 'Hi, Tom' to STDOUT. +{% endhighlight %} + Check out the [Jekyll docs][jekyll-docs] for more info on how to get the most out of Jekyll. File all bugs/feature requests at [Jekyll’s GitHub repo][jekyll-gh]. If you have questions, you can ask them on [Jekyll Talk][jekyll-talk]. [jekyll-docs]: https://jekyllrb.com/docs/home From 8fdadcb6455b412a113a4ce1f7c3c5fc2ac7416e Mon Sep 17 00:00:00 2001 From: Julian Molina Date: Sat, 18 Jan 2020 18:53:45 +0100 Subject: [PATCH 16/16] Create CNAME --- docs/CNAME | 1 + 1 file changed, 1 insertion(+) create mode 100644 docs/CNAME diff --git a/docs/CNAME b/docs/CNAME new file mode 100644 index 000000000..241b92efa --- /dev/null +++ b/docs/CNAME @@ -0,0 +1 @@ +docs.superalgos.org \ No newline at end of file