add left side-bars on example pages with contextual help references
Project: http://git-wip-us.apache.org/repos/asf/incubator-streams-examples/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-streams-examples/commit/3c1fbdee Tree: http://git-wip-us.apache.org/repos/asf/incubator-streams-examples/tree/3c1fbdee Diff: http://git-wip-us.apache.org/repos/asf/incubator-streams-examples/diff/3c1fbdee Branch: refs/heads/master Commit: 3c1fbdee2af9da666b0f1744ce04f714bc14d2c3 Parents: bed4b0f Author: Steve Blackmon @steveblackmon <[email protected]> Authored: Tue Oct 11 16:41:04 2016 -0500 Committer: Steve Blackmon @steveblackmon <[email protected]> Committed: Tue Oct 11 16:41:04 2016 -0500 ---------------------------------------------------------------------- .../flink-twitter-collection/src/site/site.xml | 28 ++++++++++++ flink/src/site/markdown/flink.md | 11 +++++ flink/src/site/site.xml | 25 +++++++++++ local/elasticsearch-hdfs/src/site/site.xml | 25 +++++++++++ local/elasticsearch-reindex/src/site/site.xml | 25 +++++++++++ .../mongo-elasticsearch-sync/src/site/site.xml | 33 ++++++++++++++ local/src/site/site.xml | 27 ++++++++++++ local/twitter-follow-neo4j/src/site/site.xml | 23 ++-------- .../src/site/site.xml | 45 ++++++++++++++++++++ .../src/site/site.xml | 45 ++++++++++++++++++++ 10 files changed, 267 insertions(+), 20 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-streams-examples/blob/3c1fbdee/flink/flink-twitter-collection/src/site/site.xml ---------------------------------------------------------------------- diff --git a/flink/flink-twitter-collection/src/site/site.xml b/flink/flink-twitter-collection/src/site/site.xml new file mode 100644 index 0000000..f801659 --- /dev/null +++ b/flink/flink-twitter-collection/src/site/site.xml @@ -0,0 +1,28 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<!-- + ~ 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 + ~ + ~ 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. + --> +<project> + <body> + <menu name="Credentials"> + <item name="Twitter" href="../../credentials/twitter.html"/> + </menu> + <menu name="Runtime"> + <item name="Flink" href="../flink.html"/> + </menu> + </body> +</project> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-streams-examples/blob/3c1fbdee/flink/src/site/markdown/flink.md ---------------------------------------------------------------------- diff --git a/flink/src/site/markdown/flink.md b/flink/src/site/markdown/flink.md new file mode 100644 index 0000000..ed96496 --- /dev/null +++ b/flink/src/site/markdown/flink.md @@ -0,0 +1,11 @@ +## Flink + +Create a local file `flink.conf` + + local = true + test = true + +When configuring a stream, include this files: + + include "flink.conf" + http://git-wip-us.apache.org/repos/asf/incubator-streams-examples/blob/3c1fbdee/flink/src/site/site.xml ---------------------------------------------------------------------- diff --git a/flink/src/site/site.xml b/flink/src/site/site.xml new file mode 100644 index 0000000..382b3f2 --- /dev/null +++ b/flink/src/site/site.xml @@ -0,0 +1,25 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<!-- + ~ 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 + ~ + ~ 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. + --> +<project> + <body> + <menu name="Runtime"> + <item name="Flink" href="../flink.html"/> + </menu> + </body> +</project> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-streams-examples/blob/3c1fbdee/local/elasticsearch-hdfs/src/site/site.xml ---------------------------------------------------------------------- diff --git a/local/elasticsearch-hdfs/src/site/site.xml b/local/elasticsearch-hdfs/src/site/site.xml new file mode 100644 index 0000000..2520343 --- /dev/null +++ b/local/elasticsearch-hdfs/src/site/site.xml @@ -0,0 +1,25 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<!-- + ~ 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 + ~ + ~ 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. + --> +<project> + <body> + <menu name="Services"> + <item name="Elasticsearch" href="../../services/elasticsearch.html"/> + </menu> + </body> +</project> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-streams-examples/blob/3c1fbdee/local/elasticsearch-reindex/src/site/site.xml ---------------------------------------------------------------------- diff --git a/local/elasticsearch-reindex/src/site/site.xml b/local/elasticsearch-reindex/src/site/site.xml new file mode 100644 index 0000000..2520343 --- /dev/null +++ b/local/elasticsearch-reindex/src/site/site.xml @@ -0,0 +1,25 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<!-- + ~ 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 + ~ + ~ 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. + --> +<project> + <body> + <menu name="Services"> + <item name="Elasticsearch" href="../../services/elasticsearch.html"/> + </menu> + </body> +</project> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-streams-examples/blob/3c1fbdee/local/mongo-elasticsearch-sync/src/site/site.xml ---------------------------------------------------------------------- diff --git a/local/mongo-elasticsearch-sync/src/site/site.xml b/local/mongo-elasticsearch-sync/src/site/site.xml new file mode 100644 index 0000000..92baae0 --- /dev/null +++ b/local/mongo-elasticsearch-sync/src/site/site.xml @@ -0,0 +1,33 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<!-- + ~ 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 + ~ + ~ 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. + --> +<project> + <custom> + <fluidoSkin> + <topBarEnabled>false</topBarEnabled> + <navBarStyle>navbar-inverse</navBarStyle> + <sideBarEnabled>true</sideBarEnabled> + </fluidoSkin> + </custom> + <body> + <menu name="Services"> + <item name="Elasticsearch" href="../../services/elasticsearch.html"/> + <item name="Mongo" href="../../services/mongo.html"/> + </menu> + </body> +</project> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-streams-examples/blob/3c1fbdee/local/src/site/site.xml ---------------------------------------------------------------------- diff --git a/local/src/site/site.xml b/local/src/site/site.xml new file mode 100644 index 0000000..f9fbfac --- /dev/null +++ b/local/src/site/site.xml @@ -0,0 +1,27 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<!-- + ~ 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 + ~ + ~ 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. + --> +<project> + <custom> + <fluidoSkin> + <topBarEnabled>false</topBarEnabled> + <navBarStyle>navbar-inverse</navBarStyle> + <sideBarEnabled>true</sideBarEnabled> + </fluidoSkin> + </custom> +</project> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-streams-examples/blob/3c1fbdee/local/twitter-follow-neo4j/src/site/site.xml ---------------------------------------------------------------------- diff --git a/local/twitter-follow-neo4j/src/site/site.xml b/local/twitter-follow-neo4j/src/site/site.xml index a25bae0..1d1471a 100644 --- a/local/twitter-follow-neo4j/src/site/site.xml +++ b/local/twitter-follow-neo4j/src/site/site.xml @@ -17,29 +17,12 @@ ~ under the License. --> <project> - <custom> - <fluidoSkin> - <topBarEnabled>false</topBarEnabled> - <navBarStyle>navbar-inverse</navBarStyle> - <sideBarEnabled>true</sideBarEnabled> - <!--<gitHub>--> - <!--<projectId>apache/incubator-streams-examples</projectId>--> - <!--<ribbonOrientation>right</ribbonOrientation>--> - <!--<ribbonColor>black</ribbonColor>--> - <!--</gitHub>--> - <!--<twitter>--> - <!--<user>ApacheStreams</user>--> - <!--<showUser>true</showUser>--> - <!--<showFollowers>true</showFollowers>--> - <!--</twitter>--> - </fluidoSkin> - </custom> <body> - <menu name="Configuration"> - <item name="Neo4j" href="../../services/neo4j.html"/> - </menu> <menu name="Credentials"> <item name="Twitter" href="../../credentials/twitter.html"/> </menu> + <menu name="Services"> + <item name="Neo4j" href="../../services/neo4j.html"/> + </menu> </body> </project> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-streams-examples/blob/3c1fbdee/local/twitter-history-elasticsearch/src/site/site.xml ---------------------------------------------------------------------- diff --git a/local/twitter-history-elasticsearch/src/site/site.xml b/local/twitter-history-elasticsearch/src/site/site.xml new file mode 100644 index 0000000..0fafb0e --- /dev/null +++ b/local/twitter-history-elasticsearch/src/site/site.xml @@ -0,0 +1,45 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<!-- + ~ 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 + ~ + ~ 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. + --> +<project> + <custom> + <fluidoSkin> + <topBarEnabled>false</topBarEnabled> + <navBarStyle>navbar-inverse</navBarStyle> + <sideBarEnabled>true</sideBarEnabled> + <!--<gitHub>--> + <!--<projectId>apache/incubator-streams-examples</projectId>--> + <!--<ribbonOrientation>right</ribbonOrientation>--> + <!--<ribbonColor>black</ribbonColor>--> + <!--</gitHub>--> + <!--<twitter>--> + <!--<user>ApacheStreams</user>--> + <!--<showUser>true</showUser>--> + <!--<showFollowers>true</showFollowers>--> + <!--</twitter>--> + </fluidoSkin> + </custom> + <body> + <menu name="Credentials"> + <item name="Twitter" href="../../credentials/twitter.html"/> + </menu> + <menu name="Services"> + <item name="Elasticsearch" href="../../services/elasticsearch.html"/> + </menu> + </body> +</project> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-streams-examples/blob/3c1fbdee/local/twitter-userstream-elasticsearch/src/site/site.xml ---------------------------------------------------------------------- diff --git a/local/twitter-userstream-elasticsearch/src/site/site.xml b/local/twitter-userstream-elasticsearch/src/site/site.xml new file mode 100644 index 0000000..0fafb0e --- /dev/null +++ b/local/twitter-userstream-elasticsearch/src/site/site.xml @@ -0,0 +1,45 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<!-- + ~ 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 + ~ + ~ 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. + --> +<project> + <custom> + <fluidoSkin> + <topBarEnabled>false</topBarEnabled> + <navBarStyle>navbar-inverse</navBarStyle> + <sideBarEnabled>true</sideBarEnabled> + <!--<gitHub>--> + <!--<projectId>apache/incubator-streams-examples</projectId>--> + <!--<ribbonOrientation>right</ribbonOrientation>--> + <!--<ribbonColor>black</ribbonColor>--> + <!--</gitHub>--> + <!--<twitter>--> + <!--<user>ApacheStreams</user>--> + <!--<showUser>true</showUser>--> + <!--<showFollowers>true</showFollowers>--> + <!--</twitter>--> + </fluidoSkin> + </custom> + <body> + <menu name="Credentials"> + <item name="Twitter" href="../../credentials/twitter.html"/> + </menu> + <menu name="Services"> + <item name="Elasticsearch" href="../../services/elasticsearch.html"/> + </menu> + </body> +</project> \ No newline at end of file
