This commit is contained in:
Peter Williams 2020-04-13 16:04:54 -04:00
Коммит 7cb47e1343
7 изменённых файлов: 131 добавлений и 0 удалений

1
.gitignore поставляемый Normal file
Просмотреть файл

@ -0,0 +1 @@
/public/

3
.gitmodules поставляемый Normal file
Просмотреть файл

@ -0,0 +1,3 @@
[submodule "themes/wwtguide"]
path = themes/wwtguide
url = https://github.com/WorldWideTelescope/zola-wwtguide.git

72
README.md Normal file
Просмотреть файл

@ -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 youre just interested in the documentation itself, you should go to that
website. If youre interested in *contributing* to this documentation, youve
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 youll 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 WWTs continuous
deployment infrastructure.
## Contributing
Contributions are welcome! If youre 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/

17
azure-pipelines.yml Normal file
Просмотреть файл

@ -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'

9
config.toml Normal file
Просмотреть файл

@ -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"

28
content/_index.md Normal file
Просмотреть файл

@ -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 WWTs 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/

1
themes/wwtguide Submodule

@ -0,0 +1 @@
Subproject commit 350435f9f35f1d19ca6b02e21f10362c746dab4f