Fix documentation links (#1766)

# What this PR does

## Which issue(s) this PR fixes

## Checklist

- [x] Unit, integration, and e2e (if applicable) tests updated
- [x] Documentation added (or `pr:no public docs` PR label added if not
required)
- [x] `CHANGELOG.md` updated (or `pr:no changelog` PR label added if not
required)

---------

Co-authored-by: Joey Orlando <joey.orlando@grafana.com>
This commit is contained in:
Shantanu Alsi 2023-04-19 14:42:16 +05:30 committed by GitHub
parent aaff20239b
commit e806ad32f1
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 13 additions and 14 deletions

View file

@ -33,7 +33,7 @@ Developer-friendly incident response with brilliant Slack integration.
We prepared multiple environments: We prepared multiple environments:
- [production](https://grafana.com/docs/grafana-cloud/oncall/open-source/#production-environment) - [production](https://grafana.com/docs/oncall/latest/open-source/#production-environment)
- [developer](./dev/README.md) - [developer](./dev/README.md)
- hobby (described in the following steps) - hobby (described in the following steps)
@ -65,7 +65,7 @@ We prepared multiple environments:
OnCall backend URL: http://engine:8080 OnCall backend URL: http://engine:8080
``` ```
5. Enjoy! Check our [OSS docs](https://grafana.com/docs/grafana-cloud/oncall/open-source/) if you want to set up 5. Enjoy! Check our [OSS docs](https://grafana.com/docs/oncall/latest/open-source/) if you want to set up
Slack, Telegram, Twilio or SMS/calls through Grafana Cloud. Slack, Telegram, Twilio or SMS/calls through Grafana Cloud.
## Update version ## Update version
@ -97,7 +97,7 @@ info on updating Grafana plugins.
## Further Reading ## Further Reading
- _Migration from PagerDuty_ - [Migrator](https://github.com/grafana/oncall/tree/dev/tools/pagerduty-migrator) - _Migration from PagerDuty_ - [Migrator](https://github.com/grafana/oncall/tree/dev/tools/pagerduty-migrator)
- _Documentation_ - [Grafana OnCall](https://grafana.com/docs/grafana-cloud/oncall/) - _Documentation_ - [Grafana OnCall](https://grafana.com/docs/oncall/latest/)
- _Overview Webinar_ - [YouTube](https://www.youtube.com/watch?v=7uSe1pulgs8) - _Overview Webinar_ - [YouTube](https://www.youtube.com/watch?v=7uSe1pulgs8)
- _How To Add Integration_ - [How to Add Integration](https://github.com/grafana/oncall/tree/dev/engine/config_integrations/README.md) - _How To Add Integration_ - [How to Add Integration](https://github.com/grafana/oncall/tree/dev/engine/config_integrations/README.md)
- _Blog Post_ - [Announcing Grafana OnCall, the easiest way to do on-call management](https://grafana.com/blog/2021/11/09/announcing-grafana-oncall/) - _Blog Post_ - [Announcing Grafana OnCall, the easiest way to do on-call management](https://grafana.com/blog/2021/11/09/announcing-grafana-oncall/)

View file

@ -42,7 +42,7 @@ environment variable.
4. You should now see the OnCall plugin configuration page. You may safely ignore the warning about the invalid 4. You should now see the OnCall plugin configuration page. You may safely ignore the warning about the invalid
plugin signature. Set "OnCall backend URL" as "http://host.docker.internal:8080". When opening the main plugin page, plugin signature. Set "OnCall backend URL" as "http://host.docker.internal:8080". When opening the main plugin page,
you may also ignore warnings about version mismatch and lack of communication channels. you may also ignore warnings about version mismatch and lack of communication channels.
5. Enjoy! Check our [OSS docs](https://grafana.com/docs/grafana-cloud/oncall/open-source/) if you want to set up Slack, 5. Enjoy! Check our [OSS docs](https://grafana.com/docs/oncall/latest/open-source/) if you want to set up Slack,
Telegram, Twilio or SMS/calls through Grafana Cloud. Telegram, Twilio or SMS/calls through Grafana Cloud.
6. (Optional) Install `pre-commit` hooks by running `make install-precommit-hook` 6. (Optional) Install `pre-commit` hooks by running `make install-precommit-hook`
@ -167,7 +167,7 @@ and also overrides any defaults that are set in other `.env*` files
## Slack application setup ## Slack application setup
For Slack app configuration check our docs: <https://grafana.com/docs/grafana-cloud/oncall/open-source/#slack-setup> For Slack app configuration check our docs: <https://grafana.com/docs/oncall/latest/open-source/#slack-setup>
## Update drone build ## Update drone build

View file

@ -76,28 +76,28 @@ class LiveSetting(models.Model):
"INBOUND_EMAIL_WEBHOOK_SECRET": "Inbound email webhook secret", "INBOUND_EMAIL_WEBHOOK_SECRET": "Inbound email webhook secret",
"SLACK_SIGNING_SECRET": ( "SLACK_SIGNING_SECRET": (
"Check <a href='" "Check <a href='"
"https://grafana.com/docs/grafana-cloud/oncall/open-source/#slack-setup" "https://grafana.com/docs/oncall/latest/open-source/#slack-setup"
"' target='_blank'>instruction</a> for details how to set up Slack. " "' target='_blank'>instruction</a> for details how to set up Slack. "
"Slack secrets can't be verified on the backend, please try installing the Slack Bot " "Slack secrets can't be verified on the backend, please try installing the Slack Bot "
"after you update them." "after you update them."
), ),
"SLACK_CLIENT_OAUTH_SECRET": ( "SLACK_CLIENT_OAUTH_SECRET": (
"Check <a href='" "Check <a href='"
"https://grafana.com/docs/grafana-cloud/oncall/open-source/#slack-setup" "https://grafana.com/docs/oncall/latest/open-source/#slack-setup"
"' target='_blank'>instruction</a> for details how to set up Slack. " "' target='_blank'>instruction</a> for details how to set up Slack. "
"Slack secrets can't be verified on the backend, please try installing the Slack Bot " "Slack secrets can't be verified on the backend, please try installing the Slack Bot "
"after you update them." "after you update them."
), ),
"SLACK_CLIENT_OAUTH_ID": ( "SLACK_CLIENT_OAUTH_ID": (
"Check <a href='" "Check <a href='"
"https://grafana.com/docs/grafana-cloud/oncall/open-source/#slack-setup" "https://grafana.com/docs/oncall/latest/open-source/#slack-setup"
"' target='_blank'>instruction</a> for details how to set up Slack. " "' target='_blank'>instruction</a> for details how to set up Slack. "
"Slack secrets can't be verified on the backend, please try installing the Slack Bot " "Slack secrets can't be verified on the backend, please try installing the Slack Bot "
"after you update them." "after you update them."
), ),
"SLACK_INSTALL_RETURN_REDIRECT_HOST": ( "SLACK_INSTALL_RETURN_REDIRECT_HOST": (
"Check <a href='" "Check <a href='"
"https://grafana.com/docs/grafana-cloud/oncall/open-source/#slack-setup" "https://grafana.com/docs/oncall/latest/open-source/#slack-setup"
"' target='_blank'>instruction</a> for details how to set up Slack. " "' target='_blank'>instruction</a> for details how to set up Slack. "
"Slack secrets can't be verified on the backend, please try installing the Slack Bot " "Slack secrets can't be verified on the backend, please try installing the Slack Bot "
"after you update them." "after you update them."

View file

@ -45,8 +45,7 @@ OTEL_EXPORTER_OTLP_ENDPOINT = os.environ.get("OTEL_EXPORTER_OTLP_ENDPOINT")
ALLOWED_HOSTS = [item.strip() for item in os.environ.get("ALLOWED_HOSTS", "*").split(",")] ALLOWED_HOSTS = [item.strip() for item in os.environ.get("ALLOWED_HOSTS", "*").split(",")]
# TODO: update link to up-to-date docs DOCS_URL = "https://grafana.com/docs/oncall/latest/"
DOCS_URL = "https://grafana.com/docs/grafana-cloud/oncall/"
# Settings of running OnCall instance. # Settings of running OnCall instance.
BASE_URL = os.environ.get("BASE_URL") # Root URL of OnCall backend BASE_URL = os.environ.get("BASE_URL") # Root URL of OnCall backend

View file

@ -13,4 +13,4 @@ with Brilliant Slack Integration
## Documentation ## Documentation
- [On Github](http://github.com/grafana/oncall) - [On Github](http://github.com/grafana/oncall)
- [Grafana OnCall](https://grafana.com/docs/grafana-cloud/oncall/) - [Grafana OnCall](https://grafana.com/docs/oncall/latest/)

View file

@ -28,8 +28,8 @@ export const FARO_ENDPOINT_OPS =
export const FARO_ENDPOINT_PROD = export const FARO_ENDPOINT_PROD =
'https://faro-collector-prod-us-central-0.grafana.net/collect/03a11ed03c3af04dcfc3be9755f2b053'; 'https://faro-collector-prod-us-central-0.grafana.net/collect/03a11ed03c3af04dcfc3be9755f2b053';
export const DOCS_SLACK_SETUP = 'https://grafana.com/docs/grafana-cloud/oncall/open-source/#slack-setup'; export const DOCS_SLACK_SETUP = 'https://grafana.com/docs/oncall/latest/open-source/#slack-setup';
export const DOCS_TELEGRAM_SETUP = 'https://grafana.com/docs/grafana-cloud/oncall/chat-options/configure-telegram/'; export const DOCS_TELEGRAM_SETUP = 'https://grafana.com/docs/oncall/latest/chat-options/configure-telegram/';
// Make sure if you chage max-width here you also change it in responsive.css // Make sure if you chage max-width here you also change it in responsive.css
export const TABLE_COLUMN_MAX_WIDTH = 1500; export const TABLE_COLUMN_MAX_WIDTH = 1500;