Skip to content

[CO-279] Document project architecture #4

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 8 commits into from
May 15, 2018
Merged

[CO-279] Document project architecture #4

merged 8 commits into from
May 15, 2018

Conversation

@HirotoShioi
Copy link
Contributor

@HirotoShioi HirotoShioi commented May 7, 2018 •
edited
Loading

Description

This PR introduces document regarding project architecture.
It tries to explain the following:

  • General purpose of this project.
  • How one can identify issue using log file.
  • Use case diagram on how it works.
  • Requirements
  • Introduces its features.

Linked issue

https://iohk.myjetbrains.com/youtrack/issue/CO-279

@HirotoShioi HirotoShioi force-pushed the co-279-document-project-architecture branch from 84659fe to a39d3e5 Compare May 7, 2018 04:57
@HirotoShioi HirotoShioi self-assigned this May 7, 2018
StavrosChryselis
StavrosChryselis suggested changes May 8, 2018
View reviewed changes
Copy link

@StavrosChryselis StavrosChryselis left a comment •
edited
Loading

Choose a reason for hiding this comment

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

We should switch to agent email / password authentication and not use an API token for this tool. That way we also ensure that only an agent can use this.

StavrosChryselis
StavrosChryselis reviewed May 8, 2018
View reviewed changes
Copy link

@StavrosChryselis StavrosChryselis left a comment

Choose a reason for hiding this comment

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

What do the circles represent? Haskell modules?

@HirotoShioi
Copy link
Contributor Author

HirotoShioi commented May 9, 2018 •
edited
Loading

@StavrosChryselis Thank you for your review!

We should switch to agent email / password authentication and not use an API token for this tool. That way we also ensure that only an agent can use this.

That is a good point, we can add that to the task. However I do not think that is related to this document..

What do the circles represent? Haskell modules?

This is a use case diagram. (You can see more description regarding diagram here)
Circles represent funtionality (action) log-classifier system provides to the Zendesk agent. I'll add the link to the document as well.

StavrosChryselis
StavrosChryselis reviewed May 9, 2018
View reviewed changes
README.md Outdated
- Ticket sent from Daedalus bug report has log file attached. Classifier will analyze the log file that is attached to the ticket. If any known issues where found, it'll then post an comment to that ticket. (See example below)
- It uses [CSV](https://en.wikipedia.org/wiki/Comma-separated_values) (basically small record file) which contains all the information need to perform analysis. This make it so it is easy to add new known issues.
- Zendesk agent will use [command line interface](https://en.wikipedia.org/wiki/Command-line_interface) in order to run the classifier.
- Classifier will use the [Zendesk API](https://developer.zendesk.com/rest_api/docs/core/introduction) to perform any action. Because of this, agents will need to provide Zendesk token to the classifier.
Copy link

@StavrosChryselis StavrosChryselis May 9, 2018

Choose a reason for hiding this comment

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

It's related to this line, let's change this to basic auth.

@HirotoShioi
Copy link
Contributor Author

HirotoShioi commented May 9, 2018

Fixed!

rokburgar
rokburgar reviewed May 10, 2018
View reviewed changes
README.md Outdated

Classifier will analyze the log file attached to the ticket. If any issues where found, it will post a comment which states

- Errror code
Copy link

@rokburgar rokburgar May 10, 2018

Choose a reason for hiding this comment

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

Error

Copy link
Contributor Author

@HirotoShioi HirotoShioi May 11, 2018

Choose a reason for hiding this comment

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

@rokburgar Fixed! Thank you!

HirotoShioi and others added 2 commits May 11, 2018 09:45
@HirotoShioi HirotoShioi force-pushed the co-279-document-project-architecture branch from 2a7f1bb to 9891b11 Compare May 15, 2018 03:13
@HirotoShioi
Copy link
Contributor Author

HirotoShioi commented May 15, 2018

Added simple use-case scenario on when/how to use the classifier.

@HirotoShioi HirotoShioi force-pushed the co-279-document-project-architecture branch from 9891b11 to 692e4d0 Compare May 15, 2018 04:43
@ksaric ksaric merged commit 9520080 into master May 15, 2018
@ksaric ksaric deleted the co-279-document-project-architecture branch May 15, 2018 09:26
@ksaric
Copy link
Contributor

ksaric commented May 15, 2018

@StavrosChryselis Please report this in a ticket and explain it a bit more - #4 (review)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

2 more reviewers

@rokburgar rokburgar rokburgar left review comments

@StavrosChryselis StavrosChryselis StavrosChryselis requested changes

Reviewers whose approvals may not affect merge requirements

Assignees

@HirotoShioi HirotoShioi

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@HirotoShioi @ksaric @rokburgar @StavrosChryselis