Fix all broken links in docs. Ignore certain known-good links. Adjust…

… many links that are returning 301. Conflicts: doc/topics/installation/index.rst
marchiere · Feb 20, 2014 · a485ece · a485ece
1 parent 0e4cbdd
commit a485ece
Show file tree

Hide file tree

Showing 52 changed files with 118 additions and 96 deletions.
diff --git a/doc/conf.py b/doc/conf.py
@@ -113,11 +113,11 @@ def __getattr__(self, name):
 # -- General Configuration -----------------------------------------------------
 
 project = 'Salt'
-copyright = '2013 SaltStack, Inc.'
+copyright = '2014 SaltStack, Inc.'
 
 version = salt.version.__version__
 #release = '.'.join(map(str, salt.version.__version_info__))
-release = '0.17.5'
+release = '2014.1'
 
 language = 'en'
 locale_dirs = [
@@ -150,7 +150,7 @@ def __getattr__(self, name):
 # A shortcut for linking to tickets on the GitHub issue tracker
 extlinks = {
     'blob': ('https://github.com/saltstack/salt/blob/%s/%%s' % 'develop', None),
-    'download': ('https://github.com/downloads/saltstack/salt/%s', None),
+    'download': ('https://cloud.github.com/downloads/saltstack/salt/%s', None),
     'issue': ('https://github.com/saltstack/salt/issues/%s', 'issue '),
     'formula': ('https://github.com/saltstack-formulas/%s', ''),
 }
@@ -218,6 +218,36 @@ def __getattr__(self, name):
 
 latex_logo = '_static/saltstack_logo.png'
 
+### Linkcheck options
+linkcheck_ignore = [r'http://127.0.0.1',
+                    r'http://salt:\d+',
+                    r'http://local:\d+',
+                    r'https://console.aws.amazon.com',
+                    r'http://192.168.33.10',
+                    r'http://domain:\d+',
+                    r'http://123.456.789.012:\d+',
+                    r'http://localhost',
+                    r'https://groups.google.com/forum/#!forum/salt-users',
+                    r'http://logstash.net/docs/latest/inputs/udp',
+                    r'http://logstash.net/docs/latest/inputs/zeromq',
+                    r'http://www.youtube.com/saltstack',
+                    r'http://raven.readthedocs.org',
+                    r'https://getsentry.com',
+                    r'http://salt-cloud.readthedocs.org',
+                    r'http://salt.readthedocs.org',
+                    r'http://www.pip-installer.org/',
+                    r'http://www.windowsazure.com/',
+                    r'https://github.com/watching',
+                    r'dash-feed://',
+                    r'https://github.com/saltstack/salt/',
+                    r'http://bootstrap.saltstack.org',
+                    r'media.readthedocs.org/dash/salt/latest/salt.xml',
+                    r'https://portal.aws.amazon.com/gp/aws/securityCredentials',
+                    r'https://help.github.com/articles/fork-a-repo',
+                    r'dash-feed://https%3A//media.readthedocs.org/dash/salt/latest/salt.xml'
+                    ]
+
+linkcheck_anchors = False
 
 ### Manpage options
 # One entry per manual page. List of tuples

diff --git a/doc/index.rst b/doc/index.rst
@@ -30,7 +30,7 @@ for orchestration, remote execution, configuration management and much more.
 .. _`ePub`: https://media.readthedocs.org/epub/salt/latest/salt.epub
 .. _`Dash Docset`: dash-feed://https%3A//media.readthedocs.org/dash/salt/latest/salt.xml
 .. _`ReadTheDocs download page`: https://readthedocs.org/projects/salt/downloads/
-.. _`SaltStack YouTube channel`: http://youtube.com/saltstack
+.. _`SaltStack YouTube channel`: http://www.youtube.com/saltstack
 
 Download
 ========

diff --git a/doc/ref/modules/index.rst b/doc/ref/modules/index.rst
@@ -161,7 +161,7 @@ function. Some examples:
 
 - :blob:`pacman.py <salt/modules/pacman.py>`
 - :blob:`yumpkg.py <salt/modules/yumpkg.py>`
-- :blob:`apt.py <salt/modules/apt.py>`
+- :blob:`aptpkg.py <salt/modules/aptpkg.py>`
 
 .. note::
     Modules which return a string from ``__virtual__`` that is already used by a module that

diff --git a/doc/ref/renderers/all/salt.renderers.jinja.rst b/doc/ref/renderers/all/salt.renderers.jinja.rst
@@ -267,7 +267,7 @@ strftime
       {{ datetime|strftime("%u") }}
       {{ "now"|strftime }}
 
-.. _`builtin filters`: http://jinja.pocoo.org/docs/templates/##builtin-filters
+.. _`builtin filters`: http://jinja.pocoo.org/docs/templates/#builtin-filters
 .. _`timelib`: https://github.com/pediapress/timelib/
 
 Jinja in Files

diff --git a/doc/ref/returners/index.rst b/doc/ref/returners/index.rst
@@ -105,4 +105,4 @@ loaded as simply ``redis``:
             return False
         return 'redis'
 
-.. _`redis`: https://github.com/saltstack/salt/blob/develop/salt/returners/redis_return.py
+.. _`redis`: https://github.com/saltstack/salt/tree/develop/salt/returners/redis_return.py
diff --git a/doc/ref/states/index.rst b/doc/ref/states/index.rst
@@ -33,7 +33,7 @@ an understanding of Salt states and how to write the states is needed as well.
 .. note::
 
     States are compiled and executed only on minions that have been targeted.
-    To execute functions directly on masters, see `runners`_.
+    To execute functions directly on masters, see :doc:`runners </topics/ref/runners>`.
 
 Salt SLS System
 ---------------
@@ -311,7 +311,7 @@ The output is:
     Total:     2
 
 
-.. _`pip`: http://pypi.python.org/pypi/pip
+.. _`pip`: https://pypi.python.org/pypi/pip
 .. _`pep8`: https://pypi.python.org/pypi/pep8
 .. _`setuptools`: https://pypi.python.org/pypi/setuptools
 .. _`runners`: /ref/runners
diff --git a/doc/ref/states/writing.rst b/doc/ref/states/writing.rst
@@ -17,7 +17,7 @@ illustrate:
 .. code-block:: yaml
 
     /etc/salt/master: # maps to "name"
-      file: # maps to State module filename e.g. https://github.com/saltstack/salt/blob/develop/salt/states/file.py
+      file: # maps to State module filename e.g. https://github.com/saltstack/salt/tree/develop/salt/states/file.py
         - managed # maps to the managed function in the file State module
         - user: root # one of many options passed to the manage function
         - group: root

diff --git a/doc/topics/cloud/aws.rst b/doc/topics/cloud/aws.rst
@@ -424,7 +424,7 @@ Tags can be set once an instance has been launched.
             tag2: value
 
 .. _`AWS documentation`: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html
-.. _`AWS Spot Instances`: http://aws.amazon.com/ec2/spot-instances/
+.. _`AWS Spot Instances`: http://aws.amazon.com/ec2/purchasing-options/spot-instances/
 
 Modify EC2 Tags
 ===============
@@ -547,19 +547,15 @@ them have never been used, much less tested, by the Salt Stack team.
 
 * `Debian`__
 
-.. __: http://wiki.debian.org/Cloud/AmazonEC2Image
-
-* `Gentoo`__
-
-.. __: https://aws.amazon.com/amis?platform=Gentoo&selection=platform
+.. __: https://wiki.debian.org/Cloud/AmazonEC2Image
 
 * `OmniOS`__
 
 .. __: http://omnios.omniti.com/wiki.php/Installation#IntheCloud
 
 * `All Images on Amazon`__
 
-.. __: https://aws.amazon.com/amis
+.. __: https://aws.amazon.com/marketplace
 
 
 show_image

diff --git a/doc/topics/cloud/cloud.rst b/doc/topics/cloud/cloud.rst
@@ -31,7 +31,7 @@ imports, to decide whether to load the module. In most cases, it will return a
 filename, then that name should be returned instead of ``True``. An example of
 this may be seen in the Azure module:
 
-https://github.com/saltstack/salt/blob/develop/salt/cloud/clouds/msazure.py
+https://github.com/saltstack/salt/tree/develop/salt/cloud/clouds/msazure.py
 
 The get_configured_provider() Function
 --------------------------------------
@@ -57,7 +57,7 @@ created by the cloud provider, wait for it to become available, and then
 A good example to follow for writing a cloud provider module based on libcloud
 is the module provided for Linode:
 
-https://github.com/saltstack/salt/blob/develop/salt/cloud/clouds/linode.py
+https://github.com/saltstack/salt/tree/develop/salt/cloud/clouds/linode.py
 
 The basic flow of a ``create()`` function is as follows:
 
@@ -174,7 +174,7 @@ imports should be absent from the Salt Cloud module.
 
 A good example of a non-libcloud provider is the Digital Ocean module:
 
-https://github.com/saltstack/salt/blob/develop/salt/cloud/clouds/digital_ocean.py
+https://github.com/saltstack/salt/tree/develop/salt/cloud/clouds/digital_ocean.py
 
 The ``create()`` Function
 -------------------------

diff --git a/doc/topics/cloud/deploy.rst b/doc/topics/cloud/deploy.rst
@@ -78,7 +78,7 @@ This is currently considered to be experimental functionality, and may not work
 well with all providers. If you experience problems with Salt Cloud hanging 
 after Salt is deployed, consider using Startup States instead:
 
-http://docs.saltstack.org/en/latest/ref/states/startup.html
+http://docs.saltstack.com/ref/states/startup.html
 
 
 Skipping the Deploy Script

diff --git a/doc/topics/cloud/install/index.rst b/doc/topics/cloud/install/index.rst
@@ -26,7 +26,7 @@ Create a new `virtualenv`_:
 
     virtualenv /path/to/your/virtualenv
 
-.. _`virtualenv`: http://pypi.python.org/pypi/virtualenv
+.. _`virtualenv`: https://pypi.python.org/pypi/virtualenv
 
 
 On Arch Linux, where Python 3 is the default installation of Python, use the

diff --git a/doc/topics/cloud/releases/0.6.0.rst b/doc/topics/cloud/releases/0.6.0.rst
@@ -25,9 +25,9 @@ Download
 
 Salt Cloud can be downloaded and install via pypi or github:
 
-http://pypi.python.org/packages/source/s/salt-cloud/salt-cloud-0.6.0.tar.gz
+https://pypi.python.org/packages/source/s/salt-cloud/salt-cloud-0.6.0.tar.gz
 
-https://github.com/downloads/saltstack/salt-cloud/salt-cloud-0.6.0.tar.gz
+https://cloud.github.com/downloads/saltstack/salt-cloud/salt-cloud-0.6.0.tar.gz
 
 Packages are not yet available, Salt Cloud requires three dependencies, the
 salt libs, libcloud, and paramiko.

diff --git a/doc/topics/cloud/releases/0.7.0.rst b/doc/topics/cloud/releases/0.7.0.rst
@@ -22,9 +22,9 @@ Download
 
 Salt Cloud can be downloaded and install via pypi or github:
 
-http://pypi.python.org/packages/source/s/salt-cloud/salt-cloud-0.7.0.tar.gz
+https://pypi.python.org/packages/source/s/salt-cloud/salt-cloud-0.7.0.tar.gz
 
-https://github.com/downloads/saltstack/salt-cloud/salt-cloud-0.7.0.tar.gz
+https://cloud.github.com/downloads/saltstack/salt-cloud/salt-cloud-0.7.0.tar.gz
 
 Some packages have been made available for salt-cloud and more on on their
 way. Packages for Arch, and FreeBSD are being made available thanks to the
@@ -43,10 +43,10 @@ Rackspace Cloud
   http://www.rackspace.com/cloud/
 
 Linode
-  http://www.linode.com/
+  https://www.linode.com/
 
 Joyent
-  http://joyent.com/
+  http://www.joyent.com/
 
 GoGrid
   http://www.gogrid.com/

diff --git a/doc/topics/cloud/releases/0.8.0.rst b/doc/topics/cloud/releases/0.8.0.rst
@@ -17,9 +17,9 @@ Download
 
 Salt Cloud can be downloaded and install via pypi or github:
 
-http://pypi.python.org/packages/source/s/salt-cloud/salt-cloud-0.8.0.tar.gz
+https://pypi.python.org/packages/source/s/salt-cloud/salt-cloud-0.8.0.tar.gz
 
-https://github.com/downloads/saltstack/salt-cloud/salt-cloud-0.8.0.tar.gz
+https://cloud.github.com/downloads/saltstack/salt-cloud/salt-cloud-0.8.0.tar.gz
 
 Some packages have been made available for salt-cloud and more on on their
 way. Packages for Arch, and FreeBSD are being made available thanks to the

diff --git a/doc/topics/cloud/releases/0.8.1.rst b/doc/topics/cloud/releases/0.8.1.rst
@@ -17,9 +17,9 @@ Download
 
 Salt Cloud can be downloaded and install via pypi or github:
 
-http://pypi.python.org/packages/source/s/salt-cloud/salt-cloud-0.8.1.tar.gz
+https://pypi.python.org/packages/source/s/salt-cloud/salt-cloud-0.8.1.tar.gz
 
-https://github.com/downloads/saltstack/salt-cloud/salt-cloud-0.8.1.tar.gz
+https://cloud.github.com/downloads/saltstack/salt-cloud/salt-cloud-0.8.1.tar.gz
 
 Some packages have been made available for salt-cloud and more on on their
 way. Packages for Arch, and FreeBSD are being made available thanks to the

diff --git a/doc/topics/cloud/releases/0.8.2.rst b/doc/topics/cloud/releases/0.8.2.rst
@@ -18,9 +18,9 @@ Download
 
 Salt Cloud can be downloaded and install via pypi or github:
 
-http://pypi.python.org/packages/source/s/salt-cloud/salt-cloud-0.8.2.tar.gz
+https://pypi.python.org/packages/source/s/salt-cloud/salt-cloud-0.8.2.tar.gz
 
-https://github.com/downloads/saltstack/salt-cloud/salt-cloud-0.8.2.tar.gz
+https://cloud.github.com/downloads/saltstack/salt-cloud/salt-cloud-0.8.2.tar.gz
 
 Some packages have been made available for salt-cloud and more on on their
 way. Packages for Arch, and FreeBSD are being made available thanks to the

diff --git a/doc/topics/cloud/releases/0.8.3.rst b/doc/topics/cloud/releases/0.8.3.rst
@@ -16,9 +16,9 @@ Download
 
 Salt Cloud can be downloaded and install via pypi or github:
 
-http://pypi.python.org/packages/source/s/salt-cloud/salt-cloud-0.8.3.tar.gz
+https://pypi.python.org/packages/source/s/salt-cloud/salt-cloud-0.8.3.tar.gz
 
-https://github.com/downloads/saltstack/salt-cloud/salt-cloud-0.8.3.tar.gz
+https://cloud.github.com/downloads/saltstack/salt-cloud/salt-cloud-0.8.3.tar.gz
 
 Some packages have been made available for salt-cloud and more on on their
 way. Packages for Arch and FreeBSD are being made available thanks to the

diff --git a/doc/topics/cloud/releases/0.8.4.rst b/doc/topics/cloud/releases/0.8.4.rst
@@ -16,7 +16,7 @@ Download
 
 Salt Cloud can be downloaded and install via pypi:
 
-http://pypi.python.org/packages/source/s/salt-cloud/salt-cloud-0.8.4.tar.gz
+https://pypi.python.org/packages/source/s/salt-cloud/salt-cloud-0.8.4.tar.gz
 
 Some packages have been made available for salt-cloud and more on on their
 way. Packages for Arch and FreeBSD are being made available thanks to the

diff --git a/doc/topics/cloud/releases/0.8.5.rst b/doc/topics/cloud/releases/0.8.5.rst
@@ -18,7 +18,7 @@ Download
 
 Salt Cloud can be downloaded and install via pypi:
 
-http://pypi.python.org/packages/source/s/salt-cloud/salt-cloud-0.8.5.tar.gz
+https://pypi.python.org/packages/source/s/salt-cloud/salt-cloud-0.8.5.tar.gz
 
 Some packages have been made available for salt-cloud and more on on their
 way. Packages for Arch and FreeBSD are being made available thanks to the

diff --git a/doc/topics/cloud/releases/0.8.6.rst b/doc/topics/cloud/releases/0.8.6.rst
@@ -16,7 +16,7 @@ Download
 
 Salt Cloud can be downloaded and install via pypi:
 
-http://pypi.python.org/packages/source/s/salt-cloud/salt-cloud-0.8.6.tar.gz
+https://pypi.python.org/packages/source/s/salt-cloud/salt-cloud-0.8.6.tar.gz
 
 Some packages have been made available for salt-cloud and more on on their
 way. Packages for Arch and FreeBSD are being made available thanks to the

diff --git a/doc/topics/cloud/releases/0.8.7.rst b/doc/topics/cloud/releases/0.8.7.rst
@@ -36,7 +36,7 @@ Download
 
 Salt Cloud can be downloaded and install via pypi:
 
-http://pypi.python.org/packages/source/s/salt-cloud/salt-cloud-0.8.7.tar.gz
+https://pypi.python.org/packages/source/s/salt-cloud/salt-cloud-0.8.7.tar.gz
 
 Some packages have been made available for salt-cloud and more on on their
 way. Packages for Arch and FreeBSD are being made available thanks to the

diff --git a/doc/topics/cloud/releases/0.8.9.rst b/doc/topics/cloud/releases/0.8.9.rst
@@ -18,7 +18,7 @@ Download
 
 Salt Cloud can be downloaded and install via pypi:
 
-http://pypi.python.org/packages/source/s/salt-cloud/salt-cloud-0.8.9.tar.gz
+https://pypi.python.org/packages/source/s/salt-cloud/salt-cloud-0.8.9.tar.gz
 
 Some packages have been made available for salt-cloud and more on on their
 way. Packages for Arch and FreeBSD are being made available thanks to the

diff --git a/doc/topics/community.rst b/doc/topics/community.rst
@@ -90,7 +90,7 @@ https://www.ohloh.net/p/salt
 Other community links
 =====================
 
-- `Salt Stack Inc. <http://saltstack.com>`_
+- `Salt Stack Inc. <http://www.saltstack.com>`_
 - `Subreddit <http://www.reddit.com/r/saltstack>`_
 - `Google+ <https://plus.google.com/114449193225626631691/posts>`_
 - `YouTube <http://www.youtube.com/user/SaltStack>`_

diff --git a/doc/topics/conventions/style.rst b/doc/topics/conventions/style.rst
@@ -191,7 +191,7 @@ other salt modules which needed to import :mod:`sys<python2:sys>` would have to
 also import :mod:`absolute_import<python2:__future__>`, which should be 
 avoided.
 
-.. _`absolute imports`: http://www.python.org/dev/peps/pep-0328/#rationale-for-absolute-imports
+.. _`absolute imports`: http://legacy.python.org/dev/peps/pep-0328/#rationale-for-absolute-imports
 
 
 Vertical is Better
@@ -304,6 +304,6 @@ PEP 8. Code churn is a leading source of bugs and is strongly discouraged.
 While style fixes are encouraged they should be isolated to a single file per
 commit, and the changes should be legitimate, if there are any questions about
 whether a style change is legitimate please reference this document and the
-official PEP 8 (http://www.python.org/dev/peps/pep-0008/) document before
+official PEP 8 (http://legacy.python.org/dev/peps/pep-0008/) document before
 changing code. Many claims that a change is PEP 8 have been invalid, please
 double check before committing fixes.
diff --git a/doc/topics/hacking.rst b/doc/topics/hacking.rst
@@ -114,7 +114,7 @@ Then to accept the changes and merge into the current branch:
 For more info, see `GitHub Fork a Repo Guide`_ or `Open Comparison Contributing
 Docs`_
 
-.. _`GitHub Fork a Repo Guide`: http://help.github.com/fork-a-repo/
+.. _`GitHub Fork a Repo Guide`: https://help.github.com/articles/fork-a-repo
 .. _`Open Comparison Contributing Docs`: http://opencomparison.readthedocs.org/en/latest/contributing.html
 
 Posting patches to the mailing list
@@ -125,7 +125,7 @@ format-patch`_ and send them to the Salt users mailing list. The contributor
 will then get credit for the patch, and the Salt community will have an archive
 of the patch and a place for discussion.
 
-.. _`git format-patch`: http://www.kernel.org/pub/software/scm/git/docs/git-format-patch.html
+.. _`git format-patch`: https://www.kernel.org/pub/software/scm/git/docs/git-format-patch.html
 
 Installing Salt for development
 -------------------------------
@@ -145,7 +145,7 @@ Clone the repository using:
 
     .. code-block:: bash
 
-        git remote add upstream http://github.com/saltstack/salt
+        git remote add upstream https://github.com/saltstack/salt
 
     Fetching tags is done with the git 'fetch' utility:
 
@@ -159,7 +159,7 @@ Create a new `virtualenv`_:
 
     virtualenv /path/to/your/virtualenv
 
-.. _`virtualenv`: http://pypi.python.org/pypi/virtualenv
+.. _`virtualenv`: https://pypi.python.org/pypi/virtualenv
 
 On Arch Linux, where Python 3 is the default installation of Python, use the
 ``virtualenv2`` command instead of ``virtualenv``.

diff --git a/doc/topics/index.rst b/doc/topics/index.rst
@@ -61,7 +61,7 @@ authentication and encryption are integral to Salt.  Salt takes
 advantage of communication via `msgpack`_, enabling fast and light
 network traffic.
 
-.. _`ZeroMQ`: http://www.zeromq.org/
+.. _`ZeroMQ`: http://zeromq.org/
 .. _`msgpack`: http://msgpack.org/
 .. _`AES`: https://en.wikipedia.org/wiki/Advanced_Encryption_Standard