From 10d944ed6c4862e641098481e6aa37f092529d71 Mon Sep 17 00:00:00 2001 From: Lam Wei Li Date: Sun, 20 Mar 2022 19:06:48 +0800 Subject: [PATCH] chore(docs): fixed broken links --- docs/appenders.md | 2 +- docs/index.md | 2 +- docs/layouts.md | 4 ++-- docs/migration-guide.md | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/appenders.md b/docs/appenders.md index 0f536fd3..a34c6b72 100644 --- a/docs/appenders.md +++ b/docs/appenders.md @@ -17,7 +17,7 @@ This defines two appenders named 'out' and 'app'. 'out' uses the [stdout](stdout ## Core Appenders -The following appenders are included with log4js. Some require extra dependencies that are not included as part of log4js (the [smtp](smtp.md) appender needs [nodemailer](https://www.npmjs.org/packages/nodemailer) for example), and these will be noted in the docs for that appender. If you don't use those appenders, then you don't need the extra dependencies. +The following appenders are included with log4js. Some require extra dependencies that are not included as part of log4js (the [smtp](https://github.com/log4js-node/smtp) appender needs [nodemailer](https://www.npmjs.com/package/nodemailer) for example), and these will be noted in the docs for that appender. If you don't use those appenders, then you don't need the extra dependencies. * [categoryFilter](categoryFilter.md) * [console](console.md) diff --git a/docs/index.md b/docs/index.md index ba8a54ff..78da762d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -17,7 +17,7 @@ There have been a few changes between log4js 1.x and 2.x (and 0.x too). You shou - [GELF appender](https://github.com/log4js-node/gelf) - [Loggly appender](https://github.com/log4js-node/loggly) - [Logstash UDP appender](https://github.com/log4js-node/logstashUDP) -- logFaces ([UDP](logFaces-UDP.md) and [HTTP](logFaces-HTTP.md)) appender +- logFaces ([UDP](https://github.com/log4js-node/logFaces-UDP) and [HTTP](https://github.com/log4js-node/logFaces-HTTP)) appender - [TCP appender](tcp.md) (useful when you've got multiple servers but want to centralise logging) - a [logger for connect/express](connect-logger.md) servers - configurable log message [layout/patterns](layouts.md) diff --git a/docs/layouts.md b/docs/layouts.md index b2d2e456..b24bbca2 100644 --- a/docs/layouts.md +++ b/docs/layouts.md @@ -2,7 +2,7 @@ Layouts are functions used by appenders to format log events for output. They take a log event as an argument and return a string. Log4js comes with several appenders built-in, and provides ways to create your own if these are not suitable. -For most use cases you will not need to configure layouts - there are some appenders which do not need layouts defined (for example, [logFaces-UDP](logFaces-UDP.md)); all the appenders that use layouts will have a sensible default defined. +For most use cases you will not need to configure layouts - there are some appenders which do not need layouts defined (for example, [logFaces-UDP](https://github.com/log4js-node/logFaces-UDP)); all the appenders that use layouts will have a sensible default defined. ## Configuration @@ -75,7 +75,7 @@ Cheese is too ripe! Cheese was: gouda * `type` - `dummy` -This layout only outputs the first value in the log event's data. It was added for the [logstashUDP](logstashUDP.md) appender, and I'm not sure there's much use for it outside that. +This layout only outputs the first value in the log event's data. It was added for the [logstashUDP](https://github.com/log4js-node/logstashUDP) appender, and I'm not sure there's much use for it outside that. ## Example ```javascript diff --git a/docs/migration-guide.md b/docs/migration-guide.md index c95af1c9..8be8e4f8 100644 --- a/docs/migration-guide.md +++ b/docs/migration-guide.md @@ -57,7 +57,7 @@ The `logFaces` appender was split into two versions to make testing easier and t Some appenders used to define their own `exit` listeners, and it was never clear whose responsibility it was to clean up resources. Now log4js does not define any `exit` listeners. Instead your application should register an `exit` listener, and call `log4js.shutdown` to be sure that all log messages get written before your application terminates. ## New Features -* MDC contexts - you can now add key-value pairs to a logger (for grouping all log messages from a particular user, for example). Support for these values exists in the [pattern layout](layouts.md), the [logFaces appenders](logFaces-UDP.md), and the [multi-file appender](multiFile.md). +* MDC contexts - you can now add key-value pairs to a logger (for grouping all log messages from a particular user, for example). Support for these values exists in the [pattern layout](layouts.md), the logFaces ([UDP](https://github.com/log4js-node/logFaces-UDP) and [HTTP](https://github.com/log4js-node/logFaces-HTTP)) appender, and the [multi-file appender](multiFile.md). * Automatic cluster support - log4js now handles clusters transparently * Custom levels - you can define your own log levels in the configuration object, including the colours * Improved performance - several changes have been made to improve performance, especially for the file appenders.