Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Update for start-preview.sh

This page provides a step-by-step guide to set up the contents of the Kafka website (https://kafka.apache.org/) as your local Apache HTTP Server's homepage. This is useful when you are contributing documentation changes, for which you need verify that any modified pages of yours still display and render correctly.  This Note that the start-preview.sh script does what is described here within a Docker container: Most people will find start-preview.sh easier and more convenient than following this guide. This guide is based on macOS, but should be easily adopted for other operating systems like Linux/Unix. 

...

Table of Contents

Table of Contents

...

1.

...

 Start the Apache

...

HTTPD service

On macOS, the Apache HTTP Service should be installed but disabled by default. To validate it, you can check if command apachectl  exists or not:You can start the webserver with the command:

code
Code Block
languagebash
titleStart the webserver
$ sudo apachectl start

(If Apache HTTP Service is not installed, follow this page to download and install it.)

...

For example, after these steps your local repo should look similar to:

Code Block
languagebash
titleVerify your local fork
$ pwd
/Users/guozhang/git/kafka-site 

$ git remote -v
apache	https://github.com/apache/kafka-site.git (fetch)
apache	https://github.com/apache/kafka-site.git (push)
origin	https://github.com/guozhangwang/kafka-site.git (fetch)
origin	https://github.com/guozhangwang/kafka-site.git (push)

$ git checkout asf-site
 
$ git branch
* asf-site


3. Modify the Apache HTTPD configuration to point to your local fork

Now you need to edit the HTTPD config file and make the following changes.

Code Block
languagebash
titleEdit the webserver configuration
# The location of the configuration file may vary depending on the OS.
$ sudo vim /etc/apache2/httpd.conf

...


Step 1: Uncomment the following two lines so the "mod_include" and "mod_rewrite" modules are loaded on server startup.

...

Code Block
# File: /etc/apache2/httpd.conf
#
# DocumentRoot: The directory out of which you will serve your
# documents. By default, all requests are taken from this directory, but
# symbolic links and aliases may be used to point to other locations.
#
DocumentRoot "/Users/guozhang/git/kafka-site"             # <<< THIS LINE IS CHANGED
<Directory "/Users/guozhang/git/kafka-site">              # <<< THIS LINE IS CHANGED

    # Possible values for the Options directive are "None", "All",
    # or any combination of:
    #   Indexes Includes FollowSymLinks SymLinksifOwnerMatch ExecCGI MultiViews
    #
    # Note that "MultiViews" must be named *explicitly* --- "Options All"
    # doesn't give it to you.
    #
    # The Options directive is both complicated and important.  Please see
    # http://httpd.apache.org/docs/2.4/mod/core.html#options
    # for more information.
    #
    Options FollowSymLinks Multiviews
    MultiviewsMatch Any

    #
    # AllowOverride controls what directives may be placed in .htaccess files.
    # It can be "All", "None", or any combination of the keywords:
    #   AllowOverride FileInfo AuthConfig Limit
    #
    AllowOverride All                                     # <<< THIS LINE IS CHANGED

    # Controls who can get stuff from this server.
    #
    Require all granted

</Directory>


4. Reload the Apache

...

HTTPD configuration

Restart the webserver to make the config changes take effect:

Code Block
languagebash
titleRestart the webserver
$ sudo apachectl restart

# If the command above does not work (and you still see the default "It works!" page), try the following variant.
$ sudo apachectl -k restart

...

From now on, whenever you edited files in your local kafka-site fork, you should normally only need to refresh our browser (Cmd+R).  If this is not sufficient, you can repeat the step above (i.e., restarting the webserver) to see your latest changes in your browser. Remember to refresh any browser tabsto restart the webserver.

Info

Important Note: Your documentation changes should most likely be made in the main Apache Kafka code repository (https://github.com/apache/kafka) instead of the kafka-site repository, and in order to publish these changes to the Apache Kafka website (https://kafka.apache.org/) you should copy the modified documentation to the kafka-site repository into the respective release folders.

5. Shutdown the Apache

...

HTTPD service

If you want to shutdown the web server, run the command:

Code Block
languagebash
titleStop the webserver
$ sudo apachectl stop

# If the command above does not work (and the webserver is still running), try the following variant.
$ sudo apachectl -k stop

...