Ardupilot开源飞控之Wiki修改操作

news/2024/7/10 18:56:03 标签: 开源, Ardupilot

Ardupilot开源飞控之Wiki修改操作

  • 1. 源由
  • 2. 页面编辑修改
    • 2.1 Step 1: 申请Github账号
    • 2.2 Step 2: 选择修改页面
    • 2.3 Step 3: 修改页面内容
    • 2.4 Step 4: 提交修改
    • 2.5 Step 5: 新增PR
  • 3. 增删页面修改
    • 3.1 Step 1: 克隆本地的Ardupilot Wiki
    • 3.2 Step 2: 搭建本地验证环境
    • 3.3 Step 3: 增删改内容
    • 3.4 Step 4: Github PR操作
  • 4. Ardupilot Wiki结构介绍

1. 源由

最近为了为了增加一些Ardupilot Wiki内容,对Wiki的编辑提交步骤整理一下,以便后续工作的展开。

修改过程大致可以分为两大类:

  1. 页面编辑修改
  2. 增删页面修改

2. 页面编辑修改

原文链接详见:Wiki Editing - Quick Edits

2.1 Step 1: 申请Github账号

Create a Github account if you do not have one already

没有Github账号的同学,需要首先申请Github账号。

注:如果遇到任何问题,请仔细阅读帮助文档Get started with GitHub documentation。

2.2 Step 2: 选择修改页面

Find the page you wish to edit and click the Edit on GitHub link on the top right of the page to be taken to its source, Select the Edit this file icon

首先,在Ardupilot Wiki上,找到需要修改的页面。
然后,在网页右上方找到Edit on Github链接,点击进入。

在这里插入图片描述

2.3 Step 3: 修改页面内容

Make the changes in the “Edit file” tab and use the “Preview changes” tab to check the change.
Note: links to other wiki pages are not rendered properly and will appear with :ref:` in front

  1. 请注意,此时应该有Github账号登录(这也就是为什么第一步是申请账号,如果没有登录会提示登录)。
  2. 点击Github上的修改按钮,进行相应文档内容的修改和编辑。
    在这里插入图片描述

2.4 Step 4: 提交修改

At the bottom of the page under “Commit changes”

当有修改变动后,【Commit changes】会变亮,此按钮可以提交修改。

在这里插入图片描述在这里插入图片描述

2.5 Step 5: 新增PR

When taken to the “Open a pull request” screen, press the “Create pull request” button

在这里插入图片描述
此时,git库上,会新增一个分支来保存这个改动。

$ git pull
Already up to date.
daniel@palfocus:~/ArduPilot/ardupilot_wiki$ git pull
remote: Enumerating objects: 21, done.
remote: Counting objects: 100% (21/21), done.
remote: Compressing objects: 100% (15/15), done.
remote: Total 21 (delta 6), reused 10 (delta 5), pack-reused 0
Unpacking objects: 100% (21/21), 123.80 KiB | 248.00 KiB/s, done.
From github.com:lida2003/ardupilot_wiki
 * [new branch]        patch-3    -> origin/patch-3
Already up to date.

$ git checkout patch-3
Branch 'patch-3' set up to track remote branch 'patch-3' from 'origin'.
Switched to a new branch 'patch-3'

$ git log -n 1
commit 98f5a52e7b38ae9a63c2cc0db1569ae169c59995 (HEAD -> patch-3, origin/patch-3)
Author: Daniel Li <lida_mail@163.com>
Date:   Wed Nov 1 04:55:29 2023 +0800

    Test and Drop

    Test and Drop



3. 增删页面修改

这个操作主要问题在于需要动到文件的增加和删除,此时涉及:

  1. 常规的git库文件操作
  2. 编辑效果展示(构建web页面)

Ardupilot_Wiki_93">3.1 Step 1: 克隆本地的Ardupilot Wiki

$ git clone git@github.com:lida2003/ardupilot_wiki.git

3.2 Step 2: 搭建本地验证环境

详细可以参考:Wiki Editing - Setting Up the Environment

一般Linux原生态环境是兼容性最好的,其他虚拟机之类,个人并不推荐。

在ubuntu上安装编译工具:

$ lsb_release -a
No LSB modules are available.
Distributor ID: Ubuntu
Description:    Ubuntu 22.04.3 LTS
Release:        22.04
Codename:       jammy

$ ./Sphinxsetup.sh

编译html文档命令如下:

$ cd ardupilot_wiki
$ python3 update.py (to build all wikis)
$ python3 update.py --site copter  (to build just the copter wiki)
$ python3 update.py --site plane   (to build just the plane wiki)
$ python3 update.py --site rover   (to build just the rover wiki)
$ python3 update.py --site dev     (to build just this developer wiki)

编译构建html文档位置

  • For Copter look for ardupilot_wiki/copter/build/html/index.html
  • For Plane look for ardupilot_wiki/plane/build/html/index.html
  • For Rover look for ardupilot_wiki/rover/build/html/index.html
  • For Developer look for ardupilot_wiki/dev/build/html/index.html

3.3 Step 3: 增删改内容

  • Notepad++ 推荐使用
  • ssh git操作
  • samba共享,浏览器确认结果
$ git branch patch-4
$ git add .
$ git commit -m "Copter: change......"
$ git push

注意事项

  • Wiki Editing Style Guide
  • Wiki Editing - Archiving and Deleting

3.4 Step 4: Github PR操作

略,不再赘述,详见:Creating a pull request

Ardupilot_Wiki_154">4. Ardupilot Wiki结构介绍

详见:Wiki Infrastructure Overview

.
|-- Dockerfile
|-- LICENSE
|-- Makefile
|-- README.md
|-- Sphinxsetup.bat
|-- Sphinxsetup.sh
|-- Vagrantfile
|-- antennatracker   // ATT天线
|-- ardupilot  // 官网主页
|-- blimp // 飞艇,气球
|-- build_parameters.py
|-- common // 通用页面
|-- common_conf.py
|-- copter // 多旋翼
|-- dev // 开发者
|-- frontend
|-- images
|-- js
|-- logos
|-- mavproxy // mavprox
|-- plane // 固定翼
|-- planner // mission planner
|-- planner2 // APM Planner 2
|-- rover // 车
|-- rst_table.py
|-- scripts
|-- update.py
`-- update.sh


