Skip to content
Permalink
Browse files
Move site into subdirectory; add README, README.md, HOWTO.md
  • Loading branch information
julianhyde authored and lresende committed Dec 4, 2015
1 parent da0d477 commit 97bba539e88e3b7f8e6e0df3e08a0984f10d10c6
Showing 68 changed files with 99 additions and 0 deletions.
@@ -0,0 +1,59 @@
<!--
{% comment %}
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to you under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
{% endcomment %}
-->

# How to deploy your project's web site

(In the following instructions we assume that your project is called
'Apache Foo'; search and replace with your actual project name.)

## Setup

1. `cd site`
2. svn co https://svn.apache.org/repos/asf/foo/site target
3. `sudo apt-get install rubygems ruby2.1-dev zlib1g-dev` (linux)
4. `sudo gem install bundler github-pages jekyll`
5. `bundle install`

## Add javadoc

If your project supports javadoc, you can copy the generated javadoc
into svn each time you need to re-generate.

1. `cd ..`
2. `mvn -DskipTests site`
3. `mv target/site/apidocs site/target`

## Running locally

Before opening a pull request, you can preview your contributions by
running from within the directory:

1. `bundle exec jekyll serve`
2. Open [http://localhost:4000](http://localhost:4000)

## Pushing to site

1. `cd site/target`
2. `svn status`
3. You'll need to `svn add` any new files
4. `svn ci`

Within a few minutes, svnpubsub should kick in and you'll be able to
see the results at
[foo.apache.org](https://foo.apache.org/).
9 README
@@ -0,0 +1,9 @@
Apache Website Template release 0.0.1

This is a source or binary distribution of Apache Website Template.

The LICENSE and NOTICE files contain license information.

README.md explains the purpose of this project, how to generate and
deploy a simple web site based on this template, and how to create a
web site for your project based on this template.
@@ -0,0 +1,31 @@
<!--
{% comment %}
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to you under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
{% endcomment %}
-->

# Apache Website Template

This project contains a template web site, generated using
[Jekyll](https://jekyllrb.com/).

To use it, copy the `site` directory into your project. You must also
include licensing information from the `LICENSE` and `NOTICE` files in
your own project. And, we suggest that you include the
[HOWTO](HOWTO.md) instructions to allow your committers to modify and deploy the site.

You can see an example of the site at
[apache-website-template.hydromatic.net](https://apache-website-template.hydromatic.net/).
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit 97bba53

Please sign in to comment.