cassandra-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Anthony Grasso (JIRA)" <j...@apache.org>
Subject [jira] [Comment Edited] (CASSANDRA-14972) Provide a script or method to generate the entire website at the push of a button
Date Wed, 09 Jan 2019 06:40:00 GMT

    [ https://issues.apache.org/jira/browse/CASSANDRA-14972?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16737893#comment-16737893
] 

Anthony Grasso edited comment on CASSANDRA-14972 at 1/9/19 6:39 AM:
--------------------------------------------------------------------

The steps involved to generate the entire website from scratch are

# SVN checkout - [https://svn.apache.org/repos/asf/cassandra/site|https://svn.apache.org/repos/asf/cassandra/site]
# Git clone Cassandra - [git@github.com:apache/cassandra.git|https://github.com/apache/cassandra]
# Set the environment variable {{CASSANDRA_DIR}} to point to the SVN Cassandra checkout location
# Install *Ruby 2.3.x* and *Make* for building the website
# Install *Java 1.8.x*, *Ant*, *Maven*, *Python 2.7.x*, and *Python Sphinx* for generating
the Cassandra docs
# From the SVN Cassandra checkout install *Jekyll* - {{gem install bundler && bundle
install}}
# From the SVN Cassandra checkout _src_ directory run {{make add-doc}} to make the docs for
latest
# From the Git Cassandra checkout change to branch {{cassandra-3.11}} - {{git checkout cassandra-3.11}}
# From the SVN Cassandra checkout _src_ directory run {{make add-doc}} again to make the docs
for 3.11
# From the SVN Cassandra checkout _src_ directory run {{make}} to build the website

Probably the easiest way to do this is to have a Docker contain which installs all the tools
required to build the docs and the site. Inside of the container have an entry point script
which performs the tasks to generate the docs and the site.

This is my first take on it. These files are to be placed in the _svn.apache.org/repos/asf/cassandra/site_
directory.
* [^docker-compose.yml]
* [^docker-entrypoint.sh]
* [^Dockerfile] 



was (Author: anthony grasso):
The steps involved to generate the entire website from scratch are

# SVN checkout - [https://svn.apache.org/repos/asf/cassandra/site|https://svn.apache.org/repos/asf/cassandra/site]
# Git clone Cassandra - [git@github.com:apache/cassandra.git|https://github.com/apache/cassandra]
# Set the environment variable {{CASSANDRA_DIR}} to point to the SVN Cassandra checkout location
# Install *Ruby 2.3.x* and *Make* for building the website
# Install *Java 1.8.x*, *Python 2.7.x*, and *Python Sphinx* for generating the Cassandra docs
# From the SVN Cassandra checkout install *Jekyll* - {{gem install bundler && bundle
install}}
# From the SVN Cassandra checkout _src_ directory run {{make add-doc}} to make the docs for
latest
# From the Git Cassandra checkout change to branch {{cassandra-3.11}} - {{git checkout cassandra-3.11}}
# From the SVN Cassandra checkout _src_ directory run {{make add-doc}} again to make the docs
for 3.11
# From the SVN Cassandra checkout _src_ directory run {{make}} to build the website

Probably the easiest way to do this is to have a Docker contain which installs all the tools
required to build the docs and the site. Inside of the container have an entry point script
which performs the tasks to generate the docs and the site.

This is my first take on it. These files are to be placed in the _svn.apache.org/repos/asf/cassandra/site_
directory.
* [^docker-compose.yml]
* [^docker-entrypoint.sh]
* [^Dockerfile] 


> Provide a script or method to generate the entire website at the push of a button
> ---------------------------------------------------------------------------------
>
>                 Key: CASSANDRA-14972
>                 URL: https://issues.apache.org/jira/browse/CASSANDRA-14972
>             Project: Cassandra
>          Issue Type: Task
>          Components: Documentation/Website
>            Reporter: Anthony Grasso
>            Assignee: Anthony Grasso
>            Priority: Major
>         Attachments: Dockerfile, docker-compose.yml, docker-entrypoint.sh
>
>
> The process involved to generate the website involves two repositories (Git and SVN),
a range of tools, and a number of steps.
> It would be good to have a script or something similar which we run and it will generate
the entire website for us which is ready to commit back into SVN for publication.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cassandra.apache.org
For additional commands, e-mail: commits-help@cassandra.apache.org


Mime
View raw message