Skip to content

Update the Uploads development docs

David Fernandez requested to merge 10io-update-uploads-development-docs into master

What does this MR do?

When I started working on adding support for new upload, the development documentation was very lacking and information was sparse. I invested a good chunk of time looking for information.

To prevent that from happening again, this MR updates the Uploads development documentation page with a new section How to add a new upload route.

This new section provides the general overview of the tasks and code to implement to support a new upload. Among other things, it properly lays out that uploads have to be implemented on two components: workhorse and rails.

Related issues

Author's checklist (required)

Do not add the feature, frontend, backend, ~"bug", or database labels if you are only updating documentation. These labels will cause the MR to be added to code verification QA issues.

When applicable:

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by Marcia Ramos

Merge request reports

Loading