http://www.niftyadmin.cn/n/5147991.html

相关文章

Linux内核详解,什么是linux内核?

linux 内核是 Linux 操作系统的核心组件&#xff0c;负责管理计算机的硬件资源、提供系统调用接口、调度进程和管理内存等重要功能。本文将详细介绍 Linux 内核的组成、功能和关键技术&#xff0c;以及其在操作系统中的重要作用。 一、Linux 内核概述 Linux 内核是一个具有模块…

【python VS vba】(5) 在python中使用xlwt操作Excel(待完善ing)

目录 1 什么是xlwt 2 导入xlwt 3 相关语法 3.1 创建新的workbook 3.2 创建新的sheet 3.3 保存workbook 4 python里表格的形式 4.1 矩阵 4.2 EXCEL的数据形式 完全等于矩阵的数字结构 4.3 python里矩阵 5 具体代码 5.1 代码 5.2 结果 5.3 要注意的问题 5.3.1 不能…

单例模式读取配置文件

单例模式&#xff08;Singleton Pattern&#xff09;是一种常见的设计模式&#xff0c;它确保一个类只有一个实例&#xff0c;并提供一个全局访问点以获取该实例。当你需要在应用程序中读取配置文件时&#xff0c;使用单例模式可以确保你只创建一个配置对象&#xff0c;以避免重…

如何理解API?API 是如何工作的呢?

大家可能最近经常听到 API 这个概念&#xff0c;那什么是API&#xff0c;它又有什么特点和好处呢&#xff1f; wiki 百科镇楼 APIs are] a set of subroutine definitions, protocols, and tools for building application software. In general terms, it’s a set of clear…

什么是OTP认证?OTP认证服务器有哪些应用场景?

OTP是一次性密码&#xff0c;即只能使用一次的密码。它基于专门的算法&#xff0c;每隔60秒生成一个不可预测的随机数字组合。这种密码的有效期仅在一次会话或交易过程中&#xff0c;因此不容易受到重放攻击。在计算器系统或其他数字设备上&#xff0c;OTP是一种只能使用一次的…

【SA8295P 源码分析】116 - AIS Camera 帧同步信号的 fsyncGpio 及 fsyncFreq 原理分析

【SA8295P 源码分析】116 - AIS Camera 帧同步信号的 fsyncGpio 及 fsyncFreq 原理分析 一、帧同步信号的 fsyncGpio 及 fsyncFreq 原理分析1.1 CameraConfigSA8295.c 配置表中配置 fsyncGpio 和 fsyncFreq1.2 配置 MAX96722 解串器 Frame Sync 相关参数:在初始化参数中配置 F…

B端设计必看的9个开源组件库,值得收藏!

如果你想开发一款To B Web端产品&#xff0c;如何选择令人眼花缭乱的开源组件库&#xff1f;行业团队常用的B端开源组件库是什么&#xff1f;今天&#xff0c;我们将为您带来入门级开源组件库的介绍。你可以先有一个大致的了解&#xff0c;希望能对你有所帮助。未来&#xff0c…

云DR数据、应用程序和硬件的紧急备份恢复

云很方便,但是需要做好紧急备份恢复工作。 什么是云容灾(Cloud DR)? 云灾难恢复或简称云 DR 是指数据、应用程序和硬件的紧急备份策略,与传统方法不同,它依赖于云中的存储。 发生故障时,受影响的数据、应用程序和其他资源可以一键从云端恢复,以便尽快恢复业务。 服务提…