[
https://issues.apache.org/jira/browse/EAGLE-231?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Hao Chen updated EAGLE-231:
---------------------------
Description:
h1. Research
Learned from https://github.com/apache/spark/tree/master/docs and
https://github.com/apache/flink/tree/master/docs
The website should consist of two parts in git repository:
1) document branch: A shared Landing Page of Apache Eagle with some static
production introduction and also a list/menu navigation to different version of
document sites
2) master branch: a version specific documentation site under doc/ directory
When and How to release to apache SVN?
1) When having changes in landing page, build and commit the "document" branch
into SVN root directory: SVN_REPO/site
2) When releasing any new version say v0.3.0, build the current site under
docs/ and commit into SVN_REPO/site/docs/${CURRENT_VERSION}
It seems that flink is working in a more smart way, it trigger the docs build
for every branch and serve the doc sites build CI:
https://ci.apache.org/projects/
h1. Design
1. Use "document" branch to host the landing site.
2. Use "docs/" directory to host document contents and use Apache CI
https://ci.apache.org/projects/ to host and sync documentations by each
versions.
h1. TODO
1. Modify as consistant branch and tags name
branch: release-$version
tags: v$version
2. Create a new landing pages which contains some basic introduction and list
documents in different versions.
3. Add a new doc-style jekyll site into "docs/" for all branches
4. Add Setup a Jenkins/CI task to build docs/ into CI site.
was:
h1. Research
Learned from https://github.com/apache/spark/tree/master/docs and
https://github.com/apache/flink/tree/master/docs
The website should consist of two parts in git repository:
1) document branch: A shared Landing Page of Apache Eagle with some static
production introduction and also a list/menu navigation to different version of
document sites
2) master branch: a version specific documentation site under doc/ directory
When and How to release to apache SVN?
1) When having changes in landing page, build and commit the "document" branch
into SVN root directory: SVN_REPO/site
2) When releasing any new version say v0.3.0, build the current site under
docs/ and commit into SVN_REPO/site/docs/${CURRENT_VERSION}
It seems that flink is working in a more smart way, it trigger the docs build
for every branch and serve the doc sites build CI:
https://ci.apache.org/projects/
h1. Design
branch: relase-$version
tags: v$version
> Refactor Eagle Document Website
> -------------------------------
>
> Key: EAGLE-231
> URL: https://issues.apache.org/jira/browse/EAGLE-231
> Project: Eagle
> Issue Type: Bug
> Reporter: Hao Chen
> Assignee: Michael Wu
>
> h1. Research
> Learned from https://github.com/apache/spark/tree/master/docs and
> https://github.com/apache/flink/tree/master/docs
> The website should consist of two parts in git repository:
> 1) document branch: A shared Landing Page of Apache Eagle with some static
> production introduction and also a list/menu navigation to different version
> of document sites
> 2) master branch: a version specific documentation site under doc/ directory
> When and How to release to apache SVN?
> 1) When having changes in landing page, build and commit the "document"
> branch into SVN root directory: SVN_REPO/site
> 2) When releasing any new version say v0.3.0, build the current site under
> docs/ and commit into SVN_REPO/site/docs/${CURRENT_VERSION}
> It seems that flink is working in a more smart way, it trigger the docs build
> for every branch and serve the doc sites build CI:
> https://ci.apache.org/projects/
> h1. Design
> 1. Use "document" branch to host the landing site.
> 2. Use "docs/" directory to host document contents and use Apache CI
> https://ci.apache.org/projects/ to host and sync documentations by each
> versions.
> h1. TODO
> 1. Modify as consistant branch and tags name
> branch: release-$version
> tags: v$version
> 2. Create a new landing pages which contains some basic introduction and list
> documents in different versions.
> 3. Add a new doc-style jekyll site into "docs/" for all branches
> 4. Add Setup a Jenkins/CI task to build docs/ into CI site.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
