Skip to content
This repository was archived by the owner on Mar 20, 2023. It is now read-only.

Commit 75157e9

Browse files
alfparkalfpark
committed
Add Read the Docs build
- Tag for 2.9.6 release (mainly to generate a 2.9.x RTD version)
1 parent 1784e06 commit 75157e9

File tree

7 files changed

+67
-38
lines changed

7 files changed

+67
-38
lines changed

‎CHANGELOG.md‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
## [Unreleased]
44

5+
## [2.9.6] - 2017-10-03
6+
### Added
7+
- Migrate to Read the Docs for [documentation](http://batch-shipyard.readthedocs.io/en/latest/)
8+
59
### Fixed
610
- RemoteFS disk attach fixes
711
- Nvidia docker volume mount check
@@ -861,7 +865,8 @@ transfer is disabled
861865
#### Added
862866
- Initial release
863867

864-
[Unreleased]: https://github.com/Azure/batch-shipyard/compare/2.9.5...HEAD
868+
[Unreleased]: https://github.com/Azure/batch-shipyard/compare/2.9.6...HEAD
869+
[2.9.6]: https://github.com/Azure/batch-shipyard/compare/2.9.5...2.9.6
865870
[2.9.5]: https://github.com/Azure/batch-shipyard/compare/2.9.4...2.9.5
866871
[2.9.4]: https://github.com/Azure/batch-shipyard/compare/2.9.3...2.9.4
867872
[2.9.3]: https://github.com/Azure/batch-shipyard/compare/2.9.2...2.9.3

‎README.md‎

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -95,16 +95,14 @@ as a Docker image:
9595
Please see [the installation guide](https://github.com/Azure/batch-shipyard/blob/master/docs/01-batch-shipyard-installation.md)
9696
for more information regarding installation and requirements.
9797

98-
## Documentation
98+
## Documentation and Recipes
9999
Please refer to the
100-
[Batch Shipyard Guide](https://github.com/Azure/batch-shipyard/blob/master/docs)
101-
for a complete primer on concepts, usage and a quickstart guide.
100+
[Batch Shipyard Documentation on Read the Docs](http://batch-shipyard.readthedocs.io/en/latest/).
102101

103-
Please visit the
102+
Visit the
104103
[Batch Shipyard Recipes](https://github.com/Azure/batch-shipyard/blob/master/recipes)
105-
for various sample Docker workloads using Azure Batch and Batch Shipyard
106-
after you have completed the introductory sections of the Batch Shipyard
107-
Guide.
104+
section for various sample Docker workloads using Azure Batch and Batch
105+
Shipyard.
108106

109107
## Batch Shipyard Compute Node OS Support
110108
Batch Shipyard is currently compatible with supported Marketplace Linux VMs

‎convoy/version.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,4 @@
2222
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
2323
# DEALINGS IN THE SOFTWARE.
2424

25-
__version__ = '2.9.5'
25+
__version__ = '2.9.6'

‎docs/CHANGELOG.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../CHANGELOG.md

‎docs/README.md‎

Lines changed: 8 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,9 @@
1-
# Batch Shipyard Guide
2-
This directory is a starting point for using the Batch Shipyard tooling
3-
and effectively running your batch-style Docker workloads on Azure Batch.
1+
# Batch Shipyard Documentation and Guides
2+
Please see the
3+
[Batch Shipyard Documentation on Read the Docs](http://batch-shipyard.readthedocs.io/en/latest/).
44

5-
1. [Introduction](00-introduction.md)
6-
2. [Installation](01-batch-shipyard-installation.md)
7-
3. [Quick Start](02-batch-shipyard-quickstart.md)
8-
4. [From Scratch: Step-by-Step](05-batch-shipyard-from-scratch-step-by-step.md)
9-
5. [Configuration](10-batch-shipyard-configuration.md)
10-
* [Credentials Configuration](11-batch-shipyard-configuration-credentials.md)
11-
* [Global Configuration](12-batch-shipyard-configuration-global.md)
12-
* [Pool Configuration](13-batch-shipyard-configuration-pool.md)
13-
* [Jobs Configuration](14-batch-shipyard-configuration-jobs.md)
14-
* [FS Configuration](15-batch-shipyard-configuration-fs.md)
15-
6. [CLI Commands and Usage](20-batch-shipyard-usage.md)
16-
7. [Autoscale](30-batch-shipyard-autoscale.md)
17-
8. [Task Factories](35-batch-shipyard-task-factory.md)
18-
9. [Azure Functions and Batch Shipyard](60-batch-shipyard-site-extension.md)
19-
10. [Custom Image for Host Compute Nodes](63-batch-shipyard-custom-images.md)
20-
11. [Remote Filesystems](65-batch-shipyard-remote-fs.md)
21-
12. [Data Movement](70-batch-shipyard-data-movement.md)
22-
13. [Azure KeyVault for Credential Management](74-batch-shipyard-azure-keyvault.md)
23-
14. [Credential Encryption](75-batch-shipyard-credential-encryption.md)
24-
15. [Batch Shipyard and Multi-Instance Tasks](80-batch-shipyard-multi-instance-tasks.md)
25-
16. [Interactive SSH Sessions and Docker Tunnels](85-batch-shipyard-ssh-docker-tunnel.md)
26-
17. [Low-Priority Compute Node Considerations](95-low-priority-considerations.md)
27-
18. [Troubleshooting Guide](96-troubleshooting-guide.md)
28-
19. [FAQ](97-faq.md)
29-
20. [Contributing Recipes](98-contributing-recipes.md)
30-
21. [Current Limitations](99-current-limitations.md)
5+
You can substitute `latest` at the end of the Read the Docs URL to display
6+
documentation for a specific version of Batch Shipyard. If that version does
7+
not exist on Read the Docs, you can select a tagged verison on the GitHub
8+
repo page (select the `Branch` pulldown and switch to the `Tags` tab) to
9+
dispaly older version documentation.

‎docs/index.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../README.md

‎mkdocs.yml‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
site_name: Batch Shipyard
2+
site_description: Azure Batch Shipyard
3+
site_url: https://github.com/Azure/batch-shipyard
4+
repo_url: https://github.com/Azure/batch-shipyard
5+
theme: readthedocs
6+
7+
pages:
8+
- Home: index.md
9+
- Introduction: 00-introduction.md
10+
- Installation and Quickstart:
11+
- Installation: 01-batch-shipyard-installation.md
12+
- Quickstart: 02-batch-shipyard-quickstart.md
13+
- From Scratch: 05-batch-shipyard-from-scratch-step-by-step.md
14+
- Configuration:
15+
- Overview: 10-batch-shipyard-configuration.md
16+
- Credentials: 11-batch-shipyard-configuration-credentials.md
17+
- Global: 12-batch-shipyard-configuration-global.md
18+
- Pool: 13-batch-shipyard-configuration-pool.md
19+
- Jobs: 14-batch-shipyard-configuration-jobs.md
20+
- RemoteFS: 15-batch-shipyard-configuration-fs.md
21+
- CLI Commands and Usage: 20-batch-shipyard-usage.md
22+
- In-Depth Feature Guides:
23+
- Autoscale: 30-batch-shipyard-autoscale.md
24+
- Task Factory: 35-batch-shipyard-task-factory.md
25+
- Azure Functions and Batch Shipyard: 60-batch-shipyard-site-extension.md
26+
- Custom Images for Host Compute Nodes: 63-batch-shipyard-custom-images.md
27+
- Remote Filesystems: 65-batch-shipyard-remote-fs.md
28+
- Data Movement: 70-batch-shipyard-data-movement.md
29+
- Azure KeyVault for Credential Management: 74-batch-shipyard-azure-keyvault.md
30+
- Credential Encryption: 75-batch-shipyard-credential-encryption.md
31+
- Multi-instance (MPI) Tasks: 80-batch-shipyard-multi-instance-tasks.md
32+
- Interactive SSH and Tunneling: 85-batch-shipyard-ssh-docker-tunnel.md
33+
- Other Guides:
34+
- Low Priority Compute Node Considerations: 95-low-priority-considerations.md
35+
- Troubleshooting Guide: 96-troubleshooting-guide.md
36+
- FAQ: 97-faq.md
37+
- Current Limitations: 99-current-limitations.md
38+
- Contributing Recipes: 98-contributing-recipes.md
39+
- Change Log: CHANGELOG.md
40+
41+
markdown_extensions:
42+
- admonition
43+
- codehilite
44+
- fenced_code
45+
- sane_lists

0 commit comments

Comments
 (0)