Get rid of the old links in the documentation (#489)

* Get rid of the old links in the documentation

We have now moved all our documentation & open-source site
to `hazelcast.com` with a new structure. This PR corrects all the
links to `*.hazelcast.org` with the new ones.

* add link checker option to sphinx and fix broken/redirected links

* use suggested article

.github/workflows/test_runner.yml

@@ -80,4 +80,4 @@ jobs:
       - name: Generate documentation
         working-directory: docs
         run: |
-          make html SPHINXOPTS="-W --keep-going"
+          make html SPHINXOPTS="-W --keep-going -b linkcheck"

README.rst

@@ -16,29 +16,29 @@ Hazelcast Python Client
 
 ----
 
-`Hazelcast <https://hazelcast.org/>`__ is an open-source distributed
+`Hazelcast <https://hazelcast.com/>`__ is an open-source distributed
 in-memory data store and computation platform that provides a wide
 variety of distributed data structures and concurrency primitives.
 
-Hazelcast Python client is a way to communicate to Hazelcast IMDG
-clusters and access the cluster data. The client provides a
-Future-based asynchronous API suitable for wide ranges of use cases.
+Hazelcast Python client is a way to communicate to Hazelcast clusters
+and access the cluster data. The client provides a Future-based
+asynchronous API suitable for wide ranges of use cases.
 
 Installation
 ------------
 
 Hazelcast
 ~~~~~~~~~
 
-Hazelcast Python client requires a working Hazelcast IMDG cluster to
-run. This cluster handles the storage and manipulation of the user data.
+Hazelcast Python client requires a working Hazelcast cluster to run.
+This cluster handles the storage and manipulation of the user data.
 
-A Hazelcast IMDG cluster consists of one or more cluster members. These
+A Hazelcast cluster consists of one or more cluster members. These
 members generally run on multiple virtual or physical machines and are
 connected to each other via the network. Any data put on the cluster is
 partitioned to multiple members transparent to the user. It is therefore
 very easy to scale the system by adding new members as the data grows.
-Hazelcast IMDG cluster also offers resilience. Should any hardware or
+Hazelcast cluster also offers resilience. Should any hardware or
 software problem causes a crash to any member, the data on that member
 is recovered from backups and the cluster continues to operate without
 any downtime.
@@ -49,12 +49,12 @@ images <https://hub.docker.com/r/hazelcast/hazelcast/>`__.
 
 .. code:: bash
 
-   docker run -p 5701:5701 hazelcast/hazelcast:4.2
+   docker run -p 5701:5701 hazelcast/hazelcast:5.0
 
 You can also use our ZIP or TAR
-`distributions <https://hazelcast.org/imdg/download/archives/#hazelcast-imdg>`__.
+`distributions <https://hazelcast.com/open-source-projects/downloads/>`__.
 Once you have downloaded, you can start the Hazelcast member using
-the ``bin/start.sh`` script.
+the ``bin/hz-start`` script.
 
 Client
 ~~~~~~
@@ -100,8 +100,8 @@ Usage
     client.shutdown()
 
 
-If you are using Hazelcast IMDG and the Python client on the same
-machine, the default configuration should work out-of-the-box. However,
+If you are using Hazelcast and the Python client on the same machine,
+the default configuration should work out-of-the-box. However,
 you may need to configure the client to connect to cluster nodes that
 are running on different machines or to customize client properties.
 
@@ -149,7 +149,7 @@ Features
 -  Ability to listen to client lifecycle, cluster state, and distributed
    data structure events
 -  and `many
-   more <https://hazelcast.org/imdg/clients-languages/python/#client-features>`__
+   more <https://hazelcast.com/clients/python/#client-features>`__
 
 Getting Help
 ------------
@@ -177,7 +177,7 @@ Issue Reports
 For issue reports, please share the following information with us to
 quickly resolve the problems:
 
--  Hazelcast IMDG and the client version that you use
+-  Hazelcast and the client version that you use
 -  General information about the environment and the architecture you
    use like Python version, cluster size, number of clients, Java
    version, JVM parameters, operating system etc.
@@ -195,7 +195,7 @@ Development
 ^^^^^^^^^^^
 
 1. Clone the `GitHub repository
-   <https://github.com/hazelcast/hazelcast-python-client.git>`__.
+   <https://github.com/hazelcast/hazelcast-python-client>`__.
 2. Run ``python setup.py install`` to install the Python client.
 
 If you are planning to contribute:
@@ -223,7 +223,7 @@ Following commands starts the tests:
     python run_tests.py
 
 Test script automatically downloads ``hazelcast-remote-controller`` and
-Hazelcast IMDG. The script uses Maven to download those.
+Hazelcast. The script uses Maven to download those.
 
 License
 -------
@@ -235,5 +235,5 @@ Copyright
 
 Copyright (c) 2008-2021, Hazelcast, Inc. All Rights Reserved.
 
-Visit `www.hazelcast.com <http://www.hazelcast.com>`__ for more
+Visit `hazelcast.com <https://hazelcast.com>`__ for more
 information.

docs/copyright.rst

@@ -3,5 +3,5 @@ Copyright
 
 Copyright (c) 2008-2021, Hazelcast, Inc. All Rights Reserved.
 
-Visit `www.hazelcast.com <http://www.hazelcast.com>`__ for more
+Visit `hazelcast.com <https://hazelcast.com>`__ for more
 information.

docs/development_and_testing.rst

@@ -11,8 +11,8 @@ Building and Using Client From Sources
 Follow the below steps to build and install Hazelcast Python client from
 its source:
 
-1. Clone the GitHub repository
-   (https://github.com/hazelcast/hazelcast-python-client.git).
+1. Clone the `GitHub repository
+   <https://github.com/hazelcast/hazelcast-python-client>`__.
 2. Run ``python setup.py install`` to install the Python client.
 
 If you are planning to contribute:
@@ -40,4 +40,4 @@ Following commands starts the tests:
     python run_tests.py
 
 Test script automatically downloads ``hazelcast-remote-controller`` and
-Hazelcast IMDG. The script uses Maven to download those.
+Hazelcast. The script uses Maven to download those.

docs/getting_started.rst

@@ -12,61 +12,68 @@ Requirements
 - Windows, Linux/UNIX or Mac OS X
 - Python 2.7 or Python 3.4 or newer
 - Java 8 or newer
-- Hazelcast IMDG 4.0 or newer
+- Hazelcast 4.0 or newer
 - Latest Hazelcast Python client
 
-Working with Hazelcast IMDG Clusters
-------------------------------------
+Working with Hazelcast Clusters
+-------------------------------
 
-Hazelcast Python client requires a working Hazelcast IMDG cluster to
+Hazelcast Python client requires a working Hazelcast cluster to
 run. This cluster handles storage and manipulation of the user data.
-Clients are a way to connect to the Hazelcast IMDG cluster and access
+Clients are a way to connect to the Hazelcast cluster and access
 such data.
 
-Hazelcast IMDG cluster consists of one or more cluster members. These
+Hazelcast cluster consists of one or more cluster members. These
 members generally run on multiple virtual or physical machines and are
 connected to each other via network. Any data put on the cluster is
 partitioned to multiple members transparent to the user. It is therefore
 very easy to scale the system by adding new members as the data grows.
-Hazelcast IMDG cluster also offers resilience. Should any hardware or
+Hazelcast cluster also offers resilience. Should any hardware or
 software problem causes a crash to any member, the data on that member
 is recovered from backups and the cluster continues to operate without
 any downtime. Hazelcast clients are an easy way to connect to a
-Hazelcast IMDG cluster and perform tasks on distributed data structures
+Hazelcast cluster and perform tasks on distributed data structures
 that live on the cluster.
 
 In order to use Hazelcast Python client, we first need to setup a
-Hazelcast IMDG cluster.
+Hazelcast cluster.
 
-Setting Up a Hazelcast IMDG Cluster
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Setting Up a Hazelcast Cluster
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-There are following options to start a Hazelcast IMDG cluster easily:
+There are following options to start a Hazelcast cluster easily:
 
-- You can run standalone members by downloading and running JAR files
-  from the website.
-- You can embed members to your Java projects.
 - You can use our `Docker
   images <https://hub.docker.com/r/hazelcast/hazelcast/>`__.
 
-We are going to download JARs from the website and run a standalone
-member for this guide.
+  .. code:: bash
+
+      docker run -p 5701:5701 hazelcast/hazelcast:5.0
+
+- You can use `Hazelcast CLI
+  <https://docs.hazelcast.com/hazelcast/latest/getting-started/install-hazelcast#using-a-package-manager>`__.
+- You can run standalone members by downloading and running distribution
+  files from the website.
+- You can embed members to your Java projects.
+
+We are going to download distribution files from the website and run
+a standalone member for this guide.
 
 Running Standalone JARs
 ^^^^^^^^^^^^^^^^^^^^^^^
 
-Follow the instructions below to create a Hazelcast IMDG cluster:
+Follow the instructions below to create a Hazelcast cluster:
 
-1. Go to Hazelcast’s download `page <https://hazelcast.org/download/>`__
-   and download either the ``.zip`` or ``.tar`` distribution of
-   Hazelcast IMDG.
+1. Go to Hazelcast’s download `page
+   <https://hazelcast.com/open-source-projects/downloads/>`__
+   and download either the ``.zip`` or ``.tar`` distribution of Hazelcast.
 2. Decompress the contents into any directory that you want to run
    members from.
 3. Change into the directory that you decompressed the Hazelcast content
    and then into the ``bin`` directory.
-4. Use either ``start.sh`` or ``start.bat`` depending on your operating
+4. Use either ``hz-start`` or ``hz-start.bat`` depending on your operating
    system. Once you run the start script, you should see the Hazelcast
-   IMDG logs in the terminal.
+   logs in the terminal.
 
 You should see a log similar to the following, which means that your
 1-member cluster is ready to be used:
@@ -126,8 +133,8 @@ If you want to add a ``Portable`` class, you should use
 ``<portable-factories>`` instead of ``<data-serializable-factories>`` in
 the above configuration.
 
-See the `Hazelcast IMDG Reference
-Manual <http://docs.hazelcast.org/docs/latest/manual/html-single/index.html#getting-started>`__
+See the `Hazelcast Reference Manual
+<https://docs.hazelcast.com/hazelcast/latest/getting-started/install-hazelcast>`__
 for more information on setting up the clusters.
 
 Downloading and Installing
@@ -151,41 +158,41 @@ command:
 Basic Configuration
 -------------------
 
-If you are using Hazelcast IMDG and Python client on the same computer,
+If you are using Hazelcast and Python client on the same computer,
 generally the default configuration should be fine. This is great for
 trying out the client. However, if you run the client on a different
 computer than any of the cluster members, you may need to do some simple
 configurations such as specifying the member addresses.
 
-The Hazelcast IMDG members and clients have their own configuration
+The Hazelcast members and clients have their own configuration
 options. You may need to reflect some of the member side configurations
 on the client side to properly connect to the cluster.
 
 This section describes the most common configuration elements to get you
 started in no time. It discusses some member side configuration options
 to ease the understanding of Hazelcast’s ecosystem. Then, the client
 side configuration options regarding the cluster connection are
-discussed. The configurations for the Hazelcast IMDG data structures
+discussed. The configurations for the Hazelcast data structures
 that can be used in the Python client are discussed in the following
 sections.
 
-See the `Hazelcast IMDG Reference
-Manual <https://docs.hazelcast.org/docs/latest/manual/html-single/index.html>`__
+See the `Hazelcast Reference Manual
+<https://docs.hazelcast.com/hazelcast/latest/>`__
 and :ref:`configuration_overview:configuration overview` section for
 more information.
 
-Configuring Hazelcast IMDG
-~~~~~~~~~~~~~~~~~~~~~~~~~~
+Configuring Hazelcast
+~~~~~~~~~~~~~~~~~~~~~
 
-Hazelcast IMDG aims to run out-of-the-box for most common scenarios.
+Hazelcast aims to run out-of-the-box for most common scenarios.
 However if you have limitations on your network such as multicast being
-disabled, you may have to configure your Hazelcast IMDG members so that
+disabled, you may have to configure your Hazelcast members so that
 they can find each other on the network. Also, since most of the
 distributed data structures are configurable, you may want to configure
 them according to your needs. We will show you the basics about network
 configuration here.
 
-You can use the following options to configure Hazelcast IMDG:
+You can use the following options to configure Hazelcast:
 
 - Using the ``hazelcast.xml`` configuration file.
 - Programmatically configuring the member before starting it from the
@@ -297,7 +304,7 @@ default settings.
 
     client = hazelcast.HazelcastClient()
 
-If you run the Hazelcast IMDG members on a different server than the
+If you run the Hazelcast members on a different server than the
 client, you most probably have configured the members’ ports and cluster
 names as explained in the previous section. If you did, then you need to
 make match those changes to the network settings of your client.

docs/index.rst

@@ -16,13 +16,13 @@ Hazelcast Python Client
 
 ----
 
-`Hazelcast <https://hazelcast.org/>`__ is an open-source distributed
+`Hazelcast <https://hazelcast.com/>`__ is an open-source distributed
 in-memory data store and computation platform that provides a wide
 variety of distributed data structures and concurrency primitives.
 
-Hazelcast Python client is a way to communicate to Hazelcast IMDG
-clusters and access the cluster data. The client provides a
-Future-based asynchronous API suitable for wide ranges of use cases.
+Hazelcast Python client is a way to communicate to Hazelcast clusters
+and access the cluster data. The client provides a Future-based
+asynchronous API suitable for wide ranges of use cases.
 
 
 Overview
@@ -62,8 +62,8 @@ Usage
     client.shutdown()
 
 
-If you are using Hazelcast IMDG and the Python client on the same
-machine, the default configuration should work out-of-the-box. However,
+If you are using Hazelcast and the Python client on the same machine,
+the default configuration should work out-of-the-box. However,
 you may need to configure the client to connect to cluster nodes that
 are running on different machines or to customize client properties.
 
@@ -124,7 +124,7 @@ Features
     serialization
     setting_up_client_network
     client_connection_strategy
-    using_python_client_with_hazelcast_imdg
+    using_python_client_with_hazelcast
     securing_client_connection
     development_and_testing
     getting_help

docs/securing_client_connection.rst

@@ -5,7 +5,7 @@ This chapter describes the security features of Hazelcast Python client.
 These include using TLS/SSL for connections between members and between
 clients and members, mutual authentication, username/password authentication,
 token authentication and Kerberos authentication. These security features
-require **Hazelcast IMDG Enterprise** edition.
+require **Hazelcast Enterprise** edition.
 
 TLS/SSL
 -------
@@ -32,8 +32,8 @@ TLS/SSL for Hazelcast Members
 
 Hazelcast allows you to encrypt socket level communication between
 Hazelcast members and between Hazelcast clients and members, for end to
-end encryption. To use it, see the `TLS/SSL for Hazelcast Members
-section <http://docs.hazelcast.org/docs/latest/manual/html-single/index.html#tls-ssl-for-hazelcast-members>`__.
+end encryption. To use it, see the `TLS/SSL for Hazelcast Members section
+<https://docs.hazelcast.com/hazelcast/latest/security/tls-ssl.html#tlsssl-for-hazelcast-members>`__.
 
 TLS/SSL for Hazelcast Python Clients
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -252,8 +252,8 @@ property on the server side in the ``hazelcast.xml`` file:
 
 You can see the details of setting mutual authentication on the server
 side in the `Mutual Authentication
-section <https://docs.hazelcast.org/docs/latest/manual/html-single/index.html#mutual-authentication>`__
-of the Hazelcast IMDG Reference Manual.
+section <https://docs.hazelcast.com/hazelcast/latest/security/tls-ssl.html#mutual-authentication>`__
+of the Hazelcast Reference Manual.
 
 On the client side, you have to provide ``ssl_cafile``, ``ssl_certfile``
 and ``ssl_keyfile`` on top of the other TLS/SSL configurations. See the
@@ -289,7 +289,7 @@ Then, on the client-side, set ``creds_username`` and ``creds_password`` in the c
     )
 
 Check out the documentation on `Password Credentials
-<https://docs.hazelcast.com/imdg/latest/security/security-realms.html#password-credentials>`__
+<https://docs.hazelcast.com/hazelcast/latest/security/security-realms.html#password-credentials>`__
 of the Hazelcast Documentation.
 
 Token-Based Authentication

docs/setting_up_client_network.rst

@@ -48,7 +48,7 @@ Setting Smart Routing
 
 Smart routing defines whether the client mode is smart or unisocket. See
 the
-:ref:`using_python_client_with_hazelcast_imdg:python client operation modes`
+:ref:`using_python_client_with_hazelcast:python client operation modes`
 section for the description of smart and unisocket modes.
 
 .. code:: python
@@ -134,7 +134,7 @@ External Smart Client Discovery
 
 .. warning::
 
-    This feature requires Hazelcast IMDG 4.2 or higher version.
+    This feature requires Hazelcast 4.2 or higher version.
 
 The client sends requests directly to cluster members in the smart client mode
 (default) in order to reduce hops to accomplish operations. Because of that,