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

Add design proposal with diagrams for feedback #1

Merged
merged 7 commits into from
May 5, 2020
Merged

Conversation

sigalsax
Copy link
Owner

@sigalsax sigalsax commented Mar 5, 2020

This PR adds the design for the project as well as diagrams for visibility and feedback

README.md Outdated


# Phase 0
- [x] Reach out to developers, PO/Ms, and SEs to understand the pain points and use this feedback to develop tooling that will feature in the project
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Where can I find the summary of the discussions? don't need the full discussion, just the results/insights

README.md Outdated
# Phase 0
- [x] Reach out to developers, PO/Ms, and SEs to understand the pain points and use this feedback to develop tooling that will feature in the project

- [x] Define an MVP that will provide immediate value and a running backlog
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same question - where is the definition of the MVP?

README.md Outdated

The following represnts the use case diagram for this project.

![Use Case Service Diagram](./useCaseServiceMapping.png)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please use Activity diagram

README.md Outdated

### Open questions:

- I provided the Use Case Diagram above but do not feel that those (`Get Container Data` and `Extract Logs/Env`) are use cases as these items depend on Troubleshooting to operate correctly. Are there more use cases besides troubleshooting?
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a question for the PO/PM (in this case it is you and the field)
Troubleshooting can be a use case if you can define the flow... you probably can extract "child" use cases from it but get container data is a technical functionality and not a use case (I want to get logs/specific details, not just arbitrary data)

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what might be a child use case?

README.md Outdated

- I provided the Use Case Diagram above but do not feel that those (`Get Container Data` and `Extract Logs/Env`) are use cases as these items depend on Troubleshooting to operate correctly. Are there more use cases besides troubleshooting?

- In the Troubleshooting class should I use a factory method that chooses between 2 different classes (DAP/Conjur) that implements the same interface (ConjurEnv)?
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You tell me :)
in any case I would start with the HLD first to better understand the system.

README.md Outdated

- In the Troubleshooting class should I use a factory method that chooses between 2 different classes (DAP/Conjur) that implements the same interface (ConjurEnv)?

- What language to write this project in?
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

English ;) (A.K.A - what language you feel the project has the most chances to be successful?)

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thinking TS b/c I want to use Angular for the UI. I found this wrapper to help bootstrap some Docker processes https://www.npmjs.com/package/node-docker-api

@sigalsax sigalsax force-pushed the design-proposal branch 3 times, most recently from e5102cc to e51218b Compare April 13, 2020 06:19
@sigalsax sigalsax force-pushed the design-proposal branch 2 times, most recently from 739ceb6 to cfc1b95 Compare April 20, 2020 05:28
README.md Outdated
- What language to write this project in?

- Angular/Typescript, Node Docker API: https://www.npmjs.com/package/node-docker-api
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You plan this to be UI only project?

Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

no, just added a detail description of the backend

@sigalsax sigalsax merged commit 8bb319b into master May 5, 2020
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

Successfully merging this pull request may close these issues.

2 participants