Skip to content

Commit

Permalink
Audit and fix hyperlinks in code and documentation (#1005)
Browse files Browse the repository at this point in the history
* - Audit and fix all hyperlinks in code and documentation

  - Change zope.org references to zope.dev due to ongoing domain ownership
    issues. zope.dev is owned by the Plone Foundation and thus safe from
    interference. XML/ZCML namespace URLs remain unchanged.
  - Remove all links that are completely dead, such as the old zope.org
    Collectors issue trackers.
  - Update all other miscellaneous links to make them work again or remove if
    the information is gone.

* - small fixes

* - unbreak tests

* - add pointer to community.plone.org
  • Loading branch information
dataflake committed Jan 9, 2022
1 parent 0951a96 commit f0a7a5a
Show file tree
Hide file tree
Showing 52 changed files with 271 additions and 312 deletions.
10 changes: 10 additions & 0 deletions CHANGES.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,16 @@ https://zope.readthedocs.io/en/2.13/CHANGES.html
4.6.4 (unreleased)
------------------

- Audit and fix all hyperlinks in code and documentation

- Change zope.org references to zope.dev due to ongoing domain ownership
issues. zope.dev is owned by the Plone Foundation and thus safe from
interference. XML/ZCML namespace URLs remain unchanged.
- Remove all links that are completely dead, such as the old zope.org
Collectors issue trackers.
- Update all other miscellaneous links to make them work again or remove if
the information is gone.

- Improve type guessing for the default WebDAV PUT factory
(`#997 <https://github.com/zopefoundation/Zope/issues/997>`_)

Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This is the official home for all Zope documentation.
operation
wsgi
maintenance
Zope development roadmap <https://www.zope.org/developer/roadmap.html>
Zope development roadmap <https://www.zope.dev/developer/roadmap.html>
changes
zopebook/index
zdgbook/index
7 changes: 6 additions & 1 deletion docs/maintenance.rst
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,12 @@ Steps for creating a new Zope release
The script is called two times so the rendered version updates can be
easily assigned to the correct file.

- Announce the release to the world via zope-announce@zope.org and https://community.plone.org/c/announcements.
- Run the tests: ``bin/tox -pall``
- Build the documentation: ``bin/make-docs``
- Fix problems.
- Commit and push the changes.

- Announce the release to the world via zope-announce@zope.dev and https://community.plone.org/c/announcements.


Maintaining the Zope documentation
Expand Down
2 changes: 1 addition & 1 deletion docs/zdgbook/Introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Throughout this guide, it is assumed that you know how to program in
the Python programming language. Most of the examples in this guide
will be in Python. There are a number of great resources and books
for learning Python; the best online resource is the `python.org web
site <http://www.python.org/>`_ and many books can be found on the
site <https://www.python.org/>`_ and many books can be found on the
shelves of your local bookstore.

Organization of the book
Expand Down
6 changes: 3 additions & 3 deletions docs/zdgbook/Outline.txt
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ online help system and from Zope objects through their interfaces.

The majority of the content of this chapter will come from the
`Interface documentation
<http://www.zope.org/Wikis/Interfaces/InterfaceUserDocumentation>`_
<https://zopeinterface.readthedocs.io/en/latest/>`_

1. What are interfaces, why are they useful?

Expand Down Expand Up @@ -81,7 +81,7 @@ Python-based components.

The majority of the content of this chapter will come from
Amos/Shane's `Product Tutorial
<http://www.zope.org/Members/hathawsh/PythonProductTutorial>`_
<http://old.zope.dev/Members/hathawsh/PythonProductTutorial>`_

1. Introduction

Expand Down Expand Up @@ -132,7 +132,7 @@ policies specific to their needs or the needs of their components.

The majority of the content of this chapter will come from Chris'
first cut at `Security documentation
<http://www.zope.org/Members/mcdonc/PDG/6-1-Security.stx>`_
<https://old.zope.dev/Members/mcdonc/PDG/6-1-Security.stx/document_view>`_

1. Security architecture

Expand Down
16 changes: 1 addition & 15 deletions docs/zdgbook/Products.rst
Original file line number Diff line number Diff line change
Expand Up @@ -839,7 +839,7 @@ When creating management views you should include the DTML variables
by your product and draw a standard management view header, tabs
widgets, and footer. The management header also includes CSS
information which you can take advantage of. You can use any of the styles
Bootstrap 4 provides. (See http://getbootstrap.com/docs/4.1/)
Bootstrap 4 provides - see https://getbootstrap.com/docs/4.6/.

Here's an example management view for your poll class. It allows you
to edit the poll question and responses (see ``editPollForm.dtml``)::
Expand Down Expand Up @@ -1124,20 +1124,6 @@ Depending on which XML-RPC clients you anticipate, you may wish to
make your XML-RPC methods public and accept authentication
credentials as arguments to your methods.

Content Management Framework Interface
--------------------------------------

The `Content Management Framework <http://cmf.zope.org>`_ is an
evolving content management extension for Zope. It provides a number
of interfaces and conventions for content objects. If you wish to
support the CMF you should consult the CMF user interface guidelines
and interface documentation.

Supporting the CMF interfaces is not a large burden if you already
support the Zope management interface. You should consider
supporting the CMF if your product class handles user manageable
content such as documents, images, business forms, etc.

Packaging Products
------------------

Expand Down
2 changes: 1 addition & 1 deletion docs/zdgbook/README.txt
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Contact

At this point the book is best discussed at:

http://mail.zope.org/mailman/listinfo/zope-dev
https://mail.zope.dev/mailman/listinfo/zope-dev


.. _Sphinx: http://sphinx.pocoo.org/
Expand Down
19 changes: 8 additions & 11 deletions docs/zdgbook/TestingAndDebugging.rst
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ familiar with other popular command line debuggers (like gdb) will
feel right at home in pdb.

For an introduction to pdb see the standard `pdb documentation
<http://www.python.org/doc/current/lib/module-pdb.html>`_ .
<https://docs.python.org/library/pdb.html>`_ .

There are a number of ways to debug a Zope process:

Expand Down Expand Up @@ -139,7 +139,7 @@ debugger::

>>> ZPublisher.Zope('')
Status: 200 OK
X-Powered-By: Zope (www.zope.org), Python (www.python.org)
X-Powered-By: Zope (www.zope.dev), Python (www.python.org)
Content-Length: 1238
Content-Type: text/html

Expand Down Expand Up @@ -225,7 +225,7 @@ message, it's useful to know how you have set Zope up to be debugged.
When Zope fires up in debugger mode, there are three breakpoints set
for you automatically (if you don't know what a breakpoint is, you
need to read the python `debugger documentation
<http://www.python.org/doc/current/lib/module-pdb.html>`_).
<https://docs.python.org/library/pdb.html>`_).

The first breakpoint stops the program at the point that ZPublisher
(the Zope ORB) tries to publish the application module (in this case,
Expand Down Expand Up @@ -425,11 +425,8 @@ Unit Testing
Unit testing allows you to automatically test your classes to make
sure they are working correctly. By using unit tests you can make
sure as you develop and change your classes that you are not breaking
them. Zope comes with Pyunit. You can find out more information on
Pyunit at `the Pyunit home page <http://pyunit.sourceforge.net/>`_
. Pyunit is also part of the Python `standard library
<http://www.python.org/doc/lib/module-unittest.html>`_ as of Python
2.1.
them. Zope's own unit tests are written using the built-in Python
`unittest module <https://docs.python.org/library/unittest.html>`_.


What Are Unit Tests
Expand All @@ -450,7 +447,7 @@ successful.

It's a good idea to have a sense of the limits of unit testing. From
the `Extreme Programming Enthusiast website
<http://c2.com/cgi/wiki?UnitTestsDefined>`_ here is a list of things
<http://wiki.c2.com/?UnitTestsDefined>`_ here is a list of things
that unit tests are *not*:

- Manually operated.
Expand Down Expand Up @@ -531,8 +528,8 @@ your product's 'tests' directory. You can run test your product by
running the test scripts.

We cannot cover all there is to say about unit testing here. Take a
look at the Pyunit `documentation
<http://pyunit.sourceforge.net/pyunit.html>`_ for more background on
look at the `unittest module documentation
<https://docs.python.org/library/unittest.html>`_ for more background on
unit testing.

Zope Test Fixtures
Expand Down
19 changes: 4 additions & 15 deletions docs/zdgbook/ZODBPersistentComponents.rst
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +55,8 @@ remote storage server.
To set up a ZODB, you must first install it. ZODB comes with Zope,
so the easiest way to install ZODB is to install Zope and use the
ZODB that comes with your Zope installation. For those of you who
don't want all of Zope, but just ZODB, see the instructions for
downloading ZODB from the `ZODB web page
<http://wiki.zope.org/ZODB>`_.
don't want all of Zope, but just ZODB, see its page on PyPI at
https://pypi.org/project/ZODB/.

After installing ZODB, you can start to experiment with it right from
the Python command line interpreter. If you've installed Zope,
Expand Down Expand Up @@ -571,21 +570,12 @@ This chapter has only covered the most important features of ZODB
from a Zope developer's perspective. Check out some of these sources
for more in depth information:

- Andrew Kuchling's `ZODB pages <http://www.kuchling.com/zodb/>`_
include lots of information included a programmer's guide and links
to ZODB mailing lists.

- `ZODB Wiki <http://wiki.zope.org/ZODB>`_ has information about
current ZODB projects.
- The main ZODB documentation site at https://zodb.org/.

- `ZODB UML
Model <http://www.zope.org/Documentation/Developer/Models/ZODB>`_ has
Model <https://old.zope.dev/Documentation/Developer/Models/ZODB/>`_ has
the nitty gritty details on ZODB.

- Paper `Introduction to the Zope Object Database
<http://www.python.org/workshops/2000-01/proceedings/papers/fulton/zodb3.html>`_
by Jim Fulton, presented at the 8th Python Conference.

Summary
=======

Expand All @@ -595,4 +585,3 @@ yourself with thread safety, transactions, conflicts, memory
management, and database replication. ZODB takes care of these things
for you. By following a few simple rules you can create persistent
objects that just work.

6 changes: 3 additions & 3 deletions docs/zdgbook/source/_static/default.css
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@

body {
font: 75% "Lucida Grande",Verdana,Lucida,Helvetica,Arial,sans-serif;
background: #474747 url(http://new.zope.org/body_bg.png) repeat-x scroll left top;
background: #474747;
color: #333;
margin: 0;
padding: 0;
Expand Down Expand Up @@ -127,7 +127,7 @@ div.footer a {
}

div.related {
background: #F9F9F9 url(http://new.zope.org/light_grey_horizontal.png) repeat-x scroll left top;
background: #F9F9F9;
border-bottom: 1px solid #d3d3d3;
color: #333;
width: 999px;
Expand Down Expand Up @@ -162,7 +162,7 @@ div.related a {

/* ::: TOC :::: */
div.sphinxsidebar h3 {
background: #333333 url(http://new.zope.org/dark_grey_horizontal.png) repeat-x scroll left bottom;
background: #333333;
color: white;
font-weight: bold;
text-align: center;
Expand Down
4 changes: 2 additions & 2 deletions docs/zope4/news.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ about all minor new features and bugs being solved in this release. When you
are ready to migrate, make sure you study the :ref:`zope4migration`
documentation.

The `Zope development roadmap <https://www.zope.org/developer/roadmap.html>`_
on `www.zope.org <https://www.zope.org>`_ explains which versions are
The `Zope development roadmap <https://www.zope.dev/developer/roadmap.html>`_
on `www.zope.dev <https://www.zope.dev>`_ explains which versions are
supported and for how long.

.. contents::
Expand Down
2 changes: 1 addition & 1 deletion docs/zopebook/Acquisition.rst
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ complex cases (e.g., where the same method is defined in several
ancestors of base classes), the lookup order is too complicated to
explain within the scope of this book. Please see the online
Python documentation for the "method resolution order",
http://www.python.org/download/releases/2.3/mro/
https://www.python.org/download/releases/2.3/mro/

Here is an example of calling methods on an instance of the
above-defined Sub class::
Expand Down
7 changes: 4 additions & 3 deletions docs/zopebook/AdvDTML.rst
Original file line number Diff line number Diff line change
Expand Up @@ -269,7 +269,7 @@ consults these sources in order:
the current object and all of its parents.

3. The CGI environment. The `Common Gateway Interface
<http://www.w3.org/CGI/>`_, or CGI interface defines
<https://www.w3.org/CGI/>`_, or CGI interface defines
a standard set of environment variables to be used by
dynamic web scripts. These variables are provided by Zope
in the REQUEST namespace.
Expand Down Expand Up @@ -655,8 +655,9 @@ DTML Security
-------------

Zope can be used by many different kinds of users. For example, the
Zope site, `Zope.org <http://www.zope.org/>`_, has over 11,000 community
members at the time of this writing. Each member can log into Zope,
old Zope site, preserved at `old.zope.dev <https://old.zope.dev/>`_,
had over 11,000
community members when it was active. Each member was able to log into Zope,
add objects and news items, and manage their own personal area.

Because DTML is a scripting language, it is very flexible about
Expand Down
6 changes: 3 additions & 3 deletions docs/zopebook/AdvZPT.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ options in depth. This material is covered more concisely in

In this chapter, the terms `tag` and `element` are used in the
sense laid out by the `XHTML spec
<http://www.w3.org/TR/2000/REC-xhtml1-20000126/#defs>`_.
<https://www.w3.org/TR/xhtml1/#defs>`_.
``<p>`` is a *tag*, while the entire block
``<p>stuff</p>`` from opening tag through the closing
tag is an *element*.
Expand Down Expand Up @@ -924,7 +924,7 @@ Python Expressions
The Python programming language is a simple and expressive one.
If you have never encountered it before, you should read one of
the excellent tutorials or introductions available at the
`Python website <http://www.python.org>`_.
`Python website <https://www.python.org>`_.

A Page Template Python expression can contain anything that the
Python language considers an expression. You can't use
Expand Down Expand Up @@ -1163,7 +1163,7 @@ get access to it using either of the following statements::
Many Python modules cannot be accessed from Page Templates
or Scripts unless you add Zope security assertions to
them. See the `Zope Developer's Guide's security
chapter <http://www.zope.org/Documentation/Books/ZDG/current/Security.stx>`_
chapter <https://zope.readthedocs.io/en/latest/zdgbook/Security.html>`_
for more information on making more Python modules available
to your templates and scripts by using ``ModuleSecurityInfo``.

Expand Down
24 changes: 12 additions & 12 deletions docs/zopebook/AppendixA.rst
Original file line number Diff line number Diff line change
Expand Up @@ -292,13 +292,13 @@ None
See Also
--------

- `string module <http://docs.python.org/library/string.html>`_
- `string module <https://docs.python.org/library/string.html>`_

- `random module <http://docs.python.org/library/random.html>`_
- `random module <https://docs.python.org/library/random.html>`_

- `math module <http://docs.python.org/library/math.html>`_
- `math module <https://docs.python.org/library/math.html>`_

- `sequence module <http://docs.python.org/library/functions.html>`_
- `sequence module <https://docs.python.org/library/functions.html>`_


if: Tests Conditions
Expand Down Expand Up @@ -354,7 +354,7 @@ Testing for expression conditions::
See Also
--------

`Python Tutorial If Statements <http://docs.python.org/tutorial/controlflow.html#if-statements>`_
`Python Tutorial If Statements <https://docs.python.org/3/tutorial/controlflow.html#if-statements>`_


in: Loops over sequences
Expand Down Expand Up @@ -816,7 +816,7 @@ Sending a file attachment::
See Also
--------

- `Python Library mimetools <http://docs.python.org/library/mimetools.html>`_
- `Python Library mimetools <https://docs.python.org/library/mimetools.html>`_

raise: Raises an exception
==========================
Expand Down Expand Up @@ -852,9 +852,9 @@ See Also

- try tag

- `Python Tutorial Errors and Exceptions <http://docs.python.org/tutorial/errors.html>`_
- `Python Tutorial Errors and Exceptions <https://docs.python.org/tutorial/errors.html>`_

- `Python Built-in Exceptions <http://docs.python.org/library/exceptions.html>`_
- `Python Built-in Exceptions <https://docs.python.org/library/exceptions.html>`_

return: Returns data
====================
Expand Down Expand Up @@ -946,7 +946,7 @@ Sending an email message using a Mail Host::
See Also
--------

- `RFC 821 (SMTP Protocol) <http://www.ietf.org/rfc/rfc0821.txt>`_
- `RFC 821 (SMTP Protocol) <https://www.ietf.org/rfc/rfc0821.txt>`_

- mime tag

Expand Down Expand Up @@ -1426,9 +1426,9 @@ See Also

- raise tag

- `Python Tutorial Errors and Exceptions <http://docs.python.org/tutorial/errors.html>`_
- `Python Tutorial Errors and Exceptions <https://docs.python.org/tutorial/errors.html>`_

- `Python Built-in Exceptions <http://docs.python.org/library/exceptions.html>`_
- `Python Built-in Exceptions <https://docs.python.org/library/exceptions.html>`_


unless: Tests a condition
Expand Down Expand Up @@ -1514,7 +1514,7 @@ missing=string
fmt=string
Format a variable. Zope provides a few built-in formats including C-style
format strings. For more information on C-style format strings see the
`Python Library Reference <http://docs.python.org/library/stdtypes.html#typesseq-strings>`_.
`Python Library Reference <https://docs.python.org/library/stdtypes.html#typesseq-strings>`_.
If the format string is not a built-in format, then it is assumed to be a
method of the object, and it called.

Expand Down

0 comments on commit f0a7a5a

Please sign in to comment.