----------------------------------------------------------- This is an automatically generated e-mail. To reply, visit: https://reviews.apache.org/r/24482/#review50091 -----------------------------------------------------------
The Archive section is useful, but I wonder if we can figure out a way to let people switch versions when they're in the context of the page they're looking at. For example, if I'm looking at some specific doc, and I'm on master, it's easier if there's just a link on that page to switch THAT page to 0.7.0, rather than have to go in through the Archive page and then navigate back out. Maybe we can have a "versioned" template that all versioned .md files use. I'm not sure quite how this would work, but it might be worth poking around. docs/README.md <https://reviews.apache.org/r/24482/#comment87630> Not quite sure what this means. To run locally, you have to run replace-versioned.sh? docs/README.md <https://reviews.apache.org/r/24482/#comment87628> Do we need to update this section? docs/_config.yml <https://reviews.apache.org/r/24482/#comment87631> If you move replaced-version.sh to bin, make sure to update exclude. docs/_layouts/default.html <https://reviews.apache.org/r/24482/#comment87633> Whitespace. docs/_layouts/default.html <https://reviews.apache.org/r/24482/#comment87635> We should find a font awesome icon, and use it. Maybe fa-history (http://fortawesome.github.io/Font-Awesome/icon/history/) ? docs/replace-versioned.sh <https://reviews.apache.org/r/24482/#comment87629> Can we put this file in the _docs/bin directory? Also, should probably do a sanity check on the version variable to make sure it's not empty, in case _config.yml changes over time. - Chris Riccomini On Aug. 8, 2014, 12:06 a.m., Yan Fang wrote: > > ----------------------------------------------------------- > This is an automatically generated e-mail. To reply, visit: > https://reviews.apache.org/r/24482/ > ----------------------------------------------------------- > > (Updated Aug. 8, 2014, 12:06 a.m.) > > > Review request for samza. > > > Bugs: SAMZA-259 > https://issues.apache.org/jira/browse/SAMZA-259 > > > Repository: samza > > > Description > ------- > > Restructure documentation folders > > main changes: > > 1. replace "0.7.0" directory to "versioned" in img/, learn/documentations/, > learn/tutorials and startup/hello-samza > 2. replace all found /0.7.0 with /site.version > 5. add calling replace-versioned.sh in bin/publish-site.sh > 7. remove the requirement of inputting version number when run > publish-site.sh > 8. add a category called "Archive" in _layouts/default.html. That is for > putting links to old version documents. > 9. change the link to 0.7.0 in _layouts/default.html to master, because we > are using the master version as the default links for all the sidebars links. > > > Diffs > ----- > > bin/generate-javadocs.sh 112684f > bin/publish-site.sh 8da57a9 > docs/README.md de5fc23 > docs/_config.yml 2f2f895 > docs/_layouts/default.html 5bea47a > docs/archive/index.html PRE-CREATION > docs/img/0.7.0/learn/documentation/comparisons/mupd8-samza.png > 5882cea1ad03c50c9768e26904f90598af5ac0ec > docs/img/0.7.0/learn/documentation/comparisons/mupd8.png > ca7998269004d1aae0f328da16df8149536d16c4 > docs/img/0.7.0/learn/documentation/container/checkpointing.svg 676cd7c > docs/img/0.7.0/learn/documentation/container/stateful_job.png > e48607949b40a424293ecae0c297a0835d261079 > docs/img/0.7.0/learn/documentation/container/stream_job_and_db.png > 8ad0af3cb40181ec1105cd51e5f290745f59c962 > docs/img/0.7.0/learn/documentation/container/tasks-and-partitions.svg > f73b14d > docs/img/0.7.0/learn/documentation/introduction/dag.graffle d743ea4 > docs/img/0.7.0/learn/documentation/introduction/dag.png > d0df7e3a66df2e254bc9c9e6fc7eff606ef27f82 > docs/img/0.7.0/learn/documentation/introduction/group-by-example.png > 8584600b6c532ce1c455ee609188b0e08d1cd422 > docs/img/0.7.0/learn/documentation/introduction/job.graffle 2c5a994 > docs/img/0.7.0/learn/documentation/introduction/job.png > 4a90b8c60b9a42f958535471ab04968ab367c7f6 > docs/img/0.7.0/learn/documentation/introduction/job_detail.graffle 1583d55 > docs/img/0.7.0/learn/documentation/introduction/job_detail.png > 31f67070c2737880f38514b90587226c72a536bb > docs/img/0.7.0/learn/documentation/introduction/samza-ecosystem.png > 4eb9f334271e5d3d712b3797946d5ed2000479c0 > docs/img/0.7.0/learn/documentation/introduction/samza-hadoop.png > 2142f949356da03d4c4f160f0a47a8f4e8aad1f6 > docs/img/0.7.0/learn/documentation/introduction/samza-yarn-integration.png > 2748713274151a0af04b8131732566670f15e27b > > docs/img/0.7.0/learn/documentation/introduction/samza-yarn-kafka-integration.png > c897499375e3835a271fd77a1d78815596ab3419 > docs/img/0.7.0/learn/documentation/introduction/samza_state.graffle 2427ce3 > docs/img/0.7.0/learn/documentation/introduction/samza_state.png > 80a2df667066ce1d64ed54858ac352aefc4e5b63 > docs/img/0.7.0/learn/documentation/introduction/stream.graffle 5281bf5 > docs/img/0.7.0/learn/documentation/introduction/stream.png > e190041441208d5c1801410e904fd64560f7a72f > > docs/img/0.7.0/learn/documentation/motivation/data-processing-spectrum-1.png > bf2155b0391690efd5bc3fef5ba85f278839088e > > docs/img/0.7.0/learn/documentation/motivation/data-processing-spectrum-2.png > 22f7eeb2f287c2ca21274f2380d85b442f1a16cc > > docs/img/0.7.0/learn/documentation/motivation/data-processing-spectrum-3.png > 3c9ff05323cb56c56e83d4f3b31d050594415cc4 > docs/img/0.7.0/learn/documentation/yarn/samza-am-dashboard.png > 949a2f0c70b95247255e705e9d910f77de610db2 > docs/img/versioned/learn/documentation/comparisons/mupd8-samza.png > PRE-CREATION > docs/img/versioned/learn/documentation/comparisons/mupd8.png PRE-CREATION > docs/img/versioned/learn/documentation/container/checkpointing.svg > PRE-CREATION > docs/img/versioned/learn/documentation/container/stateful_job.png > PRE-CREATION > docs/img/versioned/learn/documentation/container/stream_job_and_db.png > PRE-CREATION > docs/img/versioned/learn/documentation/container/tasks-and-partitions.svg > PRE-CREATION > docs/img/versioned/learn/documentation/introduction/dag.graffle > PRE-CREATION > docs/img/versioned/learn/documentation/introduction/dag.png PRE-CREATION > docs/img/versioned/learn/documentation/introduction/group-by-example.png > PRE-CREATION > docs/img/versioned/learn/documentation/introduction/job.graffle > PRE-CREATION > docs/img/versioned/learn/documentation/introduction/job.png PRE-CREATION > docs/img/versioned/learn/documentation/introduction/job_detail.graffle > PRE-CREATION > docs/img/versioned/learn/documentation/introduction/job_detail.png > PRE-CREATION > docs/img/versioned/learn/documentation/introduction/samza-ecosystem.png > PRE-CREATION > docs/img/versioned/learn/documentation/introduction/samza-hadoop.png > PRE-CREATION > > docs/img/versioned/learn/documentation/introduction/samza-yarn-integration.png > PRE-CREATION > > docs/img/versioned/learn/documentation/introduction/samza-yarn-kafka-integration.png > PRE-CREATION > docs/img/versioned/learn/documentation/introduction/samza_state.graffle > PRE-CREATION > docs/img/versioned/learn/documentation/introduction/samza_state.png > PRE-CREATION > docs/img/versioned/learn/documentation/introduction/stream.graffle > PRE-CREATION > docs/img/versioned/learn/documentation/introduction/stream.png PRE-CREATION > > docs/img/versioned/learn/documentation/motivation/data-processing-spectrum-1.png > PRE-CREATION > > docs/img/versioned/learn/documentation/motivation/data-processing-spectrum-2.png > PRE-CREATION > > docs/img/versioned/learn/documentation/motivation/data-processing-spectrum-3.png > PRE-CREATION > docs/img/versioned/learn/documentation/yarn/samza-am-dashboard.png > PRE-CREATION > docs/index.md 298ea43 > docs/learn/documentation/0.7.0/api/overview.md 6712344 > docs/learn/documentation/0.7.0/comparisons/introduction.md e6b16d4 > docs/learn/documentation/0.7.0/comparisons/mupd8.md 53417f9 > docs/learn/documentation/0.7.0/comparisons/spark-streaming.md b8a521f > docs/learn/documentation/0.7.0/comparisons/storm.md 58cb508 > docs/learn/documentation/0.7.0/container/checkpointing.md 4efcef8 > docs/learn/documentation/0.7.0/container/event-loop.md f0f21b0 > docs/learn/documentation/0.7.0/container/jmx.md bdd5614 > docs/learn/documentation/0.7.0/container/metrics.md 8ec7740 > docs/learn/documentation/0.7.0/container/samza-container.md ab4f0e4 > docs/learn/documentation/0.7.0/container/serialization.md ff7d8b9 > docs/learn/documentation/0.7.0/container/state-management.md e54739c > docs/learn/documentation/0.7.0/container/streams.md 59e0855 > docs/learn/documentation/0.7.0/container/windowing.md b10e5d4 > docs/learn/documentation/0.7.0/index.html 626631b > docs/learn/documentation/0.7.0/introduction/architecture.md 46987e5 > docs/learn/documentation/0.7.0/introduction/background.md e09497b > docs/learn/documentation/0.7.0/introduction/concepts.md dacc6af > docs/learn/documentation/0.7.0/jobs/configuration-table.html ea6b1ef > docs/learn/documentation/0.7.0/jobs/configuration.md 8bcc433 > docs/learn/documentation/0.7.0/jobs/job-runner.md c2f6b09 > docs/learn/documentation/0.7.0/jobs/logging.md 5b78d7f > docs/learn/documentation/0.7.0/jobs/packaging.md 9e55f9a > docs/learn/documentation/0.7.0/jobs/reprocessing.md 28d9925 > docs/learn/documentation/0.7.0/jobs/yarn-jobs.md 58ca50d > docs/learn/documentation/0.7.0/operations/kafka.md 29833e4 > docs/learn/documentation/0.7.0/operations/security.md b7ef24e > docs/learn/documentation/0.7.0/yarn/application-master.md 6b81805 > docs/learn/documentation/0.7.0/yarn/isolation.md 1eb3bf5 > docs/learn/documentation/versioned/api/overview.md PRE-CREATION > docs/learn/documentation/versioned/comparisons/introduction.md PRE-CREATION > docs/learn/documentation/versioned/comparisons/mupd8.md PRE-CREATION > docs/learn/documentation/versioned/comparisons/spark-streaming.md > PRE-CREATION > docs/learn/documentation/versioned/comparisons/storm.md PRE-CREATION > docs/learn/documentation/versioned/container/checkpointing.md PRE-CREATION > docs/learn/documentation/versioned/container/event-loop.md PRE-CREATION > docs/learn/documentation/versioned/container/jmx.md PRE-CREATION > docs/learn/documentation/versioned/container/metrics.md PRE-CREATION > docs/learn/documentation/versioned/container/samza-container.md > PRE-CREATION > docs/learn/documentation/versioned/container/serialization.md PRE-CREATION > docs/learn/documentation/versioned/container/state-management.md > PRE-CREATION > docs/learn/documentation/versioned/container/streams.md PRE-CREATION > docs/learn/documentation/versioned/container/windowing.md PRE-CREATION > docs/learn/documentation/versioned/index.html PRE-CREATION > docs/learn/documentation/versioned/introduction/architecture.md > PRE-CREATION > docs/learn/documentation/versioned/introduction/background.md PRE-CREATION > docs/learn/documentation/versioned/introduction/concepts.md PRE-CREATION > docs/learn/documentation/versioned/jobs/configuration-table.html > PRE-CREATION > docs/learn/documentation/versioned/jobs/configuration.md PRE-CREATION > docs/learn/documentation/versioned/jobs/job-runner.md PRE-CREATION > docs/learn/documentation/versioned/jobs/logging.md PRE-CREATION > docs/learn/documentation/versioned/jobs/packaging.md PRE-CREATION > docs/learn/documentation/versioned/jobs/reprocessing.md PRE-CREATION > docs/learn/documentation/versioned/jobs/yarn-jobs.md PRE-CREATION > docs/learn/documentation/versioned/operations/kafka.md PRE-CREATION > docs/learn/documentation/versioned/operations/security.md PRE-CREATION > docs/learn/documentation/versioned/yarn/application-master.md PRE-CREATION > docs/learn/documentation/versioned/yarn/isolation.md PRE-CREATION > docs/learn/tutorials/0.7.0/deploy-samza-job-from-hdfs.md ab33dd3 > docs/learn/tutorials/0.7.0/index.md 91bddc5 > docs/learn/tutorials/0.7.0/remote-debugging-samza.md 89d0856 > docs/learn/tutorials/0.7.0/run-hello-samza-without-internet.md a5503ef > docs/learn/tutorials/0.7.0/run-in-multi-node-yarn.md c079233 > docs/learn/tutorials/versioned/deploy-samza-job-from-hdfs.md PRE-CREATION > docs/learn/tutorials/versioned/index.md PRE-CREATION > docs/learn/tutorials/versioned/remote-debugging-samza.md PRE-CREATION > docs/learn/tutorials/versioned/run-hello-samza-without-internet.md > PRE-CREATION > docs/learn/tutorials/versioned/run-in-multi-node-yarn.md PRE-CREATION > docs/replace-versioned.sh PRE-CREATION > docs/startup/download/index.md 6ee6b1f > docs/startup/hello-samza/0.7.0/index.md 92d5ba2 > docs/startup/hello-samza/versioned/index.md PRE-CREATION > > Diff: https://reviews.apache.org/r/24482/diff/ > > > Testing > ------- > > > Thanks, > > Yan Fang > >
