Removing snapshot builds from doc cookbook and updating text to refer to new make doc target

David Wrede · David Wrede · commit 140b7e819c25 · 2016-12-17T14:29:38.000-08:00
Signed-off-by: David Wrede &lt;dwrede@chef.io&gt;
diff --git a/.travis.yml b/.travis.yml
@@ -9,4 +9,4 @@ python:
 install: 
   - "pip install -r requirements.txt"
 # command to run tests
-script: make master
+script: make docs
diff --git a/CONTRIBUTING b/CONTRIBUTING
@@ -5,7 +5,7 @@
 chef-docs hopes that the documentation is always just what you are looking for, but when that isn't the case chef-docs does appreciate feedback. There are several ways to get feedback to chef-docs:
 
 * Email --- Send an email to docs@chef.io for documentation bugs, ideas, thoughts, and suggestions. Typos and little errors and quick fixes will be fixed quickly and without fuss. This email address is not a support email address, however. If you need support for Chef, contact CHEF support.
-* Pull request -- The documentation repository is on GitHub: https://github.com/chef/chef-docs. DCO sign-off is not required to submit pull requests to this repo. If you are wondering what is going on in that repository, in terms of structure and what-goes-where, send an email to docs@chef.io.
+* Pull request -- The documentation repository is on GitHub: https://github.com/chef/chef-web-docs. DCO sign-off is not required to submit pull requests to this repo. If you are wondering what is going on in that repository, in terms of structure and what-goes-where, send an email to docs@chef.io.
 * https://discourse.chef.io/ --- chef-docs follows this mailing list. Improvements to the documentation are made because of conversations that happen on this mailing list. That said, relying solely on the mailing list is the least effective way to get feedback to chef-docs (because there is no guarantee that chef-docs will see any particular message).
 
 Thanks in advance for any feedback you choose to send.
diff --git a/Makefile b/Makefile
@@ -1,50 +1,8 @@
 BUILDDIR = build
-S3BUCKET = chef-docs
-S3OPTIONS = --acl-public --exclude='.doctrees/*' --exclude='chef/.doctrees/*' --config ~/.s3cfg-chef-docs  --add-header "Cache-Control: max-age=900"
 BUILD_COMMAND = sphinx-build -a -W
-PARALLEL_BUILD:=
-BUILD_COMMAND_AND_ARGS = $(BUILD_COMMAND) $(PARALLEL_BUILD)
+BUILD_COMMAND_AND_ARGS = $(BUILD_COMMAND)
 
-# was the first option after S3OPTIONS
-# --delete-removed
-
-
-#
-# SAVED FOR HISTORY PURPOSES
-# This is the old mapping of the makefile for what should be built, not built
-# Add after `release:` the builds to build; everything else underneath commented out
-#
-# release: master 12-5 decks
-#
-#
-# OTHER BUILDS -- REMOVED FOR THE MOMENT AND ONLY REBUILD AD HOC
-# devkit analytics_1-1 delivery
-#
-# 11-0 11-2 11-4 11-6 11-8 11-10 11-12 11-14 11-16 11-18
-# 12-0 12-1 12-2 12-3 12-4
-# ohai-6 ohai-7 ohai-8
-# push_1-0
-# server_12-0 server_12-1 server_12-2
-# oec_11-0 oec_11-1 oec_11-2
-# osc_11-0 osc_11-1
-#
-# RETIRED: located in chef-docs-misc, no longer built or maintained
-# enterprise open_source slides
-# 10 private_chef
-# all analytics delivery client devkit server
-#
-
-#
-# Parallel Building:
-# Supported by Sphinx 1.2.x and above
-#
-# Specify PARALLEL_BUILD="-j X" on the make cmdline
-# If you have an 8 cpu machine, 6 might be a good number
-#
-# make master PARALLEL_BUILD="-j 6"
-#
-
-master:
+docs:
 	mkdir -p $(BUILDDIR)
 	cp -r misc/robots.txt build/
 	cp -r misc/sitemap.xml build/
@@ -54,214 +12,3 @@ master:
 
 clean:
 	@rm -rf $(BUILDDIR)
