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
738738 'https://raw.githubusercontent.com/ReactiveX/rxjs/master/LICENSE.txt'
739739 ], [
740740 'Salt Stack',
741− '2019 SaltStack',
741+ '2021 SaltStack',
742742 'Apache',
743743 'https://raw.githubusercontent.com/saltstack/salt/develop/LICENSE'
744744 ], [
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
202202 To 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
203203 to worry about cleaning or removing a new Ruby installation.
204204
205−## Salt Stack
206−
207−Replace `2019.2` with the correct tag.
208−
209−```sh
210−git clone https://github.com/saltstack/salt.git --branch 2019.2 --depth 1
211−cd salt/doc
212−pip install sphinx
213−make html
214−```
215−
216−The generated html is in `salt/doc/_build/html`. Copy it to
217−
218205 ## Scala
219206
220207 See `lib/docs/scrapers/scala.rb`
lib/docs/scrapers/salt_stack.rb+5−6
@@ -1,13 +1,12 @@
11 module Docs
2− # The official documentation website is heavily rate-limited
3− class SaltStack < FileScraper
2+ class SaltStack < UrlScraper
43 self.type = 'simple'
54 self.slug = 'saltstack'
6− self.release = '2019.2.0'
7− self.base_url = 'https://docs.saltstack.com/en/latest/'
5+ self.release = '3003'
6+ self.base_url = 'https://docs.saltproject.io/en/latest/'
87 self.root_path = 'ref/index.html'
98 self.links = {
10− home: 'https://www.saltstack.com/',
9+ home: 'https://www.saltproject.io/',
1110 code: 'https://github.com/saltstack/salt'
1211 }
1312
@@ -17,7 +16,7 @@ module Docs · 3 unmodified lines
1716 options[:container] = '.body-content > .section'
1817
1918 options[:attribution] = <<-HTML
20− &copy; 2019 SaltStack.<br>
19+ &copy; 2021 SaltStack.<br>
2120 Licensed under the Apache License, Version 2.0.
2221 HTML
2322