| commit | 0c8fbed72564a5cca86be15544e55f6f8d82276c | [log] [tgz] |
|---|---|---|
| author | Colm O hEigeartaigh <coheigea@apache.org> | Fri Jan 05 13:39:10 2018 +0800 |
| committer | Hao Chen <hchen9@ebay.com> | Fri Jan 05 13:39:10 2018 +0800 |
| tree | 432afe682690634e8e42650acc810effb41704b4 | |
| parent | 7b4cbde1f8ed5eff64115bb976edfc32e5f69f9e [diff] |
[EAGLE-1072] Fixing SHA link
<!--
{% 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 %}
-->
Be sure to do all of the following to help us incorporate your contribution
quickly and easily:
- [ ] Make sure the PR title is formatted like:
`[EAGLE-<Jira issue #>] Description of pull request`
- [ ] Make sure tests pass via `mvn clean verify`. (Even better, enable
Travis-CI on your fork and ensure the whole test matrix passes).
- [ ] Replace `<Jira issue #>` in the title with the actual Jira issue
number, if there is one.
- [ ] If this contribution is large, please file an Apache
[Individual Contributor License Agreement](https://www.apache.org/licenses/icla.txt).
---
Author: Colm O hEigeartaigh <coheigea@apache.org>
Closes #974 from coheigea/EAGLE-1072.
Welcome to the Apache Eagle documentation!
Install jekyll gem
$ gem install jekyll
Generate the site, and start a server locally:
$ jekyll serve -w
The -w option tells jekyll to watch for changes to files and regenerate the site automatically when any content changes.
Point your browser to http://localhost:4000
By default, jekyll will generate the site in a _site directory.
Create a markdown file and add following content in header
--- layout: doc title: "Eagle Overview" permalink: /docs/some-new-doc.html --- More content here ..
Register the link in documentations sidebar navigation
documentations:
- category: "Some category"
links:
- title: Some new doc
url: /docs/some-new-doc.html
In order to publish the website, you must have committer access to Eagle's subversion repository.
The Eagle website is published using Apache svnpubsub. Any changes committed to subversion will be automatically published to eagle.apache.org.
To publish changes, tell jekyll to generate the site in the publish directory of subversion, then commit the changes:
cd docs jekyll build -d /path/to/svn/repo/publish cd /path/to/svn/repo/publish svn commit