From 78ce9943658b7620609c6bdffafd40a1c4a0a8e8 Mon Sep 17 00:00:00 2001 From: Harri Makelin Date: Sun, 12 May 2024 20:22:58 +0100 Subject: [PATCH 1/7] Fix vitepress docs distributable path in guide --- docs/vitepress/docs/generate-documentation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/vitepress/docs/generate-documentation.md b/docs/vitepress/docs/generate-documentation.md index 64d6dfd4..5465a74e 100644 --- a/docs/vitepress/docs/generate-documentation.md +++ b/docs/vitepress/docs/generate-documentation.md @@ -35,7 +35,7 @@ docker compose -p gisnav run gisnav make docs The static HTML documentation will appear in the below folder: ```text -~/colcon_ws/src/gisnav/docs/vitepress/docs/dist +~/colcon_ws/src/gisnav/docs/vitepress/docs/.vitepress/dist ``` ## Serve VitePress documentation From f7a68e50d773900f49865fdf0ade191c0378a1ae Mon Sep 17 00:00:00 2001 From: Harri Makelin Date: Sun, 12 May 2024 21:33:28 +0100 Subject: [PATCH 2/7] Fix Gazebo cross-reference in glossary --- docs/vitepress/docs/glossary.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/vitepress/docs/glossary.md b/docs/vitepress/docs/glossary.md index fc55c62a..2ca1c933 100644 --- a/docs/vitepress/docs/glossary.md +++ b/docs/vitepress/docs/glossary.md @@ -167,7 +167,7 @@ A software application that facilitates communication between other software app ### Model - A machine learning model or neural [network](#network). In GISNav used specifically for [camera](#camera) [pose](#pose) estimation. -- A [Gazebo][#gazebo] model, more specifically a [vehicle](#vehicle) model +- A [Gazebo](#gazebo) model, more specifically a [vehicle](#vehicle) model ### Module A [Python](#python) module. From 6c1b85f139e42a1357e46a5270610656a1b25c26 Mon Sep 17 00:00:00 2001 From: Harri Makelin Date: Sun, 12 May 2024 21:47:01 +0100 Subject: [PATCH 3/7] Remove old Docker related Todo from generate documentation page --- docs/vitepress/docs/generate-documentation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/vitepress/docs/generate-documentation.md b/docs/vitepress/docs/generate-documentation.md index 5465a74e..6c171b42 100644 --- a/docs/vitepress/docs/generate-documentation.md +++ b/docs/vitepress/docs/generate-documentation.md @@ -25,7 +25,7 @@ cd ~/colcon_ws/src/gisnav make docs ``` -```bash [Docker (Todo: not implemented)] +```bash [Docker] cd ~/colcon_ws/src/gisnav/docker docker compose -p gisnav run gisnav make docs ``` From 115931306477827e1caa3b4e53388ed0313a6449 Mon Sep 17 00:00:00 2001 From: Harri Makelin Date: Sun, 12 May 2024 21:50:42 +0100 Subject: [PATCH 4/7] Updates to system architecture page to reflect recent API reference and VO updates --- docs/vitepress/docs/system-architecture.md | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/docs/vitepress/docs/system-architecture.md b/docs/vitepress/docs/system-architecture.md index ca01eb09..d8592456 100644 --- a/docs/vitepress/docs/system-architecture.md +++ b/docs/vitepress/docs/system-architecture.md @@ -1,6 +1,6 @@ # System architecture -The GISNav ROS 2 package receives upstream inputs from the autopilot via MAVLink and transforms them in multiple sequential steps to downstream outputs, the most important of which are the NMEA mock GPS messages. In GISNav this data processing algorithm is expressed as a distributed unidirectional network of ROS nodes. +The GISNav ROS 2 package receives upstream inputs from the autopilot via MAVLink and transforms them in multiple sequential steps to downstream outputs, the most important of which are the mock GPS messages. In GISNav this data processing algorithm is expressed as a distributed unidirectional network of ROS nodes. The GISNav ROS application also has many external interfaces and effective development requires a simulation environment. GISNav defines and [deploys that simulation environment with Docker Compose](/deploy-with-docker-compose). @@ -8,11 +8,7 @@ This page provides an overview of both the topography of the GISNav ROS 2 packag ## ROS topography -The core ROS topography diagram below depicts how ROS messages flow through GISNav. The API reference(under construction) has more detailed information on the purpose and design of each ROS node. - -::: info `MonocularStereoImage` currently disabled -This diagram depicts partially implemented but disabled visual odometry (VO) functionality (`MonocularStereoImage`). -::: +The core ROS topography diagram below depicts how ROS messages flow through GISNav. The [API reference](/reference/) has more detailed information on the purpose and design of each ROS node. ::: info Todo - From BBoxNode, publish map to `base_link` and `base_link` to `camera` transformations separately to simplify implementation and reduce amount of maintained code. From 9a8ceb095bd3b2967f3188b0694b001de365b06d Mon Sep 17 00:00:00 2001 From: Harri Makelin Date: Sun, 12 May 2024 21:58:02 +0100 Subject: [PATCH 5/7] Fix GIS software list on Setup GIS page --- docs/vitepress/docs/setup-gis-server.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/docs/vitepress/docs/setup-gis-server.md b/docs/vitepress/docs/setup-gis-server.md index f8cfd124..583a07a7 100644 --- a/docs/vitepress/docs/setup-gis-server.md +++ b/docs/vitepress/docs/setup-gis-server.md @@ -91,9 +91,7 @@ firefox "http://localhost:80/?map=/etc/mapserver/wms.map&service=WMS&request=Get If you want to run your own GIS server or WMS proxy, you may want to consider these FOSS options: - MapServer -- [GeoServer](https://geoserver.org) (full-fledged OGC-compliant GIS server - -) +- [GeoServer](https://geoserver.org) (full-fledged OGC-compliant GIS server) - [Mapnik](https://mapnik.org) and [MapProxy](https://mapproxy.org) ## Orthoimagery and DEMs From bc006d9c36681023b7afd5669183a2ea20306133 Mon Sep 17 00:00:00 2001 From: Harri Makelin Date: Mon, 13 May 2024 08:27:59 +0100 Subject: [PATCH 6/7] Add missing px4_msgs dependency to local installation instructions --- docs/vitepress/docs/shared/clone-to-colcon-workspace.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/vitepress/docs/shared/clone-to-colcon-workspace.md b/docs/vitepress/docs/shared/clone-to-colcon-workspace.md index 1c055917..f84a5831 100644 --- a/docs/vitepress/docs/shared/clone-to-colcon-workspace.md +++ b/docs/vitepress/docs/shared/clone-to-colcon-workspace.md @@ -4,4 +4,5 @@ Clone latest version of GISNav and dependencies to colcon workspace: cd ~/colcon_ws/src git clone --branch v0.67.0 https://github.com/hmakelin/gisnav.git git clone --branch gimbal-protocol-v2-plugin https://github.com/adinkra-labs/mavros_feature_gimbal-protocol-v2-plugin.git mavros +git clone --branch release/1.14 https://github.com/px4/px4_msgs.git ``` From 93239a43094baae9283de6650d6b1f5060bb1fe5 Mon Sep 17 00:00:00 2001 From: Harri Makelin Date: Mon, 13 May 2024 14:03:53 +0100 Subject: [PATCH 7/7] Disable docker upload workflow on master branch to reduce redundant testing --- .github/workflows/push_gisnav_images.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/push_gisnav_images.yml b/.github/workflows/push_gisnav_images.yml index 58c52c65..5c5b2121 100644 --- a/.github/workflows/push_gisnav_images.yml +++ b/.github/workflows/push_gisnav_images.yml @@ -1,8 +1,8 @@ name: Push latest GISNav multi-arch Docker images to GHCR on: - push: - branches: [ "master" ] + #push: + # branches: [ "master" ] pull_request: branches: [ "master" ]