Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor for multiple deployment targets #83

Open
1 of 2 tasks
ES-Alexander opened this issue May 18, 2023 · 0 comments
Open
1 of 2 tasks

Refactor for multiple deployment targets #83

ES-Alexander opened this issue May 18, 2023 · 0 comments
Assignees
Labels
infrastructure Structure rather than content

Comments

@ES-Alexander
Copy link
Collaborator

ES-Alexander commented May 18, 2023

  • Versioned BlueOS docs will be hosted at blueos.cloud/docs (via BlueOS-deploy branch (WIP))
  • Versioned ArduSub docs will be hosted at ardusub.com (via a new ArduSub-deploy branch perhaps?)
  • In future Cockpit docs will be hosted at blueos.cloud/cockpit/docs
  • Docs for a specific version of BlueOS will be made available as a BlueOS extension (where the extension version corresponds to the version of BlueOS it documents)
  • ArduSub docs will also be made available locally in BlueOS, likely via some form of extension
    • Not sure yet if it's best to provide all versions, or just a specific version per extension version like for BlueOS
    • Not sure yet how best to handle docs for other ArduPilot firmwares
      • Should they be bundled with the ArduSub ones on a per-version basis?
      • Should they be separated by vehicle type?
      • Should there be a single "ArduPilot Docs Manager" extension that allows selecting firmware types and versions to download / remove docs for?
        • This seems likely to be the best user experience, but is likely also extra development effort

  • Some of the docs (e.g. hardware/integration) are shared amongst multiple targets, so should be refactored into their own branches and pulled in as appropriate via submodules (to avoid needing to maintain them separately)
  • We may also want to refactor the zola templates into a submodule for the same reason
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
infrastructure Structure rather than content
Projects
None yet
Development

No branches or pull requests

1 participant