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

A mission should have a proper description #1843

Open
aeshub opened this issue Dec 3, 2024 · 2 comments
Open

A mission should have a proper description #1843

aeshub opened this issue Dec 3, 2024 · 2 comments
Labels
improvement Improvement to existing functionality Northern Lights

Comments

@aeshub
Copy link
Contributor

aeshub commented Dec 3, 2024

Describe the improvement you would like to see
Implement a description for a mission plan. The description should be given by the user making the plan in the first place and should ideally contain information about the purpose of the mission and any analysis information required. This information should then be readable in the mission run overview.

Most likely this should be implemented in mission planner as a text box which the user is prompted to fill out when creating the mission.

How will this change existing functionality?
Improved understanding of operators of why a mission should be running and potentially what to look out for in case of anomalies detected in some analysis.

How will this improvement affect the current Threat Model?
N/A

@aeshub aeshub added improvement Improvement to existing functionality Northern Lights labels Dec 3, 2024
@aeshub aeshub changed the title A missions should have a proper description A mission should have a proper description Dec 3, 2024
@aeshub
Copy link
Contributor Author

aeshub commented Dec 3, 2024

Suggested implementation in Echo:
The easiest solution is to add another field when creating/editing a mission plan which is a text box called "Description". This takes whatever text the user decides to add and is attached to the mission plan object. Whenever a request for a mission plan is made in the API the description is also attached to the result.

Value:
This is a requested feature from the operators in order to tie back what is the purposed of the robot mission. The user creating the missions knows this best and should be in charge of adding the information. By allowing editing it can also be updated later with more information or if the purpose has changed.

@Eddasol
Copy link
Contributor

Eddasol commented Dec 9, 2024

A few other things to note about comment/description

  • A missionRun has both a description and a comment. Should be enough with just one of them
  • When using custom mission endpoint to schedule a mission with a description and a comment, the corresponding missionRun will have a description visualized in missionPage, but the missionDefinition will not store those values. Image
    The corresponding mission definition will have comment null and no description. If running the mission from missionDefinition, it will not have a description anymore Image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
improvement Improvement to existing functionality Northern Lights
Projects
None yet
Development

No branches or pull requests

2 participants