History

Merge pull request #1533 from viq/patch-1

Update SaltStack documentation to version 3003

Simon Legner committed 5 years ago

Commit ff0ff272 parents 04828da 7c0cc5a3 files · +6 −20Browse files

Unified · Split

3 files
  1. assets/javascripts/templates/pages/about_tmpl.coffee +1 −1
  2. docs/file-scrapers.md +0 −13
  3. lib/docs/scrapers/salt_stack.rb +5 −6
assets/javascripts/templates/pages/about_tmpl.coffee+1−1
@@ -738,7 +738,7 @@ credits = [ · 737 unmodified lines
738 'https://raw.githubusercontent.com/ReactiveX/rxjs/master/LICENSE.txt'738 'https://raw.githubusercontent.com/ReactiveX/rxjs/master/LICENSE.txt'
739 ], [739 ], [
740 'Salt Stack',740 'Salt Stack',
741 '2019 SaltStack',741 '2021 SaltStack',
742 'Apache',742 'Apache',
743 'https://raw.githubusercontent.com/saltstack/salt/develop/LICENSE'743 'https://raw.githubusercontent.com/saltstack/salt/develop/LICENSE'
744 ], [744 ], [
docs/file-scrapers.md+0−13
@@ -202,19 +202,6 @@ tar -xf ruby.tar; cd ruby-$RELEASE; ./configure && make html; mv .ext/html path/ · 201 unmodified lines
202To generate the htmls file you have to run `make` command but it does not install Ruby in your system, only generates html files so you have not202To generate the htmls file you have to run `make` command but it does not install Ruby in your system, only generates html files so you have not
203to worry about cleaning or removing a new Ruby installation.203to worry about cleaning or removing a new Ruby installation.
204 204
205## Salt Stack
206
207Replace `2019.2` with the correct tag.
208
209```sh
210git clone https://github.com/saltstack/salt.git --branch 2019.2 --depth 1
211cd salt/doc
212pip install sphinx
213make html
214```
215
216The generated html is in `salt/doc/_build/html`. Copy it to
217
218## Scala205## Scala
219 206
220See `lib/docs/scrapers/scala.rb`207See `lib/docs/scrapers/scala.rb`
lib/docs/scrapers/salt_stack.rb+5−6
@@ -1,13 +1,12 @@
1module Docs1module Docs
2 # The official documentation website is heavily rate-limited2 class SaltStack < UrlScraper
3 class SaltStack < FileScraper
4 self.type = 'simple'3 self.type = 'simple'
5 self.slug = 'saltstack'4 self.slug = 'saltstack'
6 self.release = '2019.2.0'5 self.release = '3003'
7 self.base_url = 'https://docs.saltstack.com/en/latest/'6 self.base_url = 'https://docs.saltproject.io/en/latest/'
8 self.root_path = 'ref/index.html'7 self.root_path = 'ref/index.html'
9 self.links = {8 self.links = {
10 home: 'https://www.saltstack.com/',9 home: 'https://www.saltproject.io/',
11 code: 'https://github.com/saltstack/salt'10 code: 'https://github.com/saltstack/salt'
12 }11 }
13 12
@@ -17,7 +16,7 @@ module Docs · 3 unmodified lines
17 options[:container] = '.body-content > .section'16 options[:container] = '.body-content > .section'
18 17
19 options[:attribution] = <<-HTML18 options[:attribution] = <<-HTML
20 &copy; 2019 SaltStack.<br>19 &copy; 2021 SaltStack.<br>
21 Licensed under the Apache License, Version 2.0.20 Licensed under the Apache License, Version 2.0.
22 HTML21 HTML
23 22