Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@actions-user
actions-user committed Oct 21, 2024
1 parent f000883 commit aeaa582
Show file tree
Hide file tree
Showing 1,003 changed files with 10,224 additions and 6,792 deletions.
45 changes: 44 additions & 1 deletion _sources/contributing.rst.txt
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,47 @@
.. contributing
#######################################
How to Contribute and Request Features
#######################################

How To Request Features
=======================

All software needs user feedback and feature requests, to grow and maintain
alignment with the needs of its users.

OpenDroneMap is FOSS software. Free and open source (FOSS) projects are interesting
from the inside and outside: from the outside, successful ones feel like they should be able
to do anything, and it’s hard to know what a reasonable request is. From the inside of a
project, they can feel very resource constrained: largely by time, money, and opportunity
overload.

**Demanding that a feature be implemented is probably not going to convince the development team to do so**. Imagine
if somebody knocked on your door and asked you to "stop reading this page right now and come to my house to cook me dinner!". Your first response might very reasonably be "who on earth is this person and why should I spend my time and energy fulfilling his agenda instead of my own?".

**Suggesting** that a feature be implemented is a more effective (and cordial) way to ask for new features, especially if you're prepared to offer some of your own resources (time, funds or both) to help get the feature implemented. Explaining why
*your* suggestion can benefit others can also help. If the feature benefits you exclusively, it might be harder to convince others to do the work for you.

A feature request can be submitted as issues on the applicable Github repository (e.g.,
`WebODM <https://github.com/OpenDroneMap/WebODM/issues>`_ or `ODM <https://github.com/OpenDroneMap/ODM/issues>`_
or similar) or more simply as a discussion topic on `the community forum <https://community.opendronemap.org/>`_.
Try to start by searching these sources to see if someone else has already brought it up. Sometimes a feature is already in
the works, or has at least been discussed.

To request the addition of support for new drone cameras: please share a set of test images on the `datasets channel on the forum <https://community.opendronemap.org/c/datasets/10>`_. Without test images there's not much the developers can do.

And importantly, the trick is to listen: if someone within the project says: "This is a big lift,
we need MONEY or TIME or SOMEONE TO HELP CODE IT" (or possibly a combination of the three)
then there are two answers that work really well in response:

*Ok. I didn’t know it was a big feature request! I hope someone comes along with the necessary resources. As a community member, I would be happy to be an early user and tester!*

or

*Let’s figure out if we can put together the resources to get this done! Here’s what I can contribute toward it: …*

We are glad you are excited to see new features added to the project. Some new features need support,
and some are easier to implement. We'll do our best to help you understand where your request falls, and
we appreciate any support you can provide.


How To Contribute
=================
Expand Down
1 change: 0 additions & 1 deletion _sources/index.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,5 @@ The documentation is available in several languages. Some translations are incom
multispectral
large
flying
requesting-features
contributing
faq
6 changes: 3 additions & 3 deletions _sources/map-accuracy.rst.txt
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#######################################
Accuracy, Ground Control, and Alignment
#######################################
########################
High Precision Workflows
########################

************
Map accuracy
Expand Down
17 changes: 10 additions & 7 deletions arguments/3d-tiles/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -328,7 +328,7 @@
<li class="toctree-l2"><a class="reference internal" href="../../outputs/#list-of-all-outputs">List of all outputs</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../map-accuracy/">Accuracy, Ground Control, and Alignment</a><ul>
<li class="toctree-l1"><a class="reference internal" href="../../map-accuracy/">High Precision Workflows</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../map-accuracy/#map-accuracy">Map accuracy</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../map-accuracy/#what-to-expect">What to expect</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../map-accuracy/#aspects-impacting-map-accuracy">Aspects impacting map accuracy</a></li>
Expand Down Expand Up @@ -395,14 +395,17 @@
<li class="toctree-l2"><a class="reference internal" href="../../flying/#other-resources-on-flying">Other resources on flying</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../requesting-features/">How To Request Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../contributing/">How To Contribute</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../contributing/#community-forum">Community Forum</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../contributing/#reporting-bugs">Reporting Bugs</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../contributing/#template-for-submitting-bug-reports">Template For Submitting Bug Reports</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../contributing/">How to Contribute and Request Features</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../contributing/#how-to-request-features">How To Request Features</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../contributing/#how-to-contribute">How To Contribute</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../contributing/#community-forum">Community Forum</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../contributing/#reporting-bugs">Reporting Bugs</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../../contributing/#template-for-submitting-bug-reports">Template For Submitting Bug Reports</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../../contributing/#pull-requests">Pull Requests</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../contributing/#pull-requests">Pull Requests</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../faq/">Frequently Asked Questions and Additional Resources</a><ul>
Expand Down
17 changes: 10 additions & 7 deletions arguments/align/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -328,7 +328,7 @@
<li class="toctree-l2"><a class="reference internal" href="../../outputs/#list-of-all-outputs">List of all outputs</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../map-accuracy/">Accuracy, Ground Control, and Alignment</a><ul>
<li class="toctree-l1"><a class="reference internal" href="../../map-accuracy/">High Precision Workflows</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../map-accuracy/#map-accuracy">Map accuracy</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../map-accuracy/#what-to-expect">What to expect</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../map-accuracy/#aspects-impacting-map-accuracy">Aspects impacting map accuracy</a></li>
Expand Down Expand Up @@ -395,14 +395,17 @@
<li class="toctree-l2"><a class="reference internal" href="../../flying/#other-resources-on-flying">Other resources on flying</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../requesting-features/">How To Request Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../contributing/">How To Contribute</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../contributing/#community-forum">Community Forum</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../contributing/#reporting-bugs">Reporting Bugs</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../contributing/#template-for-submitting-bug-reports">Template For Submitting Bug Reports</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../contributing/">How to Contribute and Request Features</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../contributing/#how-to-request-features">How To Request Features</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../contributing/#how-to-contribute">How To Contribute</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../contributing/#community-forum">Community Forum</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../contributing/#reporting-bugs">Reporting Bugs</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../../contributing/#template-for-submitting-bug-reports">Template For Submitting Bug Reports</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../../contributing/#pull-requests">Pull Requests</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../contributing/#pull-requests">Pull Requests</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../faq/">Frequently Asked Questions and Additional Resources</a><ul>
Expand Down
17 changes: 10 additions & 7 deletions arguments/auto-boundary-distance/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -328,7 +328,7 @@
<li class="toctree-l2"><a class="reference internal" href="../../outputs/#list-of-all-outputs">List of all outputs</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../map-accuracy/">Accuracy, Ground Control, and Alignment</a><ul>
<li class="toctree-l1"><a class="reference internal" href="../../map-accuracy/">High Precision Workflows</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../map-accuracy/#map-accuracy">Map accuracy</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../map-accuracy/#what-to-expect">What to expect</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../map-accuracy/#aspects-impacting-map-accuracy">Aspects impacting map accuracy</a></li>
Expand Down Expand Up @@ -395,14 +395,17 @@
<li class="toctree-l2"><a class="reference internal" href="../../flying/#other-resources-on-flying">Other resources on flying</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../requesting-features/">How To Request Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../contributing/">How To Contribute</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../contributing/#community-forum">Community Forum</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../contributing/#reporting-bugs">Reporting Bugs</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../contributing/#template-for-submitting-bug-reports">Template For Submitting Bug Reports</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../contributing/">How to Contribute and Request Features</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../contributing/#how-to-request-features">How To Request Features</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../contributing/#how-to-contribute">How To Contribute</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../contributing/#community-forum">Community Forum</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../contributing/#reporting-bugs">Reporting Bugs</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../../contributing/#template-for-submitting-bug-reports">Template For Submitting Bug Reports</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../../contributing/#pull-requests">Pull Requests</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../contributing/#pull-requests">Pull Requests</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../faq/">Frequently Asked Questions and Additional Resources</a><ul>
Expand Down
17 changes: 10 additions & 7 deletions arguments/auto-boundary/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -328,7 +328,7 @@
<li class="toctree-l2"><a class="reference internal" href="../../outputs/#list-of-all-outputs">List of all outputs</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../map-accuracy/">Accuracy, Ground Control, and Alignment</a><ul>
<li class="toctree-l1"><a class="reference internal" href="../../map-accuracy/">High Precision Workflows</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../map-accuracy/#map-accuracy">Map accuracy</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../map-accuracy/#what-to-expect">What to expect</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../map-accuracy/#aspects-impacting-map-accuracy">Aspects impacting map accuracy</a></li>
Expand Down Expand Up @@ -395,14 +395,17 @@
<li class="toctree-l2"><a class="reference internal" href="../../flying/#other-resources-on-flying">Other resources on flying</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../requesting-features/">How To Request Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../contributing/">How To Contribute</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../contributing/#community-forum">Community Forum</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../contributing/#reporting-bugs">Reporting Bugs</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../contributing/#template-for-submitting-bug-reports">Template For Submitting Bug Reports</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../contributing/">How to Contribute and Request Features</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../contributing/#how-to-request-features">How To Request Features</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../contributing/#how-to-contribute">How To Contribute</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../contributing/#community-forum">Community Forum</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../contributing/#reporting-bugs">Reporting Bugs</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../../contributing/#template-for-submitting-bug-reports">Template For Submitting Bug Reports</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../../contributing/#pull-requests">Pull Requests</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../contributing/#pull-requests">Pull Requests</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../faq/">Frequently Asked Questions and Additional Resources</a><ul>
Expand Down
17 changes: 10 additions & 7 deletions arguments/bg-removal/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -328,7 +328,7 @@
<li class="toctree-l2"><a class="reference internal" href="../../outputs/#list-of-all-outputs">List of all outputs</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../map-accuracy/">Accuracy, Ground Control, and Alignment</a><ul>
<li class="toctree-l1"><a class="reference internal" href="../../map-accuracy/">High Precision Workflows</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../map-accuracy/#map-accuracy">Map accuracy</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../map-accuracy/#what-to-expect">What to expect</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../map-accuracy/#aspects-impacting-map-accuracy">Aspects impacting map accuracy</a></li>
Expand Down Expand Up @@ -395,14 +395,17 @@
<li class="toctree-l2"><a class="reference internal" href="../../flying/#other-resources-on-flying">Other resources on flying</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../requesting-features/">How To Request Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../contributing/">How To Contribute</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../contributing/#community-forum">Community Forum</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../contributing/#reporting-bugs">Reporting Bugs</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../contributing/#template-for-submitting-bug-reports">Template For Submitting Bug Reports</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../contributing/">How to Contribute and Request Features</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../contributing/#how-to-request-features">How To Request Features</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../contributing/#how-to-contribute">How To Contribute</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../contributing/#community-forum">Community Forum</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../contributing/#reporting-bugs">Reporting Bugs</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../../contributing/#template-for-submitting-bug-reports">Template For Submitting Bug Reports</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../../contributing/#pull-requests">Pull Requests</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../contributing/#pull-requests">Pull Requests</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../faq/">Frequently Asked Questions and Additional Resources</a><ul>
Expand Down
17 changes: 10 additions & 7 deletions arguments/boundary/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -328,7 +328,7 @@
<li class="toctree-l2"><a class="reference internal" href="../../outputs/#list-of-all-outputs">List of all outputs</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../map-accuracy/">Accuracy, Ground Control, and Alignment</a><ul>
<li class="toctree-l1"><a class="reference internal" href="../../map-accuracy/">High Precision Workflows</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../map-accuracy/#map-accuracy">Map accuracy</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../map-accuracy/#what-to-expect">What to expect</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../map-accuracy/#aspects-impacting-map-accuracy">Aspects impacting map accuracy</a></li>
Expand Down Expand Up @@ -395,14 +395,17 @@
<li class="toctree-l2"><a class="reference internal" href="../../flying/#other-resources-on-flying">Other resources on flying</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../requesting-features/">How To Request Features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../contributing/">How To Contribute</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../contributing/#community-forum">Community Forum</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../contributing/#reporting-bugs">Reporting Bugs</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../contributing/#template-for-submitting-bug-reports">Template For Submitting Bug Reports</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../contributing/">How to Contribute and Request Features</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../../contributing/#how-to-request-features">How To Request Features</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../contributing/#how-to-contribute">How To Contribute</a><ul>
<li class="toctree-l3"><a class="reference internal" href="../../contributing/#community-forum">Community Forum</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../contributing/#reporting-bugs">Reporting Bugs</a><ul>
<li class="toctree-l4"><a class="reference internal" href="../../contributing/#template-for-submitting-bug-reports">Template For Submitting Bug Reports</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../../contributing/#pull-requests">Pull Requests</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../../contributing/#pull-requests">Pull Requests</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../faq/">Frequently Asked Questions and Additional Resources</a><ul>
Expand Down
Loading

0 comments on commit aeaa582

Please sign in to comment.