diff --git a/docs/diagrams/architecture.png b/docs-tmp/diagrams/architecture.png similarity index 100% rename from docs/diagrams/architecture.png rename to docs-tmp/diagrams/architecture.png diff --git a/docs/diagrams/architecture.xml b/docs-tmp/diagrams/architecture.xml similarity index 100% rename from docs/diagrams/architecture.xml rename to docs-tmp/diagrams/architecture.xml diff --git a/docs/diagrams/data-model.png b/docs-tmp/diagrams/data-model.png similarity index 100% rename from docs/diagrams/data-model.png rename to docs-tmp/diagrams/data-model.png diff --git a/docs/diagrams/data-model.xml b/docs-tmp/diagrams/data-model.xml similarity index 100% rename from docs/diagrams/data-model.xml rename to docs-tmp/diagrams/data-model.xml diff --git a/docs/diagrams/moderation-flow-post.png b/docs-tmp/diagrams/moderation-flow-post.png similarity index 100% rename from docs/diagrams/moderation-flow-post.png rename to docs-tmp/diagrams/moderation-flow-post.png diff --git a/docs/diagrams/moderation-flow-pre.png b/docs-tmp/diagrams/moderation-flow-pre.png similarity index 100% rename from docs/diagrams/moderation-flow-pre.png rename to docs-tmp/diagrams/moderation-flow-pre.png diff --git a/docs/diagrams/moderation-flow.xml b/docs-tmp/diagrams/moderation-flow.xml similarity index 100% rename from docs/diagrams/moderation-flow.xml rename to docs-tmp/diagrams/moderation-flow.xml diff --git a/docs/frontend/DEBUG.md b/docs-tmp/frontend/DEBUG.md similarity index 100% rename from docs/frontend/DEBUG.md rename to docs-tmp/frontend/DEBUG.md diff --git a/docs/frontend/HOOKS.md b/docs-tmp/frontend/HOOKS.md similarity index 100% rename from docs/frontend/HOOKS.md rename to docs-tmp/frontend/HOOKS.md diff --git a/docs/frontend/IMMUTABLEJS.md b/docs-tmp/frontend/IMMUTABLEJS.md similarity index 100% rename from docs/frontend/IMMUTABLEJS.md rename to docs-tmp/frontend/IMMUTABLEJS.md diff --git a/docs/frontend/PLUGINS-experimental.md b/docs-tmp/frontend/PLUGINS-experimental.md similarity index 100% rename from docs/frontend/PLUGINS-experimental.md rename to docs-tmp/frontend/PLUGINS-experimental.md diff --git a/docs/frontend/PLUGINS.md b/docs-tmp/frontend/PLUGINS.md similarity index 100% rename from docs/frontend/PLUGINS.md rename to docs-tmp/frontend/PLUGINS.md diff --git a/docs/frontend/README.md b/docs-tmp/frontend/README.md similarity index 100% rename from docs/frontend/README.md rename to docs-tmp/frontend/README.md diff --git a/docs/frontend/REDUX.md b/docs-tmp/frontend/REDUX.md similarity index 100% rename from docs/frontend/REDUX.md rename to docs-tmp/frontend/REDUX.md diff --git a/docs/frontend/TEST.md b/docs-tmp/frontend/TEST.md similarity index 100% rename from docs/frontend/TEST.md rename to docs-tmp/frontend/TEST.md diff --git a/docs/plugins/CLIENT.md b/docs-tmp/plugins/CLIENT.md similarity index 100% rename from docs/plugins/CLIENT.md rename to docs-tmp/plugins/CLIENT.md diff --git a/docs/plugins/EXPERIMENTAL.md b/docs-tmp/plugins/EXPERIMENTAL.md similarity index 100% rename from docs/plugins/EXPERIMENTAL.md rename to docs-tmp/plugins/EXPERIMENTAL.md diff --git a/docs/plugins/README.md b/docs-tmp/plugins/README.md similarity index 100% rename from docs/plugins/README.md rename to docs-tmp/plugins/README.md diff --git a/docs/plugins/SERVER.md b/docs-tmp/plugins/SERVER.md similarity index 100% rename from docs/plugins/SERVER.md rename to docs-tmp/plugins/SERVER.md diff --git a/docs/swagger.yaml b/docs-tmp/swagger.yaml similarity index 100% rename from docs/swagger.yaml rename to docs-tmp/swagger.yaml diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 000000000..b33f7679f --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1,6 @@ +_site/ +.sass-cache/ +.jekyll-metadata +_pdf +.idea/ +.DS_Store 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.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..b1fa52c47 --- /dev/null +++ b/docs/Dockerfile @@ -0,0 +1,26 @@ +FROM ruby:2.1 +MAINTAINER mrafayaleem@gmail.com + +RUN apt-get clean \ + && mv /var/lib/apt/lists /var/lib/apt/lists.broke \ + && mkdir -p /var/lib/apt/lists/partial + +RUN apt-get update + +RUN apt-get install -y \ + node \ + python-pygments \ + && apt-get clean \ + && rm -rf /var/lib/apt/lists/ + +WORKDIR /tmp +ADD Gemfile /tmp/ +ADD Gemfile.lock /tmp/ +RUN bundle install + +VOLUME /src +EXPOSE 4000 + +WORKDIR /src +ENTRYPOINT ["jekyll"] + diff --git a/docs/Gemfile b/docs/Gemfile new file mode 100644 index 000000000..d2e1a4527 --- /dev/null +++ b/docs/Gemfile @@ -0,0 +1,4 @@ +source "https://rubygems.org" + +gem 'github-pages', group: :jekyll_plugins +gem 'wdm', '>= 0.1.0' if Gem.win_platform? diff --git a/docs/Gemfile.lock b/docs/Gemfile.lock new file mode 100644 index 000000000..04ce5e261 --- /dev/null +++ b/docs/Gemfile.lock @@ -0,0 +1,199 @@ +GEM + remote: https://rubygems.org/ + specs: + activesupport (4.2.8) + i18n (~> 0.7) + minitest (~> 5.1) + thread_safe (~> 0.3, >= 0.3.4) + tzinfo (~> 1.1) + addressable (2.5.1) + public_suffix (~> 2.0, >= 2.0.2) + coffee-script (2.4.1) + coffee-script-source + execjs + coffee-script-source (1.12.2) + colorator (1.1.0) + ethon (0.10.1) + ffi (>= 1.3.0) + execjs (2.7.0) + faraday (0.12.1) + multipart-post (>= 1.2, < 3) + ffi (1.9.18) + forwardable-extended (2.6.0) + gemoji (3.0.0) + github-pages (138) + activesupport (= 4.2.8) + github-pages-health-check (= 1.3.3) + jekyll (= 3.4.3) + jekyll-avatar (= 0.4.2) + jekyll-coffeescript (= 1.0.1) + jekyll-default-layout (= 0.1.4) + jekyll-feed (= 0.9.2) + jekyll-gist (= 1.4.0) + jekyll-github-metadata (= 2.3.1) + jekyll-mentions (= 1.2.0) + jekyll-optional-front-matter (= 0.1.2) + jekyll-paginate (= 1.1.0) + jekyll-readme-index (= 0.1.0) + jekyll-redirect-from (= 0.12.1) + jekyll-relative-links (= 0.4.0) + jekyll-sass-converter (= 1.5.0) + jekyll-seo-tag (= 2.2.3) + jekyll-sitemap (= 1.0.0) + jekyll-swiss (= 0.4.0) + jekyll-theme-architect (= 0.0.4) + jekyll-theme-cayman (= 0.0.4) + jekyll-theme-dinky (= 0.0.4) + jekyll-theme-hacker (= 0.0.4) + jekyll-theme-leap-day (= 0.0.4) + jekyll-theme-merlot (= 0.0.4) + jekyll-theme-midnight (= 0.0.4) + jekyll-theme-minimal (= 0.0.4) + jekyll-theme-modernist (= 0.0.4) + jekyll-theme-primer (= 0.1.8) + jekyll-theme-slate (= 0.0.4) + jekyll-theme-tactile (= 0.0.4) + jekyll-theme-time-machine (= 0.0.4) + jekyll-titles-from-headings (= 0.1.5) + jemoji (= 0.8.0) + kramdown (= 1.13.2) + liquid (= 3.0.6) + listen (= 3.0.6) + mercenary (~> 0.3) + minima (= 2.1.1) + rouge (= 1.11.1) + terminal-table (~> 1.4) + github-pages-health-check (1.3.3) + addressable (~> 2.3) + net-dns (~> 0.8) + octokit (~> 4.0) + public_suffix (~> 2.0) + typhoeus (~> 0.7) + html-pipeline (2.6.0) + activesupport (>= 2) + nokogiri (>= 1.4) + i18n (0.8.1) + jekyll (3.4.3) + addressable (~> 2.4) + colorator (~> 1.0) + jekyll-sass-converter (~> 1.0) + jekyll-watch (~> 1.1) + kramdown (~> 1.3) + liquid (~> 3.0) + mercenary (~> 0.3.3) + pathutil (~> 0.9) + rouge (~> 1.7) + safe_yaml (~> 1.0) + jekyll-avatar (0.4.2) + jekyll (~> 3.0) + jekyll-coffeescript (1.0.1) + coffee-script (~> 2.2) + jekyll-default-layout (0.1.4) + jekyll (~> 3.0) + jekyll-feed (0.9.2) + jekyll (~> 3.3) + jekyll-gist (1.4.0) + octokit (~> 4.2) + jekyll-github-metadata (2.3.1) + jekyll (~> 3.1) + octokit (~> 4.0, != 4.4.0) + jekyll-mentions (1.2.0) + activesupport (~> 4.0) + html-pipeline (~> 2.3) + jekyll (~> 3.0) + jekyll-optional-front-matter (0.1.2) + jekyll (~> 3.0) + jekyll-paginate (1.1.0) + jekyll-readme-index (0.1.0) + jekyll (~> 3.0) + jekyll-redirect-from (0.12.1) + jekyll (~> 3.3) + jekyll-relative-links (0.4.0) + jekyll (~> 3.3) + jekyll-sass-converter (1.5.0) + sass (~> 3.4) + jekyll-seo-tag (2.2.3) + jekyll (~> 3.3) + jekyll-sitemap (1.0.0) + jekyll (~> 3.3) + jekyll-swiss (0.4.0) + jekyll-theme-architect (0.0.4) + jekyll (~> 3.3) + jekyll-theme-cayman (0.0.4) + jekyll (~> 3.3) + jekyll-theme-dinky (0.0.4) + jekyll (~> 3.3) + jekyll-theme-hacker (0.0.4) + jekyll (~> 3.3) + jekyll-theme-leap-day (0.0.4) + jekyll (~> 3.3) + jekyll-theme-merlot (0.0.4) + jekyll (~> 3.3) + jekyll-theme-midnight (0.0.4) + jekyll (~> 3.3) + jekyll-theme-minimal (0.0.4) + jekyll (~> 3.3) + jekyll-theme-modernist (0.0.4) + jekyll (~> 3.3) + jekyll-theme-primer (0.1.8) + jekyll (~> 3.3) + jekyll-theme-slate (0.0.4) + jekyll (~> 3.3) + jekyll-theme-tactile (0.0.4) + jekyll (~> 3.3) + jekyll-theme-time-machine (0.0.4) + jekyll (~> 3.3) + jekyll-titles-from-headings (0.1.5) + jekyll (~> 3.3) + jekyll-watch (1.5.0) + listen (~> 3.0, < 3.1) + jemoji (0.8.0) + activesupport (~> 4.0) + gemoji (~> 3.0) + html-pipeline (~> 2.2) + jekyll (>= 3.0) + kramdown (1.13.2) + liquid (3.0.6) + listen (3.0.6) + rb-fsevent (>= 0.9.3) + rb-inotify (>= 0.9.7) + mercenary (0.3.6) + mini_portile2 (2.1.0) + minima (2.1.1) + jekyll (~> 3.3) + minitest (5.10.2) + multipart-post (2.0.0) + net-dns (0.8.0) + nokogiri (1.6.8.1) + mini_portile2 (~> 2.1.0) + octokit (4.7.0) + sawyer (~> 0.8.0, >= 0.5.3) + pathutil (0.14.0) + forwardable-extended (~> 2.6) + public_suffix (2.0.5) + rb-fsevent (0.9.8) + rb-inotify (0.9.8) + ffi (>= 0.5.0) + rouge (1.11.1) + safe_yaml (1.0.4) + sass (3.4.24) + sawyer (0.8.1) + addressable (>= 2.3.5, < 2.6) + faraday (~> 0.8, < 1.0) + terminal-table (1.8.0) + unicode-display_width (~> 1.1, >= 1.1.1) + thread_safe (0.3.6) + typhoeus (0.8.0) + ethon (>= 0.8.0) + tzinfo (1.2.3) + thread_safe (~> 0.1) + unicode-display_width (1.2.1) + +PLATFORMS + ruby + +DEPENDENCIES + github-pages + +BUNDLED WITH + 1.15.0 diff --git a/docs/_config.yml b/docs/_config.yml new file mode 100644 index 000000000..96ae10d52 --- /dev/null +++ b/docs/_config.yml @@ -0,0 +1,102 @@ +repository: coralproject/talk + +output: web +# this property is useful for conditional filtering of content that is separate from the PDF. + +topnav_title: Coral Talk Documentation +# this appears on the top navigation bar next to the home button + +site_title: Coral Talk Documentation +# this appears in the html browser tab for the site title (seen mostly by search engines, not users) + +company_name: The Coral Project +# 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. + +disqus_shortname: +# if you're using disqus for comments, add the shortname here. if not, leave this value 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 +# 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: "http://helpy.io/" +# 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: true + search: true + sidebar: talk_sidebar + - + scope: + path: "" + type: "tooltips" + values: + layout: "page" + comments: true + search: true + tooltip: true + + - + scope: + path: "" + type: "posts" + values: + layout: "post" + comments: true + search: true + sidebar: home_sidebar + +# these are defaults used for the frontmatter for these file types + +sidebars: +- talk_sidebar + +description: "Documentation and guides for Coral Talk." +# the description is used in the feed.xml file + +# needed for sitemap.xml file only +url: https://coralproject.github.io/talk/ 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: '