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

Include state machine diagram in Vehicle State docs #524

Closed
thekaveman opened this issue Jun 19, 2020 · 4 comments · Fixed by #530
Closed

Include state machine diagram in Vehicle State docs #524

thekaveman opened this issue Jun 19, 2020 · 4 comments · Fixed by #530
Assignees
Labels
Agency Specific to the Agency API documentation documentation change can be for code and/or markdown pages Provider Specific to the Provider API State Machine Changes in the vehicle state events and state machine diagram
Milestone

Comments

@thekaveman
Copy link
Collaborator

After #506 is merged, we'll have a reconciled state machine between Agency and Provider. We've been working on an updated state machine diagram, and it would be helpful to include an image of this diagram directly inline with the new docs on Vehicle State introduced with #506.

@thekaveman thekaveman added Provider Specific to the Provider API Agency Specific to the Agency API State Machine Changes in the vehicle state events and state machine diagram documentation documentation change can be for code and/or markdown pages labels Jun 19, 2020
@thekaveman thekaveman added this to the 1.0.0 milestone Jun 19, 2020
@schnuerle
Copy link
Member

schnuerle commented Jun 25, 2020

I can make a PR for this. I think the State Machine Diagram (SMD) should live as a file in the repo.

  1. Where should the file go? At the root level, maybe in /schema, or in a new folder (eg, /resources)?

  2. I think it should be a SVG file since that renders well on Github. Could also be a PNG. Thoughts?

@schnuerle schnuerle self-assigned this Jun 25, 2020
@thekaveman
Copy link
Collaborator Author

thekaveman commented Jun 25, 2020

SVG as long as it is easy to update. If we're just going from the Google Doc and it can be exported, then whatever format is supported for export is fine by me.

As for where it lives... root seems fine for now? It is a top-level item that applies to the entire spec.

@schnuerle
Copy link
Member

schnuerle commented Jun 25, 2020

SVG, PNG, JPG, and PDF are all export options. Easy to update since any change can then be exported as SVG again.

Can also export as PowerPoint, so anyone could take that file and modify (if we store the file in a repo). We could provide a link to the Google Slides under the diagram so people can grab that, and make changes if they want.

Current diagram is in an /images folder in agency. https://raw.githubusercontent.com/openmobilityfoundation/mobility-data-specification/main/agency/images/MDS_agency_event_state.png

@schnuerle schnuerle linked a pull request Jun 25, 2020 that will close this issue
@schnuerle
Copy link
Member

Completed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Agency Specific to the Agency API documentation documentation change can be for code and/or markdown pages Provider Specific to the Provider API State Machine Changes in the vehicle state events and state machine diagram
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants