linkedin / linkedin/oncall

Documentation: Adding a new application to oncall for iris integration.

Open
#238 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
1.3k
Forks
245
PR merge metrics
No merged PRs in 30d

Description

It's not immediately obvious that for Oncall and Iris integration to work for user import, the database has to be updated with an application entry in the application table. This would be helpful for new users.

In our case, we used the following insert statement:
`INSERT INTO application (`name`,`key`) VALUES ("myapp","mykey");`

and in iris configuration, we added:

```
oncall-app: myapp # application for oncall auth
oncall-key: mykey # API key for oncall auth
```

Contributor guide

Open the contributing guide

Research direction

Find the documentation covering Oncall and Iris integration and review how user import setup is currently explained. Document that an application row must be added to the application table and that the matching oncall-app and oncall-key values must be configured in Iris. Done means a new user can follow the documented setup without discovering this database step separately.

Written by the indexing model from the issue text.

Assessment

Tech stack
sql
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.