Skip to content

GitLab

  • Projects
  • Groups
  • Snippets
  • Help
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in
otb
otb
  • Project overview
    • Project overview
    • Details
    • Activity
    • Releases
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 294
    • Issues 294
    • List
    • Boards
    • Labels
    • Service Desk
    • Milestones
  • Merge Requests 15
    • Merge Requests 15
  • CI / CD
    • CI / CD
    • Pipelines
    • Jobs
    • Schedules
  • Operations
    • Operations
    • Incidents
    • Environments
  • Packages & Registries
    • Packages & Registries
    • Container Registry
  • Analytics
    • Analytics
    • CI / CD
    • Repository
    • Value Stream
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Members
    • Members
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • Main Repositories
  • otbotb
  • Issues
  • #2086

Closed
Open
Opened Aug 12, 2020 by Julien Osman@julienosmanDeveloper

Update the documentation about Remote Modules

Target documentation resources

Documentation about the Remote Modules can be found in many places :

  • https://www.orfeo-toolbox.org/CookBook/C++/AddingNewModules.html
  • https://wiki.orfeo-toolbox.org/index.php/Remote_Modules
  • https://wiki.orfeo-toolbox.org/index.php/How_to_write_a_remote_module
  • https://gitlab.orfeo-toolbox.org/orfeotoolbox/otb/-/wikis/Remote-Modules
  • https://gitlab.orfeo-toolbox.org/orfeotoolbox/otb/-/blob/develop/CONTRIBUTING.md#remote-modules

Change requested

It would be better to have the documentation about the Remote Modules in one place, well organized, and up to date. I think the CookBook is the best place for this documentation. Other resources should then link to the CookBook page. A table of content could be:

  1. Introduction (what are remote modules)
  2. Installation of remotes modules (for users who want to use a remote module)
  3. Writing a remote module (for user who want to write a remote module)
    1. The steps to make a remote module
    2. Making it official (what to do to add the remote module to https://gitlab.orfeo-toolbox.org/remote_modules)
Assignee
Assign to
None
Milestone
None
Assign milestone
Time tracking
None
Due date
None
Reference: orfeotoolbox/otb#2086