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

Write Design Document for pico-engine pod library #7

Open
windley opened this issue Jan 24, 2024 · 3 comments
Open

Write Design Document for pico-engine pod library #7

windley opened this issue Jan 24, 2024 · 3 comments
Assignees

Comments

@windley
Copy link
Member

windley commented Jan 24, 2024

Write a design document for the pod module within the following parameters:

  1. State the goal. Describe the problem.
  2. List your assumptions
  3. Design and describe how the pod will be identified and how the pico will be authenticated
  4. Design and describe the functions needed to query the pod and the pod server
  5. Design and describe the actions needed to make changes to the pod server.
  6. Describe what isn't included and why.

Design document should be fewer than 5 pages (not counting appendices)

Be sure your design includes a function that rulesets can call to know if there is a pod server running or not. The module should not interfere with engine operation if not pod server is associated with the engine and all operations should fail gracefully (error) if called when no pod server is present.

@windley
Copy link
Member Author

windley commented Jan 25, 2024

Do this as a group.

@windley
Copy link
Member Author

windley commented Jan 25, 2024

Use the user stories here to guide your design. https://picolabs.atlassian.net/wiki/spaces/docs/pages/2460811281/Picos+and+Pods

@windley
Copy link
Member Author

windley commented Feb 1, 2024

Make sure you list any assumptions up front
Be sure to be wary of one-way doors.

@windley windley changed the title Write Design Document for pico-engine pod module Write Design Document for pico-engine pod library Feb 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants