diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7ca941931..3876b0c4b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,7 +2,7 @@ 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. +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, to be deployed in the near future. 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. @@ -10,13 +10,13 @@ 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. The app runs uncompilled on the actual code. +First step is to fork this repository and start using the app. The repository includes all source code which constitutes your development environment. 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, learning, 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. -* Additionally, you may contribute helping improve the README and building the documentation in each of the repositories involved. +* Another top priority is building a robust base of indicators and technical studies. This is done from the UI, using the functionality managed by data mines. 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. diff --git a/README.md b/README.md index 0928d9827..5525a9587 100644 --- a/README.md +++ b/README.md @@ -4,15 +4,21 @@ The Superalgos Platform provides a visual environment for developing, testing an ![Illustration](https://user-images.githubusercontent.com/13994516/63528460-4550ae80-c503-11e9-8db6-22995e0b9c16.gif) -## Users Manual +## Documentation -Visit the [Users Manual](https://github.com/Superalgos/Platform/wiki) for instructions on how to download, install, fire up and use the app. +The [Users Manual](https://github.com/Superalgos/Platform/wiki) in this repository's wiki features the documentation corresponding to the latest release. -## Code and Development Environment +The ```docs``` folder in this branch features the source files for a new [Jekyll](https://jekyllrb.com/) documentation site to be deployed along with the next release. The new version of the documentation is undergoing a massive restructuring, therefore, it may currently be inconsistent or hard to follow. -The Superalgos Platform draws code from several repositories within the Superalgos Github organization, as well as from organizations belonging to Teams. +To deploy the new documentation site in your local machine, run [Jekyll](https://jekyllrb.com/docs/) from the ```docs``` folder. -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. +## Codebase and Development Environment + +To build each release, the Superalgos Platform used to draw code from several repositories within the Superalgos Github organization, as well as from organizations belonging to Teams. This has changed. + +The ```develop``` branch in this repository now features the latest codebase and development environment. + +The codebase is distributed with the platform's release, and constitutes a fully functional development environment right out of the package. The platform runs uncompilled on the actual code (```node run``` from the root folder). ## Contributing diff --git a/docs/.gitignore b/docs/.gitignore index f40fbd8ba..c46da9a7b 100644 --- a/docs/.gitignore +++ b/docs/.gitignore @@ -1,5 +1,8 @@ -_site -.sass-cache -.jekyll-cache +_site/ +.sass-cache/ .jekyll-metadata -vendor +_pdf +.DS_Store +.idea +vendor/ +.bundle/ diff --git a/docs/.gitlab-ci.yml b/docs/.gitlab-ci.yml new file mode 100644 index 000000000..7167efd52 --- /dev/null +++ b/docs/.gitlab-ci.yml @@ -0,0 +1,26 @@ +image: ruby:2.3 + +variables: + JEKYLL_ENV: production + +test: + stage: test + script: + - sh ./var/build.sh + - bundle exec jekyll build -d test + artifacts: + paths: + - test + except: + - master + +pages: + stage: deploy + script: + - sh ./var/build.sh + - bundle exec jekyll build -d public + artifacts: + paths: + - public + only: + - master diff --git a/docs/.vscode/settings.json b/docs/.vscode/settings.json new file mode 100644 index 000000000..5af001d55 --- /dev/null +++ b/docs/.vscode/settings.json @@ -0,0 +1,6 @@ +// Place your settings in this file to overwrite default and user settings. +{ + "files.associations": { + "*.html": "liquid" + } +} diff --git a/docs/404.html b/docs/404.html deleted file mode 100644 index 086a5c9ea..000000000 --- a/docs/404.html +++ /dev/null @@ -1,25 +0,0 @@ ---- -permalink: /404.html -layout: default ---- - - - -
-

404

- -

Page not found :(

-

The requested page could not be found.

-
diff --git a/docs/404.md b/docs/404.md new file mode 100644 index 000000000..a7b58c002 --- /dev/null +++ b/docs/404.md @@ -0,0 +1,6 @@ +--- +title: "Page Not Found" +search: exclude +--- + +Sorry, but the page you were trying to view does not exist. Try searching for it or looking at the URL to see if it looks correct. diff --git a/docs/Dockerfile b/docs/Dockerfile new file mode 100644 index 000000000..7eed201a6 --- /dev/null +++ b/docs/Dockerfile @@ -0,0 +1,14 @@ +FROM jekyll/builder + +WORKDIR /tmp +ADD Gemfile /tmp/ +ADD Gemfile.lock /tmp/ +RUN bundle install + +FROM jekyll/jekyll + +VOLUME /src +EXPOSE 4000 + +WORKDIR /src +ENTRYPOINT ["jekyll", "serve", "--livereload", "-H", "0.0.0.0"] diff --git a/docs/Gemfile b/docs/Gemfile index 6dc48a17e..515633aa3 100644 --- a/docs/Gemfile +++ b/docs/Gemfile @@ -1,30 +1,7 @@ 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? +# to publish on github page +gem 'github-pages', group: :jekyll_plugins +# to publich without github page +#gem "jekyll" diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock index 6bdc330bc..dd64253d1 100644 --- a/docs/Gemfile.lock +++ b/docs/Gemfile.lock @@ -24,10 +24,12 @@ GEM http_parser.rb (~> 0.6.0) ethon (0.12.0) ffi (>= 1.3.0) + eventmachine (1.2.7) eventmachine (1.2.7-x64-mingw32) execjs (2.7.0) faraday (1.0.0) multipart-post (>= 1.2, < 3) + ffi (1.12.1) ffi (1.12.1-x64-mingw32) forwardable-extended (2.6.0) gemoji (3.0.1) @@ -204,6 +206,8 @@ GEM jekyll-seo-tag (~> 2.1) minitest (5.14.0) multipart-post (2.1.1) + nokogiri (1.10.7) + mini_portile2 (~> 2.4.0) nokogiri (1.10.7-x64-mingw32) mini_portile2 (~> 2.4.0) octokit (4.15.0) @@ -235,22 +239,15 @@ GEM 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 + ruby x64-mingw32 DEPENDENCIES - github-pages (~> 203) - jekyll-feed (~> 0.12) - minima (~> 2.5) - tzinfo (~> 1.2) - tzinfo-data - wdm (~> 0.1.1) + github-pages BUNDLED WITH 2.1.4 diff --git a/docs/_config.yml b/docs/_config.yml index 60e14aa77..a198aa663 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -1,55 +1,121 @@ -# 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 }}. +repository: tomjoht/documentation-theme-jekyll -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 +output: web +# this property is useful for conditional filtering of content that is separate from the PDF. -# Build settings -theme: minima -plugins: - - jekyll-feed +topnav_title: Superalgos Documentation +# this appears on the top navigation bar next to the home button -# 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/ +site_title: Superalgos Crypto Intelligence Suite Documentation +# this appears in the html browser tab for the site title (seen mostly by search engines, not users) + +company_name: Superalgos.org +# this appears in the footer + +github_editme_path: +# if you're using Github, provide the basepath to the branch you've created for reviews, following the sample here. if not, leave this value blank. + +# gitlab_editme_path: tomjoht/documentation-theme-jekyll/blob/gh-pages/ +# if you're using GitLab, provide the basepath to the branch you've created for reviews, following the sample here. if not, leave this value blank. + +google_analytics: UA-121623442-1 +# if you have google-analytics ID, put it in. if not, edit this value to blank. + +host: 127.0.0.1 +# the preview server used. Leave as is. + +port: 4000 +# the port where the preview is rendered. You can leave this as is unless you have other Jekyll builds using this same port that might cause conflicts. in that case, use another port such as 4006. + +exclude: + - .idea/ + - .gitignore + - vendor +# these are the files and directories that jekyll will exclude from the build + +feedback_subject_line: + +feedback_email: +# used as a contact email for the Feedback link in the top navigation bar + +# feedback_disable: true +# if you uncomment the previous line, the Feedback link gets removed + +feedback_text: "Need help?" +# if you uncomment the previous line, it changes the Feedback text + +feedback_link: "https://t.me/superalgoscommunity" +# if you uncomment the previous line, it changes where the feedback link points to + +highlighter: rouge +# library used for syntax highlighting + +markdown: kramdown +kramdown: + input: GFM + auto_ids: true + hard_wrap: false + syntax_highlighter: rouge + +# filter used to process markdown. note that kramdown differs from github-flavored markdown in some subtle ways + +collections: + tooltips: + output: false +# collections are declared here. this renders the content in _tooltips and processes it, but doesn't output it as actual files in the output unless you change output to true + +defaults: + - + scope: + path: "" + type: "pages" + values: + layout: "page" + comments: false + # if you don't want to use Commento.io and just hide comments, change true to false wherever you see the comments property + search: true + sidebar: home_sidebar + topnav: topnav + - + scope: + path: "" + type: "tooltips" + values: + layout: "page" + search: true + tooltip: true + + - + scope: + path: "" + type: "posts" + values: + layout: "post" + comments: false + # if you don't want to use Commento.io and just hide comments, change true to false wherever you see the comments property + search: true + sidebar: home_sidebar + topnav: topnav + +# these are defaults used for the frontmatter for these file types + +sidebars: +- mydoc_sidebar +- suite_sidebar +- syst_sidebar +- algo_sidebar +- disc_sidebar +- smart_sidebar +- coach_sidebar +- market_sidebar +- mine_sidebar + +description: "The Superalgos Suite Documentation covers general workings of the Superalgos Platform and of each of the products in the suite." +# the description is used in the feed.xml file + +# needed for sitemap.xml file only +# url: http://idratherbewriting.com +# baseurl: /documentation-theme-jekyll + + +github: [metadata] diff --git a/docs/_data/alerts.yml b/docs/_data/alerts.yml new file mode 100644 index 000000000..157e1622b --- /dev/null +++ b/docs/_data/alerts.yml @@ -0,0 +1,15 @@ +tip: '