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

Getting Started Documentation for Supported Environments #1164

Open
sgettys opened this issue Jan 9, 2025 · 1 comment
Open

Getting Started Documentation for Supported Environments #1164

sgettys opened this issue Jan 9, 2025 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@sgettys
Copy link
Contributor

sgettys commented Jan 9, 2025

Affected Documentation Section

Which section of the documentation needs to be updated?
UDS Core -> Distribution Support


Update Details

There should be "Getting started" documentation for the supported distributions and environments to make it very easy to spin up UDS Core in one of the supported environments. This could be a combination of scripts/automation as well as step by step guides. The expected outcome would be very simple guide to deploy UDS Core in the supported environment in a deterministic way.


Why Is This Update Needed?

The current documentation and support around k3d is great and answers a lot of use case questions! There should be that level of support and guidance on all of the supported environments to lower the complexity to get UDS Core deployed in a representative environment for the potential mission. This would lower the barrier of entry to get UDS Core running in environments where k3d might not be an option but some other supported environment is.


@sgettys sgettys added the documentation Improvements or additions to documentation label Jan 9, 2025
@sgettys sgettys self-assigned this Jan 10, 2025
@mjnagel
Copy link
Contributor

mjnagel commented Jan 10, 2025

This might also overlap/help close out #387

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants