mirror of
https://github.com/Unleash/unleash.git
synced 2025-01-31 00:16:47 +01:00
chore: more docs
This commit is contained in:
parent
26255b8d62
commit
24d2aa5dea
@ -19,6 +19,8 @@ You can choose to trigger updates for the following events (we might add more ev
|
|||||||
- feature-updated
|
- feature-updated
|
||||||
- feature-archived
|
- feature-archived
|
||||||
- feature-revived
|
- feature-revived
|
||||||
|
- feature-stale-on
|
||||||
|
- feature-stale-off
|
||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
|
@ -19,6 +19,10 @@ You can choose to trigger updates for the following events (we might add more ev
|
|||||||
- feature-updated
|
- feature-updated
|
||||||
- feature-archived
|
- feature-archived
|
||||||
- feature-revived
|
- feature-revived
|
||||||
|
- feature-stale-on
|
||||||
|
- feature-stale-off
|
||||||
|
|
||||||
|
(we will add more events in the future!)
|
||||||
|
|
||||||
#### Parameters
|
#### Parameters
|
||||||
|
|
||||||
|
@ -13,7 +13,7 @@ module.exports = {
|
|||||||
name: 'slack',
|
name: 'slack',
|
||||||
displayName: 'Slack',
|
displayName: 'Slack',
|
||||||
description: 'Allows Unleash to post updates to Slack.',
|
description: 'Allows Unleash to post updates to Slack.',
|
||||||
documentationUrl: 'https://unleash.github.io/docs/addons/slack',
|
documentationUrl: 'https://docs.getunleash.io/docs/addons/slack',
|
||||||
parameters: [
|
parameters: [
|
||||||
{
|
{
|
||||||
name: 'url',
|
name: 'url',
|
||||||
|
@ -12,7 +12,7 @@ module.exports = {
|
|||||||
displayName: 'Webhook',
|
displayName: 'Webhook',
|
||||||
description:
|
description:
|
||||||
'A Webhook is a generic way to post messages from Unleash to third party services.',
|
'A Webhook is a generic way to post messages from Unleash to third party services.',
|
||||||
documentationUrl: 'https://unleash.github.io/docs/addons/webhook',
|
documentationUrl: 'https://docs.getunleash.io/docs/addons/webhook',
|
||||||
parameters: [
|
parameters: [
|
||||||
{
|
{
|
||||||
name: 'url',
|
name: 'url',
|
||||||
@ -42,7 +42,7 @@ module.exports = {
|
|||||||
"timestamp": "{{event.data.createdAt}}"
|
"timestamp": "{{event.data.createdAt}}"
|
||||||
}`,
|
}`,
|
||||||
description:
|
description:
|
||||||
"(Optional) You may format the body using a mustache template. If you don't specify anything, the format will similar to the events format (https://unleash.github.io/docs/api/admin/events)",
|
"(Optional) You may format the body using a mustache template. If you don't specify anything, the format will similar to the events format (https://docs.getunleash.io/docs/api/admin/events)",
|
||||||
type: 'textfield',
|
type: 'textfield',
|
||||||
required: false,
|
required: false,
|
||||||
},
|
},
|
||||||
|
@ -52,6 +52,6 @@ exports.setLoggerProvider = function setLoggerProvider(provider) {
|
|||||||
|
|
||||||
loggerProvider = provider;
|
loggerProvider = provider;
|
||||||
const logger = provider('unleash:logger');
|
const logger = provider('unleash:logger');
|
||||||
logger.info(`Your way of configuring a logProvider is depreacted.
|
logger.info(`Your way of configuring a logProvider is deprecated.
|
||||||
See https://unleash.github.io/docs/getting_started for details`);
|
See https://docs.getunleash.io/docs/deploy/configuring_unleash for details`);
|
||||||
};
|
};
|
||||||
|
@ -119,7 +119,7 @@ module.exports = {
|
|||||||
|
|
||||||
if (!options.db.host) {
|
if (!options.db.host) {
|
||||||
throw new Error(
|
throw new Error(
|
||||||
'Unleash requires database details to start. See https://unleash.github.io/docs/getting_started',
|
'Unleash requires database details to start. See https://docs.getunleash.io/docs/deploy/configuring_unleash',
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -51,7 +51,7 @@ const users = [
|
|||||||
const siteConfig = {
|
const siteConfig = {
|
||||||
title: 'Unleash', // Title for your website.
|
title: 'Unleash', // Title for your website.
|
||||||
tagline: 'The enterprise ready feature toggle service',
|
tagline: 'The enterprise ready feature toggle service',
|
||||||
url: 'https://unleash.github.io', // Your website URL
|
url: 'https://docs.getunleash.io', // Your website URL
|
||||||
baseUrl: '/', // Base URL for your project */
|
baseUrl: '/', // Base URL for your project */
|
||||||
// For github.io type URLs, you would set the url and baseUrl like:
|
// For github.io type URLs, you would set the url and baseUrl like:
|
||||||
// url: 'https://facebook.github.io',
|
// url: 'https://facebook.github.io',
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
The Unleash website was created with [Docusaurus](https://docusaurus.io/). The source code lives as part of the main [Unleash repo on GitHub](https://github.com/Unleash/unleash) and is built and deployed on all merges to master. This makes it easy to keep the documentation in sync with the latest version of Unleash.
|
The Unleash website was created with [Docusaurus](https://docusaurus.io/). The source code lives as part of the main [Unleash repo on GitHub](https://github.com/Unleash/unleash) and is built and deployed on all merges to master. This makes it easy to keep the documentation in sync with the latest version of Unleash.
|
||||||
|
|
||||||
It's hosted on https://unleash.github.io/
|
It's hosted on https://docs.getunleash.io
|
||||||
|
|
||||||
# What's In This Document
|
# What's In This Document
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user