commit 7cb47e13433d0f079097a956a2e262dd1b6ffa1e Author: Peter Williams Date: Mon Apr 13 16:04:54 2020 -0400 Initial import diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..87174b6 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +/public/ diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 0000000..02fe3f9 --- /dev/null +++ b/.gitmodules @@ -0,0 +1,3 @@ +[submodule "themes/wwtguide"] + path = themes/wwtguide + url = https://github.com/WorldWideTelescope/zola-wwtguide.git diff --git a/README.md b/README.md new file mode 100644 index 0000000..2b2c859 --- /dev/null +++ b/README.md @@ -0,0 +1,72 @@ +# WWT Tour Authoring Guide: Source Code + +This repository contains the source code for the [WWT Tour Authoring Guide]. +The `master` branch of this repo gets published here: + +### https://docs.worldwidetelescope.org/tour-authoring-guide/1/ + +[WWT Tour Authoring Guide]: https://docs.worldwidetelescope.org/tour-authoring-guide/1/ + +If you’re just interested in the documentation itself, you should go to that +website. If you’re interested in *contributing* to this documentation, you’ve +come to the right place! + + +## Quick Start for the Initiated + +The guide is a static site written in [CommonMark Markdown] and processed +with [Zola]. Zola is distributed as a single executable so it is ridiculously +[easy to install][install-zola]. + +This repository is themed by referencing [zola-wwtguide] as a submodule, so +upon first checkout you’ll have to run: + +``` +git submodule update --init +``` + +Once everything is set up, all you have to do is run + +``` +zola serve +``` + +to build the site and serve it locally for testing. The command `zola check` +will check the build and verify that outgoing links are valid. Zola has +[lots of documentation][zola-docs]. + +[CommonMark Markdown]: https://commonmark.org/ +[Zola]: https://getzola.org/ +[install-zola]: https://www.getzola.org/documentation/getting-started/installation/ +[zola-wwtguide]: https://github.com/WorldWideTelescope/zola-wwtguide +[zola-docs]: https://www.getzola.org/documentation/getting-started/overview/ + +Merges to `master` will be published automatically using WWT’s continuous +deployment infrastructure. + + +## Contributing + +Contributions are welcome! If you’re new to the project, please see the +[WWT Contributors’ Guide] and the [WWT Code of Conduct]. We operate with a +standard [fork-and-pull] model. + +[WWT Contributors’ Guide]: https://worldwidetelescope.github.io/contributing/ +[WWT Code of Conduct]: https://worldwidetelescope.github.io/code-of-conduct/ +[fork-and-pull]: https://help.github.com/en/articles/about-collaborative-development-models + + +## Acknowledgments + +The AAS WorldWide Telescope system is a [.NET Foundation] project managed by +the non-profit [American Astronomical Society] (AAS). Work on WWT has been +supported by the AAS, the US [National Science Foundation] (grants [1550701] +and [1642446]), the [Gordon and Betty Moore Foundation], and [Microsoft]. + +[.NET Foundation]: https://dotnetfoundation.org/ +[American Astronomical Society]: https://aas.org/ +[National Science Foundation]: https://www.nsf.gov/ +[1550701]: https://www.nsf.gov/awardsearch/showAward?AWD_ID=1550701 +[1642446]: https://www.nsf.gov/awardsearch/showAward?AWD_ID=1642446 +[Gordon and Betty Moore Foundation]: https://www.moore.org/ +[Microsoft]: https://www.microsoft.com/ diff --git a/azure-pipelines.yml b/azure-pipelines.yml new file mode 100644 index 0000000..1cdbe03 --- /dev/null +++ b/azure-pipelines.yml @@ -0,0 +1,17 @@ +resources: + repositories: + - repository: wwtguide + type: github + name: WorldWideTelescope/zola-wwtguide + endpoint: wwtelescope + +jobs: +- template: azure-build-and-publish.yml@wwtguide + parameters: + azureServiceConnectionName: 'aas@wwtadmindotnetfoundation' + storageAccountName: 'wwtwebstatic' + cdnEndpointName: 'wwtwebdocs-prod' + cdnProfileName: 'wwt-cdn-01' + cdnPubPrefix: '/tour-authoring-guide/1' + cdnResourceGroupName: 'wwt-web01' + pubPrefix: '_docs/tour-authoring-guide/1' diff --git a/config.toml b/config.toml new file mode 100644 index 0000000..62d33a3 --- /dev/null +++ b/config.toml @@ -0,0 +1,9 @@ +base_url = "//docs.worldwidetelescope.org/tour-authoring-guide/1/" +title = "WWT Tour Authoring Guide" +description = "Creating AAS WorldWide Telescope tours." +theme = "wwtguide" +highlight_code = true + +[extra] +github_base = "//github.com/WorldWideTelescope/worldwide-telescope-tour-authoring-guide" +google_analytics_id = "UA-107473046-3" diff --git a/content/_index.md b/content/_index.md new file mode 100644 index 0000000..5920ce5 --- /dev/null +++ b/content/_index.md @@ -0,0 +1,28 @@ ++++ +title = "WWT Tour Authoring Guide" +sort_by = "weight" +insert_anchor_links = "right" ++++ + +[AAS WorldWide Telescope][wwt] “tours” are scripted, multimedia experiences +that guide the viewer through WWT’s simulated universe. Imagine a PowerPoint +presentation that explores 3D space and time, with annotations, links, and +interactive elements. + +[wwt]: https://worldwidetelescope.org/home + +This guide covers relatively advanced topics on the subject of tour authoring. +To learn how to play back existing tours and how to create basic tours, +consult [the Guided Tours section of the User Manual][manual-guided-tours]. + +[manual-guided-tours]: https://docs.worldwidetelescope.org/user-manual/1/guidedtours/ + +Sophisticated tours often create compelling visual effects by adding one or +more specialized graphical “layers” to the WWT engine. Consult the +[Layer Guide][layer-guide] to learn how to create custom layers and the +[Data Guide][data-guide] to learn about the data formats that can be imported +into WWT, as well as the tools that will help you perform any necessary format +conversions. + +[layer-guide]: https://docs.worldwidetelescope.org/layer-guide/1/ +[data-guide]: https://docs.worldwidetelescope.org/data-guide/1/ diff --git a/themes/wwtguide b/themes/wwtguide new file mode 160000 index 0000000..350435f --- /dev/null +++ b/themes/wwtguide @@ -0,0 +1 @@ +Subproject commit 350435f9f35f1d19ca6b02e21f10362c746dab4f