[devdocsgjs/main: 1/76] Update Docker documentation (20.10.6)
- From: Andy Holmes <andyholmes src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [devdocsgjs/main: 1/76] Update Docker documentation (20.10.6)
- Date: Fri, 15 Jul 2022 21:39:45 +0000 (UTC)
commit 451ba37ef743c039b623be4f4ee4faa90205d339
Author: Enoc <brianhernandez222 hotmail com>
Date: Sun Jun 6 17:55:10 2021 -0600
Update Docker documentation (20.10.6)
lib/docs/filters/docker/clean_html_old.rb | 37 ----
lib/docs/filters/docker/clean_html_very_old.rb | 22 ---
lib/docs/filters/docker/entries.rb | 20 +-
lib/docs/filters/docker/entries_old.rb | 75 --------
lib/docs/filters/docker/entries_very_old.rb | 56 ------
lib/docs/scrapers/docker.rb | 252 +++++--------------------
6 files changed, 43 insertions(+), 419 deletions(-)
---
diff --git a/lib/docs/filters/docker/entries.rb b/lib/docs/filters/docker/entries.rb
index 63285e0c..d6a3c76f 100644
--- a/lib/docs/filters/docker/entries.rb
+++ b/lib/docs/filters/docker/entries.rb
@@ -10,20 +10,7 @@ module Docs
def get_name
return NAME_BY_SUBPATH[subpath] if NAME_BY_SUBPATH[subpath]
- return at_css('h1').content unless nav_link
-
- name = nav_link.content.strip
- name.capitalize! if name == 'exoscale'
- name.remove! ' (base command)'
-
- if name =~ /\A[a-z\-\s]+\z/
- name.prepend 'docker-compose ' if subpath =~ /compose\/reference\/./
- name.prepend 'docker-machine ' if subpath =~ /machine\/reference\/./
- else
- name << " (#{product})" if name !~ /#{product}/i && !subpath.start_with?('get-started')
- end
-
- name
+ at_css('h1').content
end
def get_type
@@ -37,11 +24,6 @@ module Docs
product
end
- def nav_link
- return @nav_link if defined?(@nav_link)
- @nav_link = at_css('.currentPage')
- end
-
def product
@product ||= subpath.split('/').first.capitalize
end
diff --git a/lib/docs/scrapers/docker.rb b/lib/docs/scrapers/docker.rb
index 6328644b..ce481b3d 100644
--- a/lib/docs/scrapers/docker.rb
+++ b/lib/docs/scrapers/docker.rb
@@ -1,11 +1,31 @@
module Docs
class Docker < UrlScraper
+ include MultipleBaseUrls
+
+ self.name = 'Docker'
self.type = 'simple'
+ self.release = '20.10.6'
+
+ self.base_urls = [
+ 'https://docs.docker.com/',
+ 'https://docs.docker.com/machine/'
+ ]
+
self.links = {
home: 'https://docker.com/',
code: 'https://github.com/docker/docker'
}
+ html_filters.push 'docker/entries', 'docker/clean_html'
+
+ options[:only_patterns] = [/\Aget-started\//, /\Aengine\//, /\Acompose\//, /\Amachine\//, /\Anotary\//]
+
+ options[:skip_patterns] = [/\Aengine\/api\/v/, /glossary/, /docker-ee/]
+
+ options[:skip] = [
+ 'engine/userguide/networking/get-started-overlay/'
+ ]
+
options[:trailing_slash] = true
options[:fix_urls] = ->(url) do
@@ -21,242 +41,54 @@ module Docs
Docker, Inc. and other parties may also have trademark rights in other terms used herein.
HTML
+ options[:replace_paths] = {
+ 'engine/userguide/' => 'config/daemon',
+ 'engine/userguide/labels-custom-metadata/' => 'config',
+ 'engine/swarm/networking/' => 'network/overlay',
+ 'engine/userguide/eng-image/dockerfile_best-practices/' =>
'develop/develop-images/dockerfile_best-practices/',
+ 'engine/userguide/networking/get-started-overlay/' => 'network/network-tutorial-overlay/',
+ 'engine/userguide/networking/' => 'network/',
+ 'engine/reference/api/' => 'develop/sdk',
+ 'engine/api/latest/' => 'develop/sdk',
+ 'get-started/part3/' => 'get-started/04_sharing_app/',
+ 'engine/security/https/' => 'engine/security/protect-access/',
+ 'compose/aspnet-mssql-compose/' => 'samples/aspnet-mssql-compose/',
+ 'engine/examples/dotnetcore/' => 'samples/dotnetcore/'
+ }
+
version '19' do
self.release = '19.03'
- self.base_url = "https://docs.docker.com/"
-
- html_filters.push 'docker/entries', 'docker/clean_html'
-
- options[:container] = '.wrapper .container-fluid .row'
-
- options[:only_patterns] = [/\Aget-started\//, /\Aengine\//, /\Acompose\//, /\Amachine\//, /\Anotary\//]
- options[:skip_patterns] = [/\Aengine\/api\/v/, /glossary/, /docker-ee/]
-
- options[:replace_paths] = {
- 'install/linux/ubuntu/' => 'install/linux/docker-ce',
- 'get-started/part1' => 'get-started',
- 'engine/installation/' => 'install',
- 'engine/installation/linux/linux-postinstall/' => 'install/linux',
- 'compose/overview/' => 'compose',
- 'docker-cloud/' => 'docker-hub',
- 'datacenter/install/linux/' => 'ee',
- 'engine/userguide/' => 'config/daemon',
- 'engine/admin/' => 'config/daemon',
- 'opensource/get-help/' => 'opensource',
- 'engine/tutorials/dockerimages/' => 'get-started',
- 'engine/admin/volumes/bind-mounts/' => 'storage',
- 'engine/tutorials/dockervolumes/' => 'storage',
- 'engine/admin/volumes/volumes/' => 'storage',
- 'engine/userguide/labels-custom-metadata/' => 'config',
- 'engine/userguide/eng-image/multistage-build/' => 'develop/develop-images',
- 'engine/swarm/networking/' => 'network',
- 'engine/admin/resource_constraints/' => 'config/containers',
- 'engine/admin/logging/overview/' => 'config/containers/logging',
- 'engine/userguide/eng-image/dockerfile_best-practices/' => 'develop/develop-images',
- 'engine/tutorials/dockerrepos/' => 'get-started',
- 'engine/userguide/networking/' => 'network',
- 'engine/userguide/networking/get-started-overlay/' => 'network',
- 'engine/reference/commandline/swarm_join_token/' => 'engine/reference/commandline',
- 'engine/understanding-docker/' => 'engine',
- 'engine/userguide/dockervolumes/' => 'storage',
- 'engine/installation/binaries/' => 'install/linux/docker-ce',
- 'engine/userguide/networking/default_network/dockerlinks/' => 'network',
- 'engine/reference/api/' => 'develop/sdk',
- 'engine/admin/systemd/' => 'config/daemon',
- 'engine/userguide/storagedriver/imagesandcontainers/' => 'storage/storagedriver',
- 'engine/api/' => 'develop/sdk',
- 'engine/userguide/networking/get-started-overlay' => 'network',
- 'engine/userguide/networking/overlay-security-model/' => 'network',
- 'engine/installation/linux/docker-ce/binaries/' => 'install/linux/docker-ce',
- 'engine/admin/volumes/' => 'storage/volumes/',
- 'engine/userguide/networking//' => 'network',
- 'engine/reference/commandline' => 'engine/reference/commandline/docker',
- 'engine/reference/commandline/' => 'engine/reference/commandline/docker/',
- }
+ self.base_url = "https://docs.docker.com"
end
version '18' do
self.release = '18.09'
- self.base_url = "https://docs.docker.com/v#{release}/"
-
- html_filters.push 'docker/entries', 'docker/clean_html'
-
- options[:container] = '.wrapper .container-fluid .row'
-
- options[:only_patterns] = [/\Aget-started\//, /\Aengine\//, /\Acompose\//, /\Amachine\//, /\Anotary\//]
- options[:skip_patterns] = [/\Aengine\/api\/v/, /glossary/, /docker-ee/]
-
- options[:replace_paths] = {
- 'install/linux/ubuntu/' => 'install/linux/docker-ce',
- 'get-started/part1' => 'get-started',
- 'engine/installation/' => 'install',
- 'engine/installation/linux/linux-postinstall/' => 'install/linux',
- 'compose/overview/' => 'compose',
- 'datacenter/install/linux/' => 'ee',
- 'engine/userguide/' => 'config/daemon',
- 'engine/admin/' => 'config/daemon',
- 'opensource/get-help/' => 'opensource',
- 'engine/tutorials/dockerimages/' => 'get-started',
- 'engine/admin/volumes/bind-mounts/' => 'storage',
- 'engine/tutorials/dockervolumes/' => 'storage',
- 'engine/admin/volumes/volumes/' => 'storage',
- 'engine/userguide/labels-custom-metadata/' => 'config',
- 'engine/reference/api/' => 'develop/sdk',
- 'engine/userguide/eng-image/multistage-build/' => 'develop/develop-images',
- 'engine/swarm/networking/' => 'network',
- 'engine/admin/resource_constraints/' => 'config/containers',
- 'engine/admin/logging/overview/' => 'config/containers/logging',
- 'engine/userguide/eng-image/dockerfile_best-practices/' => 'develop/develop-images',
- 'engine/tutorials/dockerrepos/' => 'get-started',
- 'engine/userguide/networking/' => 'network',
- 'engine/userguide/networking/get-started-overlay/' => 'network',
- 'engine/understanding-docker/' => 'engine',
- 'engine/reference/commandline/swarm_join_token/' => 'engine/reference/commandline',
- 'engine/userguide/dockervolumes/' => 'storage',
- 'engine/admin/systemd/' => 'config/daemon',
- 'engine/userguide/storagedriver/imagesandcontainers/' => 'storage/storagedriver',
- 'engine/installation/binaries/' => 'install/linux/docker-ce',
- 'engine/userguide/networking/default_network/dockerlinks/' => 'network',
- 'engine/userguide/networking/overlay-security-model/' => 'network',
- 'engine/userguide/networking/get-started-overlay' => 'network',
- 'engine/api/' => 'develop/sdk',
- 'engine/installation/linux/docker-ce/binaries/' => 'install/linux/docker-ce',
- 'engine/admin/volumes/' => 'storage/volumes/',
- 'engine/userguide/networking//' => 'network',
- 'engine/reference/commandline' => 'engine/reference/commandline/docker',
- 'engine/reference/commandline/' => 'engine/reference/commandline/docker/',
- }
+ self.base_url = "https://docs.docker.com"
end
version '17' do
self.release = '17.12'
- self.base_url = "https://docs.docker.com/v#{release}/"
-
- html_filters.push 'docker/entries', 'docker/clean_html'
-
- options[:container] = '.wrapper .container-fluid .row'
-
- options[:only_patterns] = [/\Aget-started\//, /\Aengine\//, /\Acompose\//, /\Amachine\//, /\Anotary\//]
- options[:skip_patterns] = [/\Aengine\/api\/v/, /glossary/, /docker-ee/]
-
- options[:replace_paths] = {
- 'get-started/part1' => 'get-started',
- 'engine/installation/' => 'install',
- 'engine/installation/linux/linux-postinstall/' => 'install/linux',
- 'opensource/get-help/' => 'opensource',
- 'engine/admin/volumes/volumes/' => 'storage',
- 'engine/tutorials/dockerimages/' => 'get-started',
- 'engine/admin/volumes/bind-mounts/' => 'storage',
- 'engine/tutorials/dockervolumes/' => 'storage',
- 'datacenter/install/aws/' => 'docker-for-aws',
- 'engine/userguide/' => 'config/daemon',
- 'engine/admin/' => 'config/daemon',
- 'engine/userguide/labels-custom-metadata/' => 'config',
- 'engine/userguide/eng-image/multistage-build/' => 'develop/develop-images',
- 'engine/swarm/networking/' => 'network',
- 'engine/admin/resource_constraints/' => 'config/containers',
- 'engine/admin/logging/overview/' => 'config/containers/logging',
- 'engine/understanding-docker/' => 'engine',
- 'engine/userguide/eng-image/dockerfile_best-practices/' => 'develop/develop-images',
- 'engine/tutorials/dockerrepos/' => 'get-started',
- 'engine/userguide/networking/' => 'network',
- 'engine/reference/commandline/swarm_join_token/' => 'edge/engine/reference/commandline',
- 'engine/userguide/networking/get-started-overlay/' => 'network',
- 'engine/userguide/dockervolumes/' => 'storage',
- 'engine/installation/binaries/' => 'install/linux/docker-ce',
- 'engine/userguide/networking/default_network/dockerlinks/' => 'network',
- 'engine/reference/api/' => 'develop/sdk',
- 'engine/admin/live-restore/' => 'config/containers',
- 'engine/api/' => 'develop/sdk',
- 'engine/userguide/networking/get-started-overlay' => 'network',
- 'security/security/' => 'engine/security',
- 'engine/installation/linux/docker-ce/binaries/' => 'install/linux/docker-ce',
- 'engine/reference/commandline/' => 'edge/engine/reference/commandline',
- 'engine/admin/systemd/' => 'config/daemon',
- 'engine/userguide/storagedriver/imagesandcontainers/' => 'storage/storagedriver',
- 'engine/userguide/networking/overlay-security-model/' => 'network',
- 'engine/admin/volumes/' => 'storage/volumes/',
- 'engine/userguide/networking//' => 'network',
- }
- end
-
- module OldOptions
- def self.included(klass)
- klass.options[:only_patterns] = [/\Aengine\//, /\Acompose\//, /\Amachine\//]
- klass.options[:skip_patterns] = [/\Aengine\/api\/v/, /\Aengine\/installation/]
- klass.options[:skip] = %w(
- /
- engine/userguide/
- engine/examples/
- engine/reference/
- engine/reference/api/
- engine/reference/api/docker_remote_api_v1.24/
- engine/getstarted/linux_install_help/
- machine/reference/
- machine/drivers/
- machine/examples/
- compose/reference/
- )
- klass.options[:replace_paths] = {
- 'engine/userguide/networking/dockernetworks/' => 'engine/userguide/networking/',
- 'engine/userguide/dockervolumes/' => 'engine/tutorials/dockervolumes/',
- 'engine/reference/logging/overview/' => 'engine/admin/logging/overview/',
- 'engine/reference/commandline/daemon/' => 'engine/reference/commandline/dockerd/',
- 'engine/reference/commandline/' => 'engine/reference/commandline/docker/',
- 'engine/reference/api/docker_remote_api/' => 'engine/api/',
- 'engine/swarm/how-swarm-mode-works/' => 'engine/swarm/how-swarm-mode-works/nodes/',
- 'engine/tutorials/dockerizing/' => 'engine/getstarted/step_one/',
- 'engine/tutorials/usingdocker/' => 'engine/getstarted/step_three/',
- 'engine/tutorials/dockerimages/' => 'engine/getstarted/step_four/',
- 'engine/tutorials/dockerrepos/' => 'engine/getstarted/step_six/'
- }
- end
+ self.base_url = "https://docs.docker.com"
end
version '1.13' do
- include OldOptions
-
self.release = '1.13'
- self.base_url = "https://docs.docker.com/v#{self.version}/"
-
- html_filters.push 'docker/entries_old', 'docker/clean_html_old'
-
- options[:container] = '.container-fluid .row'
+ self.base_url = "https://docs.docker.com"
end
version '1.12' do
- include OldOptions
-
self.release = '1.12'
- self.base_url = "https://docs.docker.com/v#{self.version}/"
-
- html_filters.push 'docker/entries_old', 'docker/clean_html_old'
-
- options[:container] = '.container-fluid .row'
+ self.base_url = "https://docs.docker.com"
end
version '1.11' do
- include OldOptions
-
self.release = '1.11'
- self.base_url = "https://docs.docker.com/v#{self.version}/"
-
- html_filters.push 'docker/entries_very_old', 'docker/clean_html_very_old'
-
- options[:container] = '#docs'
- options[:only_patterns] << /\Aswarm\//
+ self.base_url = "https://docs.docker.com"
end
version '1.10' do
- include OldOptions
-
self.release = '1.10'
- self.base_url = "https://docs.docker.com/v#{self.version}/"
-
- html_filters.push 'docker/entries_very_old', 'docker/clean_html_very_old'
-
- options[:container] = '#docs'
- options[:only_patterns] << /\Aswarm\//
+ self.base_url = "https://docs.docker.com"
end
def get_latest_version(opts)
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]