diff --git a/CHANGELOG.md b/CHANGELOG.md index 86bbde4..c4ac525 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,10 @@ ## [Unreleased] +## [2.9.6] - 2017-10-03 +### Added +- Migrate to Read the Docs for [documentation](http://batch-shipyard.readthedocs.io/en/latest/) + ### Fixed - RemoteFS disk attach fixes - Nvidia docker volume mount check @@ -861,7 +865,8 @@ transfer is disabled #### Added - Initial release -[Unreleased]: https://github.com/Azure/batch-shipyard/compare/2.9.5...HEAD +[Unreleased]: https://github.com/Azure/batch-shipyard/compare/2.9.6...HEAD +[2.9.6]: https://github.com/Azure/batch-shipyard/compare/2.9.5...2.9.6 [2.9.5]: https://github.com/Azure/batch-shipyard/compare/2.9.4...2.9.5 [2.9.4]: https://github.com/Azure/batch-shipyard/compare/2.9.3...2.9.4 [2.9.3]: https://github.com/Azure/batch-shipyard/compare/2.9.2...2.9.3 diff --git a/README.md b/README.md index 2d5beaa..d87ebec 100644 --- a/README.md +++ b/README.md @@ -95,16 +95,14 @@ as a Docker image: Please see [the installation guide](https://github.com/Azure/batch-shipyard/blob/master/docs/01-batch-shipyard-installation.md) for more information regarding installation and requirements. -## Documentation +## Documentation and Recipes Please refer to the -[Batch Shipyard Guide](https://github.com/Azure/batch-shipyard/blob/master/docs) -for a complete primer on concepts, usage and a quickstart guide. +[Batch Shipyard Documentation on Read the Docs](http://batch-shipyard.readthedocs.io/en/latest/). -Please visit the +Visit the [Batch Shipyard Recipes](https://github.com/Azure/batch-shipyard/blob/master/recipes) -for various sample Docker workloads using Azure Batch and Batch Shipyard -after you have completed the introductory sections of the Batch Shipyard -Guide. +section for various sample Docker workloads using Azure Batch and Batch +Shipyard. ## Batch Shipyard Compute Node OS Support Batch Shipyard is currently compatible with supported Marketplace Linux VMs diff --git a/convoy/version.py b/convoy/version.py index bf167aa..702284b 100644 --- a/convoy/version.py +++ b/convoy/version.py @@ -22,4 +22,4 @@ # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER # DEALINGS IN THE SOFTWARE. -__version__ = '2.9.5' +__version__ = '2.9.6' diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md new file mode 120000 index 0000000..04c99a5 --- /dev/null +++ b/docs/CHANGELOG.md @@ -0,0 +1 @@ +../CHANGELOG.md \ No newline at end of file diff --git a/docs/README.md b/docs/README.md index f44c112..0019590 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,30 +1,9 @@ -# Batch Shipyard Guide -This directory is a starting point for using the Batch Shipyard tooling -and effectively running your batch-style Docker workloads on Azure Batch. +# Batch Shipyard Documentation and Guides +Please see the +[Batch Shipyard Documentation on Read the Docs](http://batch-shipyard.readthedocs.io/en/latest/). -1. [Introduction](00-introduction.md) -2. [Installation](01-batch-shipyard-installation.md) -3. [Quick Start](02-batch-shipyard-quickstart.md) -4. [From Scratch: Step-by-Step](05-batch-shipyard-from-scratch-step-by-step.md) -5. [Configuration](10-batch-shipyard-configuration.md) - * [Credentials Configuration](11-batch-shipyard-configuration-credentials.md) - * [Global Configuration](12-batch-shipyard-configuration-global.md) - * [Pool Configuration](13-batch-shipyard-configuration-pool.md) - * [Jobs Configuration](14-batch-shipyard-configuration-jobs.md) - * [FS Configuration](15-batch-shipyard-configuration-fs.md) -6. [CLI Commands and Usage](20-batch-shipyard-usage.md) -7. [Autoscale](30-batch-shipyard-autoscale.md) -8. [Task Factories](35-batch-shipyard-task-factory.md) -9. [Azure Functions and Batch Shipyard](60-batch-shipyard-site-extension.md) -10. [Custom Image for Host Compute Nodes](63-batch-shipyard-custom-images.md) -11. [Remote Filesystems](65-batch-shipyard-remote-fs.md) -12. [Data Movement](70-batch-shipyard-data-movement.md) -13. [Azure KeyVault for Credential Management](74-batch-shipyard-azure-keyvault.md) -14. [Credential Encryption](75-batch-shipyard-credential-encryption.md) -15. [Batch Shipyard and Multi-Instance Tasks](80-batch-shipyard-multi-instance-tasks.md) -16. [Interactive SSH Sessions and Docker Tunnels](85-batch-shipyard-ssh-docker-tunnel.md) -17. [Low-Priority Compute Node Considerations](95-low-priority-considerations.md) -18. [Troubleshooting Guide](96-troubleshooting-guide.md) -19. [FAQ](97-faq.md) -20. [Contributing Recipes](98-contributing-recipes.md) -21. [Current Limitations](99-current-limitations.md) +You can substitute `latest` at the end of the Read the Docs URL to display +documentation for a specific version of Batch Shipyard. If that version does +not exist on Read the Docs, you can select a tagged verison on the GitHub +repo page (select the `Branch` pulldown and switch to the `Tags` tab) to +dispaly older version documentation. diff --git a/docs/index.md b/docs/index.md new file mode 120000 index 0000000..32d46ee --- /dev/null +++ b/docs/index.md @@ -0,0 +1 @@ +../README.md \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..ac2aece --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,45 @@ +site_name: Batch Shipyard +site_description: Azure Batch Shipyard +site_url: https://github.com/Azure/batch-shipyard +repo_url: https://github.com/Azure/batch-shipyard +theme: readthedocs + +pages: +- Home: index.md +- Introduction: 00-introduction.md +- Installation and Quickstart: + - Installation: 01-batch-shipyard-installation.md + - Quickstart: 02-batch-shipyard-quickstart.md + - From Scratch: 05-batch-shipyard-from-scratch-step-by-step.md +- Configuration: + - Overview: 10-batch-shipyard-configuration.md + - Credentials: 11-batch-shipyard-configuration-credentials.md + - Global: 12-batch-shipyard-configuration-global.md + - Pool: 13-batch-shipyard-configuration-pool.md + - Jobs: 14-batch-shipyard-configuration-jobs.md + - RemoteFS: 15-batch-shipyard-configuration-fs.md +- CLI Commands and Usage: 20-batch-shipyard-usage.md +- In-Depth Feature Guides: + - Autoscale: 30-batch-shipyard-autoscale.md + - Task Factory: 35-batch-shipyard-task-factory.md + - Azure Functions and Batch Shipyard: 60-batch-shipyard-site-extension.md + - Custom Images for Host Compute Nodes: 63-batch-shipyard-custom-images.md + - Remote Filesystems: 65-batch-shipyard-remote-fs.md + - Data Movement: 70-batch-shipyard-data-movement.md + - Azure KeyVault for Credential Management: 74-batch-shipyard-azure-keyvault.md + - Credential Encryption: 75-batch-shipyard-credential-encryption.md + - Multi-instance (MPI) Tasks: 80-batch-shipyard-multi-instance-tasks.md + - Interactive SSH and Tunneling: 85-batch-shipyard-ssh-docker-tunnel.md +- Other Guides: + - Low Priority Compute Node Considerations: 95-low-priority-considerations.md + - Troubleshooting Guide: 96-troubleshooting-guide.md + - FAQ: 97-faq.md + - Current Limitations: 99-current-limitations.md +- Contributing Recipes: 98-contributing-recipes.md +- Change Log: CHANGELOG.md + +markdown_extensions: +- admonition +- codehilite +- fenced_code +- sane_lists