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

DOCS-602: Remove EXIF data #1858

Merged
merged 3 commits into from
Sep 21, 2023
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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
.jpg_original
.jpeg_original
.png_original
**/.DS_Store
*~
public
Expand Down
27 changes: 26 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,16 +43,41 @@ python3 -m http.server 9000 --directory public

## Test the docs locally

### Python snippets

To ensure all python snippets are properly formatted before creating a commit, install [flake8-markdown](https://github.com/johnfraney/flake8-markdown) and add the following like to `.git/hooks/pre-commit`:

```sh
flake8-markdown $(git diff --diff-filter=d --name-only HEAD | grep '\.md$')
if [ "git diff --diff-filter=d --name-only HEAD | grep '\.md$' | wc -l" ];
then
list= $(git diff --diff-filter=d --name-only HEAD | grep '\.md$')
for item in $list
do
flake8-markdown $item
done
fi
```

To ensure your markdown is properly formatted, run `make markdowntest`.

To check for broken links run `make htmltest`.

### Remove EXIF data automatically

To ensure that you do not accidentally add `EXIF` data on images, please install [exiftool](https://exiftool.org/install.html) and add the following lines to the `.git/hooks/pre-commit` file in your local files.
If you do not have a file of that name in that location, create one, or rename the existing `pre-commit.sample` file in that directory as `pre-commit`, and add the code below:

```sh
if [ "git diff --name-only | grep -EI '.*(png|jpg|jpeg)$' | wc -l" ];
then
list= $(git diff --diff-filter=d --name-only | grep -EI ".*(png|jpg|jpeg)$")
for item in $list
do
exiftool -all= $item
done
fi
```

## Publishing

The docs are automatically published when a PR merges.
Expand Down
Binary file modified assets/components/arm/ur5e-ui-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/components/arm/xArm6-ui-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/components/arm/xArm7-ui-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/components/arm/xArmLite-ui-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/components/arm/yahboom-dofbot-ui-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/components/base/agilex-limo-ui-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/components/base/base-control-tab.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/components/base/base-json.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/components/base/fake-base-ui-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/components/base/wheeled-base-ui-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/components/board/beaglebone-ui-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/components/board/board-comp-options.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/components/board/board-gen-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/components/board/fake-ui-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/components/board/jetson-ui-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/components/board/nanopi-ui-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/components/board/numato-ui-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/components/board/pca9685-ui-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/components/board/pi-ui-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/components/board/ti-ui-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/components/board/upboard-ui-config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/components/camera/calibrate/ExampleImages.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/components/camera/camera_tutorial_copy_paste.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/components/camera/configure-dual-stream.png
Binary file modified assets/components/camera/configure-fake.png
Binary file modified assets/components/camera/configure-ffmpeg.png
Binary file modified assets/components/camera/configure-image-file.png
Binary file modified assets/components/camera/configure-join-color-depth.png
Binary file modified assets/components/camera/configure-join-pointclouds.png
Binary file modified assets/components/camera/configure-rtsp.png
Binary file modified assets/components/camera/configure-single-stream.png
Binary file modified assets/components/camera/configure-transform.png
Binary file modified assets/components/camera/configure-velodyne.png
Binary file modified assets/components/camera/configure-webcam.png
Binary file modified assets/components/camera/create-dual-stream.png
Binary file modified assets/components/camera/create-fake.png
Binary file modified assets/components/camera/create-ffmpeg.png
Binary file modified assets/components/camera/create-image-file.png
Binary file modified assets/components/camera/create-join-color-depth.png
Binary file modified assets/components/camera/create-join-pointclouds.png
Binary file modified assets/components/camera/create-rtsp.png
Binary file modified assets/components/camera/create-single-stream.png
Binary file modified assets/components/camera/create-transform.png
Binary file modified assets/components/camera/create-velodyne.png
Binary file modified assets/components/camera/create-webcam.png
Binary file modified assets/components/component/model1-builder.png
Binary file modified assets/components/encoder/configure-arduino.png
Binary file modified assets/components/encoder/create-am5.png
Binary file modified assets/components/encoder/create-arduino.png
Binary file modified assets/components/encoder/create-fake.png
Binary file modified assets/components/encoder/create-incremental.png
Binary file modified assets/components/encoder/create-single.png
Binary file modified assets/components/gantry/fake-gantry-ui-config.png
Binary file modified assets/components/gantry/gantry-illustration.png
Binary file modified assets/components/gantry/multi-axis-ui-config.png
Binary file modified assets/components/gantry/single-axis-ui-config.png
Binary file modified assets/components/gripper/fake-gripper-ui-config.png
Binary file modified assets/components/gripper/softrobotics-ui-config.png
Binary file modified assets/components/input-controller/base-rc-service-config.png
Binary file modified assets/components/input-controller/gamepad-enabled-app.png
Binary file modified assets/components/motor/28byj48-config-ui.png
Binary file modified assets/components/motor/28byj48-wiring.png
Binary file modified assets/components/motor/dmc4000-config-ui.png
Binary file modified assets/components/motor/encoded-config-ui.png
Binary file modified assets/components/motor/fake-config-ui.png
Binary file modified assets/components/motor/gpio-config-ui.png
Binary file modified assets/components/motor/gpiostepper-config-ui.png
Binary file modified assets/components/motor/motor-brushed-dc-wiring.png
Binary file modified assets/components/motor/motor-brushless-dc-wiring.png
Binary file modified assets/components/motor/motor-encoded-dc-json.png
Binary file modified assets/components/motor/motor-encoded-dc-wiring.png
Binary file modified assets/components/motor/motor-gpio-json.png
Binary file modified assets/components/motor/motor-gpiostepper-json.png
Binary file modified assets/components/motor/motor-gpiostepper-wiring.png
Binary file modified assets/components/motor/roboclaw-ui-config.png
Binary file modified assets/components/motor/tmc5072-config-ui.png
Binary file modified assets/components/movement-sensor/camera-mono-builder.png
Binary file modified assets/components/movement-sensor/merged-config-builder.png
Binary file modified assets/components/movement-sensor/rtk-station-builder.png
Binary file modified assets/components/movement-sensor/visual-odometry-poster.jpg
Binary file modified assets/components/power-sensor/fake-config-builder.png
Binary file modified assets/components/power-sensor/ina219-config-builder.png
Binary file modified assets/components/power-sensor/ina226-config-builder.png
Binary file modified assets/components/power-sensor/renogy-config-builder.png
Binary file modified assets/components/sensor/bme280-sensor-ui-config.png
Binary file modified assets/components/sensor/ds18b20-sensor-ui-config.png
Binary file modified assets/components/sensor/fake-sensor-ui-config.png
Binary file modified assets/components/sensor/sensirion-sht3xd-sensor-ui-config.png
Binary file modified assets/components/sensor/sensor-control-tab.png
Binary file modified assets/components/sensor/ultrasonic-sensor-board-ui-config.png
Binary file modified assets/components/sensor/ultrasonic-sensor-ui-config.png
Binary file modified assets/components/servo/fake-servo-ui-config.png
Binary file modified assets/components/servo/gpio-servo-ui-config.png
Binary file modified assets/components/servo/pi-servo-ui-config.png
Binary file modified assets/components/servo/servo-control-tab.png
Binary file modified assets/components/servo/servo-json.png
Binary file modified assets/components/servo/servo-wiring.png
Binary file modified assets/general/code.png
Binary file modified assets/general/expander-example.png
Binary file modified assets/general/expander-markdown.png
Binary file modified assets/general/figure-shortcode.png
Binary file modified assets/general/heart.jpg
Binary file modified assets/general/install.png
Binary file modified assets/general/logo.png
Binary file modified assets/general/program.png
Binary file modified assets/general/services.png
Binary file modified assets/general/snippet-shortcode.png
Binary file modified assets/general/tabbed-panel-markdown.png
Binary file modified assets/general/tryviam.png
Binary file modified assets/general/understand.png
Binary file modified assets/icons/components.png
Binary file modified assets/installation/beaglebone-setup/image2.png
Binary file modified assets/installation/esp32-setup/esp32-remote-creation.png
Binary file modified assets/installation/linux-install/install-config-button.png
Binary file modified assets/installation/macos-install/server-config-button.png
Binary file modified assets/installation/microcontroller/config-field.png
Binary file modified assets/installation/microcontroller/copy-remotes-code.png
Binary file modified assets/installation/microcontroller/create-remote.png
Binary file modified assets/installation/rpi-setup/add-robot.png
Binary file modified assets/installation/rpi-setup/advanced-options.png
Binary file modified assets/installation/rpi-setup/view-robot.png
Binary file modified assets/installation/rpi-setup/your-robot-is-connected.jpg
Binary file modified assets/installation/sk-tda4vm/completed.png
Binary file modified assets/installation/sk-tda4vm/etcher.png
Binary file modified assets/installation/sk-tda4vm/welcomescreen.jpg
Binary file modified assets/installation/thumbnails/beaglebone.png
Binary file modified assets/installation/thumbnails/esp32-espressif.png
Binary file modified assets/installation/thumbnails/install.png
Binary file modified assets/installation/thumbnails/jetson-orin-nano.jpeg
Binary file modified assets/installation/thumbnails/manage.png
Binary file modified assets/installation/thumbnails/nanopi.png
Binary file modified assets/installation/thumbnails/pc.png
Binary file modified assets/installation/thumbnails/prepare.png
Binary file modified assets/installation/thumbnails/raspberry-pi-4-b-2gb.png
Binary file modified assets/installation/thumbnails/rpi-3.png
Binary file modified assets/installation/thumbnails/tda4vm.png
Binary file modified assets/installation/thumbnails/up_4000.png
Binary file modified assets/installation/thumbnails/update.png
Binary file modified assets/internals/slam-service-arch.png
Binary file modified assets/internals/vector/LED_circuit2.png
Binary file modified assets/internals/vector/Verschiedene_LEDs.jpg
Binary file modified assets/internals/vector/orientation-vector-camera.png
Binary file modified assets/internals/vector/resistor.png
Binary file modified assets/internals/vector/ts-adding-ssh-key.png
Binary file modified assets/manage/app-usage/add-org-drop-down.png
Binary file modified assets/manage/app-usage/after-add-org.png
Binary file modified assets/manage/app-usage/create-namespace.png
Binary file modified assets/manage/app-usage/create-robot.png
Binary file modified assets/manage/app-usage/delete.png
Binary file modified assets/manage/app-usage/invite-user.png
Binary file modified assets/manage/app-usage/location-secret-keys-drop-down.png
Binary file modified assets/manage/app-usage/my-org.png
Binary file modified assets/manage/app-usage/robot-page.png
Binary file modified assets/manage/app-usage/robot-secrets.png
Binary file modified assets/manage/configuration/config-tab.png
Binary file modified assets/manage/configuration/process-fancy.png
Binary file modified assets/manage/data/data_view.png
Binary file modified assets/manage/data/delete_all.png
Binary file modified assets/manage/data/tabs.png
Binary file modified assets/manage/fragment-components.png
Binary file modified assets/manage/fragment-view.png
Binary file modified assets/manage/fragments-tab.png
Binary file modified assets/manage/locations.png
Binary file modified assets/manage/ml/add-new-model.png
Binary file modified assets/manage/ml/stars-model.png
Binary file modified assets/manage/parts-and-remotes/part-mgmt.png
Binary file modified assets/manage/parts-and-remotes/remote-address.png
Binary file modified assets/manage/parts-and-remotes/remote-config.png
Binary file modified assets/manage/parts-and-remotes/remote-create.png
Binary file modified assets/manage/parts-and-remotes/remote-json-create.png
Binary file modified assets/manage/parts-and-remotes/remotes-diagram.png
Binary file modified assets/manage/parts-and-remotes/sub-part-config.png
Binary file modified assets/manage/rbac.png
Binary file modified assets/program/modular-resources/module-ui-config.png
Binary file modified assets/program/modular-resources/rplidar-on-robot.png
Binary file modified assets/program/overview-two-part-architecture.png
Binary file modified assets/program/sdks/log-level-info.png
Binary file modified assets/program/sdks/robot-client.png
Binary file modified assets/services/added-model.png
Binary file modified assets/services/available-models.png
Binary file modified assets/services/base-rc/base-rc-ui-config.png
Binary file modified assets/services/data/data-service-component-config.png
Binary file modified assets/services/data/data-service-config.png
Binary file modified assets/services/deploy-model.png
Binary file modified assets/services/frame-system/demo_base_edited.png
Binary file modified assets/services/frame-system/demo_base_unedited.png
Binary file modified assets/services/frame-system/demo_bound_box.png
Binary file modified assets/services/frame-system/demo_bound_box_translation.png
Binary file modified assets/services/frame-system/demo_bound_capsule.png
Binary file modified assets/services/frame-system/demo_bound_sphere.png
Binary file modified assets/services/frame-system/demo_camera_edited_1.png
Binary file modified assets/services/frame-system/demo_camera_edited_2.png
Binary file modified assets/services/frame-system/demo_camera_unedited.png
Binary file modified assets/services/frame-system/demo_end.png
Binary file modified assets/services/frame-system/demo_orthographic.png
Binary file modified assets/services/frame-system/demo_perspective.png
Binary file modified assets/services/frame-system/frame_card.png
Binary file modified assets/services/frame-system/frame_card_dyn_arm.png
Binary file modified assets/services/frame-system/frame_card_dyn_gantry.png
Binary file modified assets/services/frame-system/frame_card_static.png
Binary file modified assets/services/frame-system/frame_sys_log_example.png
Binary file modified assets/services/frame-system/frame_system_basic.png
Binary file modified assets/services/frame-system/frame_system_wheeled_base.png
Binary file modified assets/services/frame-system/frame_tree.png
Binary file modified assets/services/navigation/click-add-frame-ui.png
Binary file modified assets/services/navigation/full-frame-base-ui.png
Binary file modified assets/services/navigation/full-frame-movement-sensor-ui.png
Binary file modified assets/services/navigation/navigation-ui-config.png
Binary file modified assets/services/slam-service-arch.png
Binary file modified assets/services/slam/01_slam_tutorial_no_map_points.png
Binary file modified assets/services/slam/add-cartographer-module-ui-M1-M2.png
Binary file modified assets/services/slam/add-cartographer-module-ui-linux.png
Binary file modified assets/services/slam/add-cartographer-service-ui.png
Binary file modified assets/services/slam/add-orbslam-service-attributes-live.png
Binary file modified assets/services/slam/add-orbslam-service-attributes-offline.png
Binary file modified assets/services/slam/add-orbslam-service-ui.png
Binary file modified assets/services/slam/slam-map-example.png
Binary file modified assets/services/vision/color-detector-panel.png
Binary file modified assets/try-viam/navigation-bar.png
Binary file modified assets/try-viam/rover-resources/viam-rover/accelerometer.jpg
Binary file modified assets/try-viam/rover-resources/viam-rover/allen-wrenches.png
Binary file modified assets/try-viam/rover-resources/viam-rover/battery-pack.jpg
Binary file modified assets/try-viam/rover-resources/viam-rover/box-contents.jpg
Binary file modified assets/try-viam/rover-resources/viam-rover/buck-converter.jpg
Binary file modified assets/try-viam/rover-resources/viam-rover/encoder-motors.jpg
Binary file modified assets/try-viam/rover-resources/viam-rover/jumper-wires.jpg
Binary file modified assets/try-viam/rover-resources/viam-rover/pi4.jpg
Binary file modified assets/try-viam/rover-resources/viam-rover/rover-front.jpg
Binary file modified assets/try-viam/rover-resources/viam-rover/rover-side.jpg
Binary file modified assets/try-viam/rover-resources/viam-rover/rover-with-pi.jpg
Binary file modified assets/try-viam/rover-resources/viam-rover/screws.jpg
Binary file modified assets/try-viam/rover-resources/viam-rover/toggle-switch.jpg
Binary file modified assets/try-viam/rover-resources/viam-rover/topless-rover.jpg
Binary file modified assets/try-viam/rover-resources/viam-rover/webcam.jpg
Binary file modified assets/try-viam/rover-resources/viam-rover/wiring-closeup.jpg
Binary file modified assets/try-viam/try-viam/bannerinfo.png
Binary file modified assets/try-viam/try-viam/base-config.png
Binary file modified assets/try-viam/try-viam/base-rc.png
Binary file modified assets/try-viam/try-viam/board-panel.png
Binary file modified assets/try-viam/try-viam/camera-config.png
Binary file modified assets/try-viam/try-viam/config-builder.png
Binary file modified assets/try-viam/try-viam/control-panel-list.png
Binary file modified assets/try-viam/try-viam/discrete.png
Binary file modified assets/try-viam/try-viam/enable-both-cameras.png
Binary file modified assets/try-viam/try-viam/end-of-session.png
Binary file modified assets/try-viam/try-viam/gamepad-config.png
Binary file modified assets/try-viam/try-viam/left-right-panels.png
Binary file modified assets/try-viam/try-viam/motors-running.png
Binary file modified assets/try-viam/try-viam/raw-json.png
Binary file modified assets/try-viam/try-viam/right-encoder.png
Binary file modified assets/try-viam/try-viam/timer.png
Binary file modified assets/try-viam/try-viam/vision-service-config.png
Binary file modified assets/tutorials/ai-integration/3emotion.png
Binary file modified assets/tutorials/ai-integration/mlmodels_service_add.png
Binary file modified assets/tutorials/ai-integration/rosey.jpeg
Binary file modified assets/tutorials/ai-integration/rosey_robot.jpg
Binary file modified assets/tutorials/ai-integration/servo_component_add.png
Binary file modified assets/tutorials/ai-integration/servo_mounted.jpg
Binary file modified assets/tutorials/ai-integration/vision_service_add.png
Binary file modified assets/tutorials/ai-integration/yoda.jpeg
Binary file modified assets/tutorials/bedtime-songs-bot/app-camera-configuration.png
Binary file modified assets/tutorials/bedtime-songs-bot/export-screenshot.png
Loading