-
-decks:
-	mkdir -p $(BUILDDIR)/decks/
-	$(BUILD_COMMAND_AND_ARGS) snapshots/slide_decks/source $(BUILDDIR)/decks/
-
-automate:
-	mkdir -p $(BUILDDIR)/release/automate/
-	$(BUILD_COMMAND_AND_ARGS) snapshots/release_automate/source $(BUILDDIR)/release/automate/
-
-compliance:
-	mkdir -p $(BUILDDIR)/release/compliance/
-	$(BUILD_COMMAND_AND_ARGS) snapshots/release_compliance/source $(BUILDDIR)/release/compliance/
-
-11-0:
-	mkdir -p $(BUILDDIR)/release/11-0/
-	$(BUILD_COMMAND_AND_ARGS) snapshots/release_chef_11-0/source $(BUILDDIR)/release/11-0/
-
-11-2:
-	mkdir -p $(BUILDDIR)/release/11-2/
-	$(BUILD_COMMAND_AND_ARGS) snapshots/release_chef_11-2/source $(BUILDDIR)/release/11-2/
-
-11-4:
-	mkdir -p $(BUILDDIR)/release/11-4/
-	$(BUILD_COMMAND_AND_ARGS) snapshots/release_chef_11-4/source $(BUILDDIR)/release/11-4/
-
-11-6:
-	mkdir -p $(BUILDDIR)/release/11-6/
-	$(BUILD_COMMAND_AND_ARGS) snapshots/release_chef_11-6/source $(BUILDDIR)/release/11-6/
-
-11-8:
-	mkdir -p $(BUILDDIR)/release/11-8/
-	$(BUILD_COMMAND_AND_ARGS) snapshots/release_chef_11-8/source $(BUILDDIR)/release/11-8/
-
-11-10:
-	mkdir -p $(BUILDDIR)/release/11-10/
-	$(BUILD_COMMAND_AND_ARGS) snapshots/release_chef_11-10/source $(BUILDDIR)/release/11-10/
-
-11-12:
-	mkdir -p $(BUILDDIR)/release/11-12/
-	$(BUILD_COMMAND_AND_ARGS) snapshots/release_chef_11-12/source $(BUILDDIR)/release/11-12/
-
-11-14:
-	mkdir -p $(BUILDDIR)/release/11-14/
-	$(BUILD_COMMAND_AND_ARGS) snapshots/release_chef_11-14/source $(BUILDDIR)/release/11-14/
-
-11-16:
-	mkdir -p $(BUILDDIR)/release/11-16/
-	$(BUILD_COMMAND_AND_ARGS) snapshots/release_chef_11-16/source $(BUILDDIR)/release/11-16/
-
-11-18:
-	mkdir -p $(BUILDDIR)/release/11-18/
-	$(BUILD_COMMAND_AND_ARGS) snapshots/release_chef_11-18/source $(BUILDDIR)/release/11-18/
-
-12-0:
-	mkdir -p $(BUILDDIR)/release/12-0/
-	$(BUILD_COMMAND_AND_ARGS) snapshots/release_chef_12-0/source $(BUILDDIR)/release/12-0/
-
-12-1:
-	mkdir -p $(BUILDDIR)/release/12-1/
-	$(BUILD_COMMAND_AND_ARGS) snapshots/release_chef_12-1/source $(BUILDDIR)/release/12-1/
-
-12-2:
-	mkdir -p $(BUILDDIR)/release/12-2/
-	$(BUILD_COMMAND_AND_ARGS) snapshots/release_chef_12-2/source $(BUILDDIR)/release/12-2/
-
-12-3:
-	mkdir -p $(BUILDDIR)/release/12-3/
-	$(BUILD_COMMAND_AND_ARGS) snapshots/release_chef_12-3/source $(BUILDDIR)/release/12-3/
-
-12-4:
-	mkdir -p $(BUILDDIR)/release/12-4/
-	$(BUILD_COMMAND_AND_ARGS) snapshots/release_chef_12-4/source $(BUILDDIR)/release/12-4/
-
-12-5:
-	mkdir -p $(BUILDDIR)/release/12-5/
-	$(BUILD_COMMAND_AND_ARGS) snapshots/release_chef_12-5/source $(BUILDDIR)/release/12-5/
-
-12-6:
-	mkdir -p $(BUILDDIR)/release/12-6/
-	$(BUILD_COMMAND_AND_ARGS) snapshots/release_chef_12-6/source $(BUILDDIR)/release/12-6/
-
-12-7:
-	mkdir -p $(BUILDDIR)/release/12-7/
-	$(BUILD_COMMAND_AND_ARGS) snapshots/release_chef_12-7/source $(BUILDDIR)/release/12-7/
-
-12-8:
-	mkdir -p $(BUILDDIR)/release/12-8/
-	$(BUILD_COMMAND_AND_ARGS) snapshots/release_chef_12-8/source $(BUILDDIR)/release/12-8/
-
-12-9:
-	mkdir -p $(BUILDDIR)/release/12-9/
-	$(BUILD_COMMAND_AND_ARGS) snapshots/release_chef_12-9/source $(BUILDDIR)/release/12-9/
-
-12-10:
-	mkdir -p $(BUILDDIR)/release/12-10/
-	$(BUILD_COMMAND_AND_ARGS) snapshots/release_chef_12-10/source $(BUILDDIR)/release/12-10/
-
-12-11:
-	mkdir -p $(BUILDDIR)/release/12-11/
-	$(BUILD_COMMAND_AND_ARGS) snapshots/release_chef_12-11/source $(BUILDDIR)/release/12-11/
-
-12-12:
-	mkdir -p $(BUILDDIR)/release/12-12/
-	$(BUILD_COMMAND_AND_ARGS) snapshots/release_chef_12-12/source $(BUILDDIR)/release/12-12/
-
-12-13:
-	mkdir -p $(BUILDDIR)/release/12-13/
-	$(BUILD_COMMAND_AND_ARGS) snapshots/release_chef_12-13/source $(BUILDDIR)/release/12-13/
-
-oec_11-0:
-	mkdir -p $(BUILDDIR)/release/oec_11-0/
-	$(BUILD_COMMAND_AND_ARGS) snapshots/release_oec_11-0/source $(BUILDDIR)/release/oec_11-0/
-
-oec_11-1:
-	mkdir -p $(BUILDDIR)/release/oec_11-1/
-	$(BUILD_COMMAND_AND_ARGS) snapshots/release_oec_11-1/source $(BUILDDIR)/release/oec_11-1/
-
-oec_11-2:
-	mkdir -p $(BUILDDIR)/release/oec_11-2/
-	$(BUILD_COMMAND_AND_ARGS) snapshots/release_oec_11-2/source $(BUILDDIR)/release/oec_11-2/
-
-osc_11-0:
-	mkdir -p $(BUILDDIR)/release/osc_11-0/
-	$(BUILD_COMMAND_AND_ARGS) snapshots/release_osc_11-0/source $(BUILDDIR)/release/osc_11-0/
-
-osc_11-1:
-	mkdir -p $(BUILDDIR)/release/osc_11-1/
-	$(BUILD_COMMAND_AND_ARGS) snapshots/release_osc_11-1/source $(BUILDDIR)/release/osc_11-1/
-
-analytics:
-	mkdir -p $(BUILDDIR)/release/analytics/
-	$(BUILD_COMMAND_AND_ARGS) snapshots/release_analytics/source $(BUILDDIR)/release/analytics/
-
-devkit:
-	mkdir -p $(BUILDDIR)/release/devkit/
-	$(BUILD_COMMAND_AND_ARGS) snapshots/release_devkit/source $(BUILDDIR)/release/devkit/
-
-ohai-8:
-	mkdir -p $(BUILDDIR)/release/ohai-8/
-	$(BUILD_COMMAND_AND_ARGS) snapshots/release_ohai_8/source $(BUILDDIR)/release/ohai-8/
-
-ohai-7:
-	mkdir -p $(BUILDDIR)/release/ohai-7/
-	$(BUILD_COMMAND_AND_ARGS) snapshots/release_ohai_7/source $(BUILDDIR)/release/ohai-7/
-
-ohai-6:
-	mkdir -p $(BUILDDIR)/release/ohai-6/
-	$(BUILD_COMMAND_AND_ARGS) snapshots/release_ohai_6/source $(BUILDDIR)/release/ohai-6/
-
-push_1-0:
-	mkdir -p $(BUILDDIR)/release/push_jobs_1-0/
-	$(BUILD_COMMAND_AND_ARGS) snapshots/release_push_jobs_1-0/source $(BUILDDIR)/release/push_jobs_1-0/
-
-push_2-1:
-	mkdir -p $(BUILDDIR)/release/push_jobs_2-1/
-	$(BUILD_COMMAND_AND_ARGS) snapshots/release_push_jobs_2-1/source $(BUILDDIR)/release/push_jobs_2-1/
-
-server_12-8:
-	mkdir -p $(BUILDDIR)/release/server_12-8/
-	$(BUILD_COMMAND_AND_ARGS) snapshots/release_server_12-8/source $(BUILDDIR)/release/server_12-8/
-
-server_12-7:
-	mkdir -p $(BUILDDIR)/release/server_12-7/
-	$(BUILD_COMMAND_AND_ARGS) snapshots/release_server_12-7/source $(BUILDDIR)/release/server_12-7/
-
-server_12-6:
-	mkdir -p $(BUILDDIR)/release/server_12-6/
-	$(BUILD_COMMAND_AND_ARGS) snapshots/release_server_12-6/source $(BUILDDIR)/release/server_12-6/
-
-server_12-5:
-	mkdir -p $(BUILDDIR)/release/server_12-5/
-	$(BUILD_COMMAND_AND_ARGS) snapshots/release_server_12-5/source $(BUILDDIR)/release/server_12-5/
-
-server_12-4:
-	mkdir -p $(BUILDDIR)/release/server_12-4/
-	$(BUILD_COMMAND_AND_ARGS) snapshots/release_server_12-4/source $(BUILDDIR)/release/server_12-4/
-
-server_12-3:
-	mkdir -p $(BUILDDIR)/release/server_12-3/
-	$(BUILD_COMMAND_AND_ARGS) snapshots/release_server_12-3/source $(BUILDDIR)/release/server_12-3/
-
-server_12-2:
-	mkdir -p $(BUILDDIR)/release/server_12-2/
-	$(BUILD_COMMAND_AND_ARGS) snapshots/release_server_12-2/source $(BUILDDIR)/release/server_12-2/
-
-server_12-1:
-	mkdir -p $(BUILDDIR)/release/server_12-1/
-	$(BUILD_COMMAND_AND_ARGS) snapshots/release_server_12-1/source $(BUILDDIR)/release/server_12-1/
-
-server_12-0:
-	mkdir -p $(BUILDDIR)/release/server_12-0/
-	$(BUILD_COMMAND_AND_ARGS) snapshots/release_server_12-0/source $(BUILDDIR)/release/server_12-0/
-
-supermarket:
-	mkdir -p $(BUILDDIR)/release/supermarket/
-	$(BUILD_COMMAND_AND_ARGS) snapshots/release_supermarket/source $(BUILDDIR)/release/supermarket/
-
-
-upload:	release
-	s3cmd sync $(S3OPTIONS) $(BUILDDIR)/ s3://$(S3BUCKET)/
-
-#
-# OLD BUILDS DO NOT BUILD
-#
-# 10:
-# 	mkdir -p $(BUILDDIR)/release/10/
-# 	$(BUILD_COMMAND_AND_ARGS) release_chef_10/source $(BUILDDIR)/release/10/
-#
-# private_chef:
-# 	mkdir -p $(BUILDDIR)/release/private_chef/
-# 	$(BUILD_COMMAND_AND_ARGS) release_private_chef/source $(BUILDDIR)/release/private_chef/
diff --git a/README.md b/README.md
@@ -48,7 +48,7 @@ install Sphinx, the documentation generator, possibly using `sudo`:
   pip install -r requirements.txt
 ```
 
-> Note: The default `make` target is `master`. This is the target that creates the appropriate `build` directory on your local machine and references in the source files in the `chef_master/source` directory of your local repo.
+> Note: The default `make` target is `docs`. This is the target that creates the appropriate `build` directory on your local machine and references in the source files in the `source` directory of your local repo.
 
 We currently require version 1.2.3 of
 [Sphinx](http://sphinx-doc.org/). The requirements.txt file referenced above pins Sphinx and its dependencies to versions that are compatible with each other. You may also need to install Python, depending on your system.
@@ -104,6 +104,13 @@ We love getting feedback. You can use:
 
 [Creative Commons Attribution 3.0 Unported License](http://creativecommons.org/licenses/by/3.0/)
 
+## Documentation snapshots
+
+The previous scoped doc sets that were found off of https://docs.chef.io/release/ are no longer available in this repo. Instead, 
+those doc sets are located at https://docs-archive.chef.io/. The index page on that site provides links to them. They retain their unique
+left nav and can be used to view content at a particular point in time for a given release. In the future, snapshots 
+will be added for major releases of products/projects or for products/projects/components that are no longer supported.
+
 ## Archive of pre-2016 commit history
 
 Commit history of this repo prior to February 12, 2016 has been
diff --git a/cookbooks/docs-builder/metadata.rb b/cookbooks/docs-builder/metadata.rb
@@ -4,7 +4,7 @@
 license 'all_rights'
 description 'Installs/Configures docs-builder'
 long_description 'Installs/Configures docs-builder'
-version '0.2.0'
+version '0.3.0'
 
 depends 'aws'
 depends 'fancy_execute'
diff --git a/cookbooks/docs-builder/recipes/default.rb b/cookbooks/docs-builder/recipes/default.rb
@@ -67,56 +67,7 @@
 end
 
 build_targets = <<END
-master
-decks
-automate
-analytics
-11-0
-11-2
-11-4
-11-6
-11-8
-11-10
-11-12
-11-14
-11-16
-11-18
-12-0
-12-1
-12-2
-12-3
-12-4
-12-5
-12-6
-12-7
-12-8
-12-9
-12-10
-12-11
-12-12
-12-13
-compliance
-devkit
-oec_11-0
-oec_11-1
-oec_11-2
-ohai-8
-ohai-7
-ohai-6
-osc_11-0
-osc_11-1
-push_1-0
-push_2-1
-server_12-0
-server_12-1
-server_12-2
-server_12-3
-server_12-4
-server_12-5
-server_12-6
-server_12-7
-server_12-8
-supermarket
+docs
 END
 
 file '/srv/chef-web-docs/targets.txt' do

-Original file line number
+Diff line change
 chef-docs hopes that the documentation is always just what you are looking for, but when that isn't the case chef-docs does appreciate feedback. There are several ways to get feedback to chef-docs:
 * Email --- Send an email to [email protected] for documentation bugs, ideas, thoughts, and suggestions. Typos and little errors and quick fixes will be fixed quickly and without fuss. This email address is not a support email address, however. If you need support for Chef, contact CHEF support.
 -* Pull request -- The documentation repository is on GitHub: https://github.com/chef/chef-docs. DCO sign-off is not required to submit pull requests to this repo. If you are wondering what is going on in that repository, in terms of structure and what-goes-where, send an email to [email protected].
 +* Pull request -- The documentation repository is on GitHub: https://github.com/chef/chef-web-docs. DCO sign-off is not required to submit pull requests to this repo. If you are wondering what is going on in that repository, in terms of structure and what-goes-where, send an email to [email protected].
 * https://discourse.chef.io/ --- chef-docs follows this mailing list. Improvements to the documentation are made because of conversations that happen on this mailing list. That said, relying solely on the mailing list is the least effective way to get feedback to chef-docs (because there is no guarantee that chef-docs will see any particular message).
 Thanks in advance for any feedback you choose to send.