Skip to content

Commit 3c54813

Browse files
committed
Add scripts/deploy_docs.sh
1 parent c4d9f84 commit 3c54813

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed

docs/source/the-release-process.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ Creator, it's usually copied into a GitHub issue:
5959
- [ ] Upload with (e.g.): `rsync --delete --exclude .git/ -avz files.opensimcreator.com/ files.opensimcreator.com:/var/www/files.opensimcreator.com/`
6060
- [ ] Update `docs.opensimcreator.com` to host the documentation
6161
- [ ] Build the docs yourself (e.g. with `./scripts/ci_build_docs.sh`), or get the CI build of them
62-
- [ ] Upload with (e.g.) `rsync -avz --delete build/ docs.opensimcreator.com:/var/www/docs.opensimcreator.com/manual/en/latest/`
62+
- [ ] Upload with (e.g.) `./scripts/deploy_docs.sh` (requires SSH credentials)
6363
- [ ] Update `www.opensimcreator.com` with a basic announcement news post
6464
- [ ] Edit https://github.com/ComputationalBiomechanicsLab/www.opensimcreator.com appropriately
6565
- [ ] Upload with (e.g.): `rsync -avz public/ www.opensimcreator.com:/var/www/opensimcreator.com/`

scripts/deploy_docs.sh

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
#!/usr/bin/env bash
2+
3+
# note: this requires that the client has the necessary
4+
# SSH keys configured on their machine
5+
6+
rsync -avz --delete docs/build/ docs.opensimcreator.com:/var/www/docs.opensimcreator.com/manual/en/latest
7+

0 commit comments

Comments
 (0)