Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Upload docs to aws #188

Merged
merged 9 commits into from
Jul 31, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 8 additions & 12 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -88,23 +88,19 @@ jobs:

docs-deploy:
docker:
- image: node:20.16.0
- image: amazon/aws-cli:2.17.20
steps:
- checkout
- run:
name: Install tar utility
command: |
yum install -y tar gzip
- attach_workspace:
at: .
- run:
name: Install and configure dependencies
name: Sync to S3
command: |
npm install -g --silent [email protected]
git config user.email "[email protected]"
git config user.name "bcibotae"
- add_ssh_keys:
fingerprints:
- "b3:36:18:ed:6f:30:4a:b6:5d:93:f8:f2:b4:2d:b4:15"
- run:
name: Deploy docs to gh-pages branch
command: gh-pages --no-history --dist site
aws s3 sync site/ s3://ndk-docs/

workflows:
version: 2
Expand All @@ -123,4 +119,4 @@ workflows:
not:
equal: [main, << pipeline.git.branch >>] # Not building on main branch
jobs:
- build_docs_pr
- build_docs_pr
2 changes: 1 addition & 1 deletion docs/examples/plot_3d.py
Original file line number Diff line number Diff line change
Expand Up @@ -62,4 +62,4 @@
# %%
# If you have napari installed you should have been able to see an image like
# the following:
# ![3d-visualization](../../images/3d_visualization.gif)
# ![3d-visualization](http://ndk-docs.s3-website.us-east-2.amazonaws.com/images/3d_visualization.gif)
Binary file removed docs/images/3d_visualization.gif
Binary file not shown.
Binary file removed docs/images/ndk_example.gif
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The [_Neurotech Development Kit_ (NDK)](https://agencyenterprise.github.io/neuro

As a community-driven project, we encourage you to contribute code, feedback, and features to help accelerate the development of transformative neurotechnology.

![Simulation](https://raw.githubusercontent.com/agencyenterprise/neurotechdevkit/main/docs/images/ndk_example.gif)
![Simulation](http://ndk-docs.s3-website.us-east-2.amazonaws.com/images/ndk_example.gif)

Check out the [NDK documentation page](https://agencyenterprise.github.io/neurotechdevkit/).

Expand Down
Loading