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.

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

Add documenation for JIRA feature #395

Merged
merged 5 commits into from
Feb 28, 2020
Merged

Add documenation for JIRA feature #395

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4b4bac1
Add documenation for JIRA feature
csteez Feb 28, 2020
af79eec
update link
csteez Feb 28, 2020
ac4fa19
update docs a little bit
csteez Feb 28, 2020
171be8e
add some more clarification
csteez Feb 28, 2020
a5e10b5
remove whitespace
csteez Feb 28, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/application_config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,3 +69,7 @@ _TODO: Please add doc_
## Table Profile

_TODO: Please add doc*_

## Issue Tracking Features
In order to enable Issue Tracking set `IssueTrackingConfig.enabled` to `true` to see UI features. Further configuration
is required to fully enable the feature, please see this [entry](flask_config.md#issue-tracking-integration-features)
23 changes: 23 additions & 0 deletions docs/flask_config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,26 @@ def custom_route():
Amundsen has two features that leverage the custom mail client -- the feedback tool and notifications. For these features a custom implementation of [base_mail_client](https://github.com/lyft/amundsenfrontendlibrary/blob/master/amundsen_application/base/base_mail_client.py) must be mapped to the `MAIL_CLIENT` configuration variable.

To fully enable these features in the UI, the application configuration variables for these features must also be set to true. Please see this [entry](application_config.md#mail-client-features) in our application configuration doc for further information.

## Issue Tracking Integration Features
Amundsen has a feature to allow display of associated tickets within the table detail view. The feature both displays
open tickets and allows users to report new tickets associated with the table. These tickets must contain the
`table_uri` within the ticket text in order to be displayed; the `table_uri` is automatically added to tickets created
via the feature. Tickets are displayed from most recent to oldest, and currently only open tickets are displayed. Currently only
[JIRA](https://www.atlassian.com/software/jira) is supported. The UI must also be enabled to use this feature, please
see configuration notes [here](application_config.md#issue-tracking-features).

There are several configuration
settings in `config.py` that should be set in order to use this feature.

Here are the settings and what they should be set to
```python
ISSUE_TRACKER_URL = None # type: str (Your JIRA environment, IE 'https://jira.net')
ISSUE_TRACKER_USER = None # type: str (Recommended to be a service account)
ISSUE_TRACKER_PASSWORD = None # type: str
ISSUE_TRACKER_PROJECT_ID = None # type: int (Project ID for the project you would like JIRA tickets to be created in)
ISSUE_TRACKER_CLIENT = None # type: str (Fully qualified class name and path)
ISSUE_TRACKER_CLIENT_ENABLED = False # type: bool (Enabling the feature, must be set to True)
ISSUE_TRACKER_MAX_RESULTS = None # type: int (Max issues to display at a time)

```