The AAS WorldWide Telescope Infrastructure guide.
Перейти к файлу
Peter Williams 6601d9302d
Merge pull request #6 from WorldWideTelescope/ga4
config.toml: update Google Analytics ID for GA4 migration
2023-08-03 21:16:36 +00:00
content content/appendix-build-agent.md: update for latest iteration 2022-03-30 23:28:39 -04:00
themes themes/wwtguide: update 2022-01-05 14:21:59 -05:00
.gitignore Initial development 2020-04-21 15:33:16 -04:00
.gitmodules Initial development 2020-04-21 15:33:16 -04:00
README.md README.md: add Azure Pipelines status badge 2020-04-22 11:46:57 -04:00
azure-pipelines.yml Initial development 2020-04-21 15:33:16 -04:00
config.toml config.toml: update Google Analytics ID for GA4 migration 2023-08-03 17:00:15 -04:00

README.md

Build Status

WWT Infrastructure Guide: Source Code

This repository contains the source code for the WWT Infrastructure Guide. The master branch of this repo gets published here:

https://docs.worldwidetelescope.org/infrastructure-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.

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.

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.

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.