Reorganise user facing scripts and deployments

StarlingUAS / ProjectStarling

BRL Flight Arena Infrastructure 2.0

Other

17 stars 3 forks source link

Reorganise user facing scripts and deployments #116

Closed mhl787156 closed 2 years ago

mhl787156 commented 3 years ago

This PR moves the docker-compose and other deployment and running files into a new Repository named Murmuration. This repository is then added as a submodule within ProjectStarling.

The idea is that end users in most cases only need to clone and use Murmuration, with only maintainers using ProjectStarling. Murmuration should stay as a submodule within ProjectStarling for eventual use as integration test targets within CI.

Documentation has been updated to reflect this change.

mhl787156 commented 2 years ago

A V1 of the CLI has been completed in Murmurations: https://github.com/StarlingUAS/Murmuration This PR: https://github.com/StarlingUAS/Murmuration/pull/4

Migrates docker-compose examples
Migrates kubernetes deployment examples
Provides a CLI in which to interact with both docker-compose and kubernetes with respect to Starling.

Additional Tasks

[x] Update this branch to latest dev
[x] Remove deployments and examples from projectstarling (this repo)
[x] Update Documentation to include CLI
[x] Update Documentation to point to Mumuration as the starting point

mhl787156 commented 2 years ago

For now all the docs are in the base repo, but yes I agree I think we should move them out. Perhaps we should just stick with the default github url if we want to do that?.

I wonder if we could create an automated custom 'organisation contents' page though! Do you know if there's a way to stick a website on https://starlinguas.github.io/ directly?