diff --git a/.github/workflows/photon-code-docs.yml b/.github/workflows/photon-api-docs.yml similarity index 54% rename from .github/workflows/photon-code-docs.yml rename to .github/workflows/photon-api-docs.yml index 02f2576bcb..c36375b358 100644 --- a/.github/workflows/photon-code-docs.yml +++ b/.github/workflows/photon-api-docs.yml @@ -1,4 +1,4 @@ -name: Photon Code Documentation +name: Photon API Documentation on: # Run on pushes to main and pushed tags, and on pull requests against main, but ignore the docs folder @@ -21,8 +21,7 @@ permissions: id-token: write jobs: - build-client: - name: "PhotonClient Build" + build_demo: defaults: run: working-directory: photon-client @@ -39,10 +38,10 @@ jobs: run: npm run build-demo - uses: actions/upload-artifact@v4 with: - name: built-client + name: built-demo path: photon-client/dist/ - run_docs: + run_api_docs: runs-on: "ubuntu-22.04" steps: - name: Checkout code @@ -67,23 +66,49 @@ jobs: name: built-docs path: photon-docs/build/docs - release: - needs: [build-client, run_docs] + publish_api_docs: + needs: [run_api_docs] runs-on: ubuntu-22.04 steps: - # Download literally every single artifact. + # Download docs artifact - uses: actions/download-artifact@v4 + with: + name: built-docs - run: find . - - name: copy file via ssh password + - name: Publish docs to development if: github.ref == 'refs/heads/main' - uses: appleboy/scp-action@v0.1.7 + uses: up9cloud/action-rsync@v1.4 + env: + HOST: ${{ secrets.WEBMASTER_SSH_HOST }} + USER: ${{ secrets.WEBMASTER_SSH_USERNAME }} + KEY: ${{secrets.WEBMASTER_SSH_KEY}} + TARGET: /var/www/html/photonvision-docs/development + - name: publish docs to release + if: startsWith(github.ref, 'refs/tags/v') + uses: up9cloud/action-rsync@v1.4 + env: + HOST: ${{ secrets.WEBMASTER_SSH_HOST }} + USER: ${{ secrets.WEBMASTER_SSH_USERNAME }} + KEY: ${{ secrets.WEBMASTER_SSH_KEY }} + TARGET: /var/www/html/photonvision-docs/release/ + + publish_demo: + needs: [build_demo] + + runs-on: ubuntu-22.04 + steps: + - uses: actions/download-artifact@v4 with: - host: ${{ secrets.WEBMASTER_SSH_HOST }} - username: ${{ secrets.WEBMASTER_SSH_USERNAME }} - password: ${{ secrets.WEBMASTER_SSH_KEY }} - port: ${{ secrets.WEBMASTER_SSH_PORT }} - source: "*" - target: /var/www/html/photonvision-docs/ + name: built-demo + - run: find . + - name: Publish demo + if: github.ref == 'refs/heads/main' + uses: up9cloud/action-rsync@v1.4 + env: + HOST: ${{ secrets.WEBMASTER_SSH_HOST }} + USER: ${{ secrets.WEBMASTER_SSH_USERNAME }} + KEY: ${{ secrets.WEBMASTER_SSH_KEY }} + TARGET: /var/www/html/photonvision-demo diff --git a/docs/source/docs/contributing/design-descriptions/camera-matching.md b/docs/source/docs/contributing/design-descriptions/camera-matching.md index 3476849349..ce95326d0d 100644 --- a/docs/source/docs/contributing/design-descriptions/camera-matching.md +++ b/docs/source/docs/contributing/design-descriptions/camera-matching.md @@ -4,7 +4,7 @@ Diagrams generated by the [PlantUML UML editor](https://www.plantuml.com/plantum ## Initial Setup -When PhotonVision first starts, settings are loaded from disk and [VisionSources](https://javadocs.photonvision.org/org/photonvision/vision/processes/VisionSource.html) are created for every serialized & active [Camera Configuration](https://javadocs.photonvision.org/org/photonvision/common/configuration/CameraConfiguration.html) +When PhotonVision first starts, settings are loaded from disk and [VisionSources](https://javadocs.photonvision.org/release/org/photonvision/vision/processes/VisionSource.html) are created for every serialized & active [Camera Configuration](https://javadocs.photonvision.org/release/org/photonvision/common/configuration/CameraConfiguration.html) ![](https://www.plantuml.com/plantuml/png/VP5FQnin4CNl-XI3JotK-DAJAI6fIw6GfOMbFkKoramSqTKVfF6MVFkETfKsei6trVpUldbwkYs2MIv-CeI29omCcn5d9XXPn8LpsG0MAErWaggTTGc3m6P05nRizQD7HrTS3336IxOC0mOySrwqS_5lIeT8bubxgVTNN9jRhpYCXvXNP8lLpokxsWvZNcwtlQaNsSDzH8B773sGAxzC7MvlDFSUxeXWKie4DeP7futelC8z73AZCDnPSJD35xKOh5F5DR31IU3d-1aiUive06PTlSRTm_V4eH4uFJ-4Aamn2xmxFMyJojDx0x2AjtNn-WSJ73_UltRyzC_o2mjRQH1IZecpE4t5WPOmX_5R7sPof_NyVvwghNbK-LVL1sbErTneFLqxNxF27pdEZZXNs8gjbJFrhHdYLxMredrx1Obm70QZvnUBtKxdJE2NnosxNVj3qIYO1GB_Rb3DEZAlQxKPowMuS7u8oIMUNE0F84-PaOgvvK0NF_q1)