Merge branch 'master' into patch-2

Author: dobooth

.gitignore

@@ -2,6 +2,7 @@
 ######################
 /*.db
 .DS_Store
+.vscode
 
 # Config and output files #
 ###########################
@@ -10,6 +11,7 @@
 
 _config.local.yml
 .jekyll-metadata
+.whatsup.yml
 
 *.bat
 /tmp/
@@ -30,4 +32,4 @@ _algolia_api_key
 # Docs from different branches #
 ###################################
 
-/guides/v2.0/
+/guides/v2.0/

Docfile.yml

@@ -12,7 +12,7 @@ content_map:
 -
   directory: mftf
   repository: magento/magento2-functional-testing-framework
-  branch: develop
+  branch: master
   filter: true
 -
   directory: page-builder

Gemfile

@@ -4,6 +4,7 @@ source 'https://rubygems.org'
 
 gem 'devdocs', git: 'https://github.com/magento-devdocs/devdocs-theme.git'
 gem 'jekyll'
+gem 'whatsup_github'
 
 gem 'wdm', platform: :mswin
 

Gemfile.lock

@@ -1,6 +1,6 @@
 GIT
   remote: https://github.com/magento-devdocs/devdocs-theme.git
-  revision: 1c3ec18c2d5b404e5407b50d4f844ac2d0712e30
+  revision: 450a470aa4b937400190d009131fa91cf27d7a9d
   specs:
     devdocs (0.0.1)
       jekyll (>= 3.3)
@@ -31,6 +31,8 @@ GEM
       ffi (>= 1.3.0)
     eventmachine (1.2.7)
     exifr (1.3.6)
+    faraday (0.15.4)
+      multipart-post (>= 1.2, < 3)
     ffi (1.10.0)
     filesize (0.2.0)
     forwardable-extended (2.6.0)
@@ -107,8 +109,12 @@ GEM
     mercenary (0.3.6)
     mini_portile2 (2.3.0)
     minitest (5.11.3)
+    multipart-post (2.1.1)
+    netrc (0.11.0)
     nokogiri (1.8.5)
       mini_portile2 (~> 2.3.0)
+    octokit (4.14.0)
+      sawyer (~> 0.8.0, >= 0.5.3)
     parallel (1.17.0)
     pathutil (0.16.2)
       forwardable-extended (~> 2.6)
@@ -126,16 +132,26 @@ GEM
     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)
+    thor (0.20.3)
     thread_safe (0.3.6)
     typhoeus (1.3.1)
       ethon (>= 0.9.0)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
     verbal_expressions (0.1.5)
+    wdm (0.1.1)
+    whatsup_github (0.0.1)
+      netrc (~> 0.10)
+      octokit (~> 4.14)
+      thor (~> 0.20)
     yell (2.1.0)
 
 PLATFORMS
   ruby
+  x86-mswin32
 
 DEPENDENCIES
   devdocs!
@@ -151,6 +167,7 @@ DEPENDENCIES
   jekyll-titles-from-headings
   launchy
   wdm
+  whatsup_github
 
 BUNDLED WITH
    1.17.3

Rakefile

@@ -61,14 +61,11 @@ end
 desc 'Pull docs from external repositories'
 task init: %w[multirepo:init]
 
-desc 'Optimize images in modified files, or by path (rake image_optim path=path/to/dir/or/file).'
-task :image_optim do
-  path = ENV['path']
-  unless path
-    staged_files = `git ls-files --modified --others --exclude-standard`.split("\n")
-    # staged_md_files = staged_files.select { |file| File.extname(file) == '.md' }
-    abort 'Didn\'t find any modified files.'.blue if staged_files.empty?
-    path = staged_files.join(' ')
-  end
-  system "bin/image_optim --no-pngout --no-svgo --recursive #{path}"
+desc 'Run checks (image optimization).'
+task check: %w[check:image_optim] 
+
+desc 'Generate data for the weekly digest.'
+task :whatsnew do
+  print 'Generating data for the weekly digest: $ '.magenta
+  sh 'whatsup_github'
 end

_config.index.yml

@@ -0,0 +1,24 @@
+# Jekyll Algolia settings for indexing https://community.algolia.com/jekyll-algolia/options.html
+algolia:
+  files_to_exclude:
+    - guides/m1x/**/*.html
+    - guides/m1x/**/*.md
+    - swagger
+    - redoc
+  # Index HTML elements, especially code samples.
+  nodes_to_index: 'p,li,td,code'
+  # Override 10KB default and use our allowed max of 20KB
+  max_record_size: 20000
+  settings:
+    attributesForFaceting:
+      - searchable(functional_areas)
+      - searchable(guide_version)
+      - searchable(versionless)  
+
+# Disable the code blocks line numbers at indexing stage
+kramdown:
+  syntax_highlighter_opts:
+    span:
+      line_numbers: false
+    block:
+      line_numbers: false

_config.yml

@@ -74,7 +74,7 @@ defaults:
       path: mftf/docs
     values:
       group: mftf
-      github_files: https://github.com/magento/magento2-functional-testing-framework/blob/develop/
+      github_files: https://github.com/magento/magento2-functional-testing-framework/blob/master/
       github_repo: https://github.com/magento/magento2-functional-testing-framework/
       functional_areas:
         - Test
@@ -178,15 +178,6 @@ algolia:
   application_id: E642SEDTHL
   index_name: devdocs
   api_key: d2d0f33ab73e291ef8d88d8b565e754c
-  files_to_exclude:
-    - guides/m1x/**/*.html
-    - guides/m1x/**/*.md
-    - swagger
-    - redoc
-  # Index HTML elements, especially code samples.
-  nodes_to_index: 'p,li,td,code'
-  # Override 10KB default and use our allowed max of 20KB
-  max_record_size: 20000
 
 google:
   analytics: UA-66243208-1