[
https://issues.apache.org/jira/browse/EAGLE-231?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Hao Chen updated EAGLE-231:
---------------------------
Description:
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.
was:
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}
> 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
>
> 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.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
