Skip to content

Commit 2ddec5e

Browse files
niemyjskiejsmith
authored andcommitted
Fixed docs and wiki links & spelling
1 parent 180e89e commit 2ddec5e

File tree

45 files changed

+505
-490
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+505
-490
lines changed

.vscode/settings.json

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,20 @@
1313
"Reindex",
1414
"Reindexing",
1515
"Serilog",
16+
"Trello",
1617
"Varorbc",
1718
"Zurb",
1819
"Zurb's",
20+
"adamsitnik",
21+
"caesay",
1922
"deduplicated",
2023
"edwardmeng",
24+
"eleventy",
2125
"exceptionless",
26+
"frankebersoll",
27+
"pluggable",
2228
"serializers",
29+
"srijken",
2330
"typeof",
2431
"walkthrough"
2532
]

content/docs/clients/dotnet/configuration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ Exceptionless can be configured using a config section in your web.config or app
8282

8383
## Versioning
8484

85-
By specifying an application version you can [enable additional functionality](https://github.com/exceptionless/Exceptionless/wiki/Versioning). By default, an application version will try to be resolved from assembly attributes. However, it's a good practice to specify an application version if possible using the code below.
85+
By specifying an application version you can [enable additional functionality](/docs/versioning/). By default, an application version will try to be resolved from assembly attributes. However, it's a good practice to specify an application version if possible using the code below.
8686

8787
```csharp
8888
using Exceptionless;
@@ -130,7 +130,7 @@ using Exceptionless.Configuration;
130130

131131
## Self Hosted Options
132132

133-
The Exceptionless client can also be configured to send data to your self hosted instance. This is configured by setting the `serverUrl` setting to point to your Exceptionless instance.
133+
The Exceptionless client can also be configured to send data to your self hosted instance. This is configured by setting the `serverUrl` setting to point to your Exceptionless instance.
134134

135135
### Configuration file
136136

content/docs/clients/dotnet/private-information.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ You have the option of finely tuning what is collected via individual setting op
1919
ExceptionlessClient.Default.Configuration.IncludePrivateInformation = false;
2020
```
2121

22-
If you wish to have a finer grained approach which allows you to use Data Exclusions while removing specific meta data collection you can do so via code. Please note if the below doesn't meet your needs you can always [write a plugin](https://github.com/exceptionless/Exceptionless.Net/wiki/Adding-Plugins).
22+
If you wish to have a finer grained approach which allows you to use Data Exclusions while removing specific meta data collection you can do so via code. Please note if the below doesn't meet your needs you can always [write a plugin](/docs/clients/dotnet/plugins/).
2323

2424
## Configuration
2525

content/docs/clients/dotnet/sending-events.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ private void OnSubmittingEvent(object sender, EventSubmittingEventArgs e) {
132132

133133
Using major logging frameworks like NLog or Log4net gives you more granular control over what's logged.
134134

135-
To use the [NLog](https://www.nuget.org/packages/exceptionless.nlog) or [Log4net](https://www.nuget.org/packages/exceptionless.log4net) clients, bring down the nuget package and follow the detailed readme. You can also take a look at our [sample app](https://github.com/exceptionless/Exceptionless.Net/tree/master/samples/Exceptionless.SampleConsole), which uses both frameworks.
135+
To use the [NLog](https://www.nuget.org/packages/exceptionless.nlog) or [Log4net](https://www.nuget.org/packages/exceptionless.log4net) clients, bring down the NuGet package and follow the detailed readme. You can also take a look at our [sample app](https://github.com/exceptionless/Exceptionless.Net/tree/master/samples/Exceptionless.SampleConsole), which uses both frameworks.
136136

137137
**Performance Note**
138138
If you are logging thousands of messages a minute, you should use the in-memory event storage (below). This way, the client won't serialize the log events to disk, thus is much faster. This does mean, however, that if the application dies you will lose unsent events in memory. When you use the NLog or Log4net targets and specify the API key as part of the target configuration, we will automatically create a second client instance that uses in-memory storage only for log messages. This way, any logged exceptions or feature usages still use disk storage, while log messages use in-memory storage, allowing maximum performance.
@@ -142,6 +142,6 @@ using Exceptionless;
142142
ExceptionlessClient.Default.Configuration.UseInMemoryStorage();
143143
```
144144

145-
---
145+
---
146146

147147
[Next > Supported Platforms](supported-platforms) {.text-right}

content/docs/clients/javascript/client-configuration-values.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ order: 2
88
- [Subscribing to Client Configuration Setting changes](#subscribing-to-client-configuration-setting-changes)
99

1010
## About
11-
[Read about client configuration and view in-depth examples](https://github.com/exceptionless/Exceptionless/wiki/Project-Settings#client-configuration)
11+
12+
[Read about client configuration and view in-depth examples](/docs/project-settings/#client-configuration)
1213

1314
## Usage Example
1415

@@ -23,13 +24,13 @@ Then, we register a new client side plugin that runs each time an event is creat
2324
```javascript
2425
exceptionless.ExceptionlessClient.default.config.addPlugin('Conditionally cancel log submission', 100, function (context, next) {
2526
var enableLogSubmission = context.client.config.settings['enableLogSubmission'];
26-
27+
2728
// only cancel event submission if it’s a log event and
2829
// enableLogSubmission is set to a value and the value is not true.
2930
if (context.event.type === 'log' && (!!enableLogSubmission && enableLogSubmission !== 'true')) {
3031
context.cancelled = true;
3132
}
32-
33+
3334
next();
3435
});
3536
```
@@ -41,11 +42,11 @@ exceptionless.ExceptionlessClient.default.config.addPlugin('Conditionally cancel
4142

4243
![Exceptionless Client Configuration Settings](../../../assets/img/docs/client-configuration.png)
4344

44-
All project settings are synced to the client in almost real time. When an event is submitted to Exceptionless we send down a response header with the current configuration version. If a newer version is available we will immediately retrieve and apply the latest configuration.
45+
All project settings are synced to the client in almost real time. When an event is submitted to Exceptionless we send down a response header with the current configuration version. If a newer version is available we will immediately retrieve and apply the latest configuration.
4546

46-
By default the client will check after `5 seconds` on client startup (*if no events are submitted on startup*) and then every `2 minutes` after the last event submission for updated configuration settings.
47-
* Checking for updated settings doesn't count towards plan limits.
48-
* Only the current configuration version is sent when checking for updated settings (no user information will ever be sent).
47+
By default the client will check after `5 seconds` on client startup (*if no events are submitted on startup*) and then every `2 minutes` after the last event submission for updated configuration settings.
48+
* Checking for updated settings doesn't count towards plan limits.
49+
* Only the current configuration version is sent when checking for updated settings (no user information will ever be sent).
4950
* If the settings haven't changed, then no settings will be retrieved.
5051

5152
You can also **turn off the automatic updating of configuration settings when idle** using the code below.
@@ -67,6 +68,6 @@ exceptionless.SettingsManager.onChanged(function(configuration) {
6768
});
6869
```
6970

70-
---
71+
---
7172

7273
[Next > Sending Events](sending-events) {.text-right}

content/docs/clients/javascript/client-configuration.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ order: 1
2828

2929
### Node.js
3030

31-
1. Install the package by running `npm install exceptionless --save-dev`.
31+
1. Install the package by running `npm install exceptionless --save-dev`.
3232
1. Add the Exceptionless client to your app:
3333

3434
```javascript
@@ -94,25 +94,29 @@ submissionBatchSize: 100
9494
});
9595
```
9696

97-
**NOTE**: creating new instances is good for sending custom events. **Automatic catching of errors uses default client**. Make sure you setup default client as well if you need automatic catching of unhandled errors.
97+
**NOTE**: creating new instances is good for sending custom events. **Automatic catching of errors uses default client**. Make sure you setup default client as well if you need automatic catching of unhandled errors.
9898

9999

100100
### General Data Protection Regulation
101-
By default the Exceptionless Client will report all available metadata which could include potential PII data. There are various ways to limit the scope of PII data collection. For example, one could use [Data Exclusions](https://github.com/exceptionless/Exceptionless/wiki/Security#data-exclusions) to remove sensitive values but it only applies to specific collection points such as `Cookie Keys`, `Form Data Keys`, `Query String Keys` and `Extra Exception properties`. Additional data may need to be removed for the GDPR like the collection of user names and IP Addresses. Shown below is several examples of how you can configure the client to remove this additional metadata.
101+
102+
By default the Exceptionless Client will report all available metadata which could include potential PII data. There are various ways to limit the scope of PII data collection. For example, one could use [Data Exclusions](/docs/security/#data-exclusions) to remove sensitive values but it only applies to specific collection points such as `Cookie Keys`, `Form Data Keys`, `Query String Keys` and `Extra Exception properties`. Additional data may need to be removed for the GDPR like the collection of user names and IP Addresses. Shown below is several examples of how you can configure the client to remove this additional metadata.
102103

103104
You have the option of finely tuning what is collected via individual setting options or you can disable the collection of all PII data by setting the `includePrivateInformation` to `false`.
104105

105106
#### Query String
107+
106108
```javascript
107109
<script src="bower_components/exceptionless/dist/exceptionless.min.js?apiKey=API_KEY_HERE& includePrivateInformation=false"></script>
108110
```
109111

110112
#### JavaScript
113+
111114
```javascript
112115
exceptionless.ExceptionlessClient.default.config.includePrivateInformation = false;
113116
```
114117

115118
#### Node.js
119+
116120
```javascript
117121
var exceptionless = require('exceptionless');
118122
exceptionless.ExceptionlessClient.default.config.includePrivateInformation = false;
@@ -121,6 +125,7 @@ exceptionless.ExceptionlessClient.default.config.includePrivateInformation = fal
121125
If you wish to have a finer grained approach which allows you to use Data Exclusions while removing specific meta data collection you can do so via code. Please note if the below doesn't meet your needs you can always write a plugin.
122126

123127
#### JavaScript
128+
124129
```javascript
125130
// Include the username if available.
126131
exceptionless.ExceptionlessClient.default.config.includeUserName = false;
@@ -137,6 +142,7 @@ exceptionless.ExceptionlessClient.default.config.includeQueryString = false;
137142
```
138143

139144
#### Node.js
145+
140146
```javascript
141147
var exceptionless = require('exceptionless');
142148

@@ -155,14 +161,17 @@ exceptionless.ExceptionlessClient.default.config.includeQueryString = false;
155161
```
156162

157163
## Versioning
158-
By specifying an application version you can [enable additional functionality](https://github.com/exceptionless/Exceptionless/wiki/Versioning). It's a good practice to specify an application version if possible using the code below.
164+
165+
By specifying an application version you can [enable additional functionality](/docs/versioning/). It's a good practice to specify an application version if possible using the code below.
159166

160167
### JavaScript
168+
161169
```javascript
162170
exceptionless.ExceptionlessClient.default.config.setVersion("1.2.3");
163171
```
164172

165173
### Node.js
174+
166175
```javascript
167176
var exceptionless = require('exceptionless');
168177
exceptionless.ExceptionlessClient.default.config.setVersion("1.2.3");
@@ -188,6 +197,7 @@ You can set the `serverUrl` on the default ExceptionlessClient instance.
188197
var client = require('exceptionless.node').ExceptionlessClient.default;
189198
client
190199
```
191-
---
200+
201+
---
192202

193203
[Next > Client Configuration Values](client-configuration-values) {.text-right}

content/docs/notifications.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ order: 11
55

66
To turn on email notifications, go to "My Account" in your dashboard, then click on the "Notifications" tab.
77

8-
Once your'e in there, you can select the project you want to edit notifications to, and then select which notifications you want to receive for that selected project.
8+
Once you're in there, you can select the project you want to edit notifications to, and then select which notifications you want to receive for that selected project.
99

1010
![Email Notifications](img/email-notification-settings.png)
1111

1212
---
1313

14-
[Next > Log Levels](setting-log-levels) {.text-right}
14+
[Next > Log Levels](setting-log-levels) {.text-right}

content/docs/self-hosting/upgrading-self-hosted-instance.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,9 @@ Version 6 added support for Elasticsearch 7, which requires a complete data migr
2929

3030
## Upgrading from v4 to v5
3131

32-
We now only provide official docker images as release artifacts. This tutorial assumes you have docker/Kubernetes installed and have followed the [setup guide](https://github.com/exceptionless/Exceptionless/wiki/Self-Hosting).
32+
We now only provide official docker images as release artifacts. This tutorial assumes you have docker/Kubernetes installed and have followed the [setup guide](/docs/self-hosting/).
3333

34-
1. We now can run on linux or windows as we are running on ASP.NET Core! As a result we've completely redone the configuration. For the most part we've prefixed configuration with `EX_` and simplified it as much as possible. I'd recommend taking a look at your previous configuration settings and then read over the following [configuration document](https://github.com/exceptionless/Exceptionless/wiki/Self-Hosting#configuration) to migrate your settings.
34+
1. We now can run on linux or windows as we are running on ASP.NET Core! As a result we've completely redone the configuration. For the most part we've prefixed configuration with `EX_` and simplified it as much as possible. I'd recommend taking a look at your previous configuration settings and then read over the following [configuration document](/docs/self-hosting/kubernetes/#configuration) to migrate your settings.
3535
2. Please note that no Elasticsearch changes are required. You can continue to use your existing Elasticsearch cluster. You just need to update the connection string by following step 1.
3636
3. Please note that the UI and API no longer run on the same port as they are now two different docker images. You may need to update your server url accordingly in your client applications.
3737

content/news/2013/2013-12-19-exceptionless-1-2-0-released.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,6 @@ Update your NuGet packages to take advantage of these improvements!
2323
* AddObject now serializes objects to a depth of 5 by default.
2424
* Fixed a couple bugs that may occur when multiple client instances are running on the same machine concurrently.
2525
* Fixed a bug with the ExceptionlessWcfHandleErrorAttribute where it wouldn't catch errors when aspNetCompatibilityEnabled was set to false.
26-
* The client now submits errors to [collector.exceptionless.com/api/v1/error](http://collector.exceptionless.com/api/v1/error).
26+
* The client now submits errors to [collector.exceptionless.com/api/v1/error](https://collector.exceptionless.com/api/v1/error).
2727
* Fixed a bug that would prevent the Windows Form client from showing the Crash Report dialog.
2828
* Fixed a bug where multiple HttpModule sections could be added by the NuGet installer.

content/news/2014/2014-02-07-xml-parsing-exception-caught-fixed-case-study.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,10 @@ Along with the sheer number of occurrences, it was also noticeably slowing the s
3030

3131
The fix was relatively simple. The client now checks for "$" in cookie names within the affected method and just doesn't handle them.
3232

33-
**Tracking errors like this is what we're all about.** There are hundreds of thousands, probably even millions, of bugs out there _right now _that throw exceptions every day but manage to remain hidden in the shadows of code written by professional developers.
33+
**Tracking errors like this is what we're all about.** There are hundreds of thousands, probably even millions, of bugs out there _right now_ that throw exceptions every day but manage to remain hidden in the shadows of code written by professional developers.
3434

3535
It's not a sign of poor programming, it simply comes with the territory. You will have bugs, big and small, in every project you work on. The difference is, with Exceptionless, you can actually be aware of, and fix, them!
3636

37-
Another bug bites the dust, thanks to help of Exceptionless' [real-time exception reporting](http://exceptionless.com "Real Time Exception Reporting")!
37+
Another bug bites the dust, thanks to help of Exceptionless' [real-time exception reporting](https://exceptionless.com "Real Time Exception Reporting")!
3838

3939
Do you have a story where our software helped you track down and squash an elusive error? Let us know! We'll publish the details and link back to your app, if you like.
40-
41-

content/news/2014/2014-02-13-exceptionless-1-3-released.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ Exceptionless 1.3 brings with it both server and client changes, including [open
5555
Adding binding redirects to the right version.
5656
</li>
5757
<li>
58-
Data Exclusions now <a href="http://docs.exceptionless.com/contents/security/" target="_blank">support wildcards</a>.
58+
Data Exclusions now <a href="/docs/security/" target="_blank">support wildcards</a>.
5959
</li>
6060
</ul>
6161
</div>

content/news/2014/2014-05-20-exceptionless-2-in-the-making.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,15 @@ Exceptionless 2.0 will include many of the feature requests that have come in si
1212

1313
Many users have asked for ways to use Exceptionless to report additional types of events, rather than just errors. With 2.0, we are moving to an event based system that will accommodate this.
1414

15-
## <a href="https://github.com/exceptionless/Exceptionless/wiki/Exceptionless-2.0-Overview#api-simplified" name="user-content-api-simplified"></a>API Simplified
15+
## <a href="/news/2014/2014-06-12-upcoming-exceptionless-2-0-simplified-api/#api-simplified" name="user-content-api-simplified">API Simplified</a>
1616

1717
Since [going open source](/fork-us-exceptionless-goes-open-source/ "Fork Us! Exceptionless Goes Open Source"), we've wanted to simplify the API and make it easier to work with. We're taking the time to do it now, and it's going to be **awesome.** Watch out!
1818

19-
## <a href="https://github.com/exceptionless/Exceptionless/wiki/Exceptionless-2.0-Overview#pluggable-system" name="user-content-pluggable-system"></a>Pluggable System
19+
## <a href="/news/2014/2014-06-25-coming-exceptionless-2-0-pluggable-system/" name="user-content-pluggable-system">Pluggable System</a>
2020

2121
Plugins will allow customization and translation throughout the Exceptionless platform, including integration with third-party services and more.
2222

23-
### <span style="color: inherit; font-family: inherit; font-size: 31.5px;">Client Rewrite</span>
23+
## Client Rewrite
2424

2525
The client is being re-written be highly simplified and extensible, opening up platform support and ease of functionality additions.
2626

content/news/2014/2014-06-12-upcoming-exceptionless-2-0-simplified-api.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ Exceptionless 2.0, [coming soon](/exceptionless-2-in-the-making/ "Exceptionless
1414

1515
* <a href="https://api.exceptionless.io/docs/index.html" target="_blank">New REST API documentation and samples site.<br /> </a>Take a look and let us know what you think![![Exceptionless API Documentation](/assets/img/news/Screen-shot-2014-06-11-at-5.20.44-PM-300x225.png)](/assets/Screen-shot-2014-06-11-at-5.20.44-PM.png)<a style="color: #4183c4;" href="https://api.exceptionless.io/docs/index.html"><br /> </a>
1616
* Event POSTs take the raw data and use a plugin system to interpret that data and translate them into events.
17-
* This allows us to take literally any data and turn it into events in the system.
18-
* The POST data is captured as a raw bytes and added immediately added to a queue for processing.
19-
* Plugins can easily be created to support new data formats like system logs.
17+
* This allows us to take literally any data and turn it into events in the system.
18+
* The POST data is captured as a raw bytes and added immediately added to a queue for processing.
19+
* Plugins can easily be created to support new data formats like system logs.
2020
* This simplified API will make creating libraries for other platforms dead simple.
2121
* The API lives in a separate project and can be hosted on high-performance systems like the new Helios IIS host.
2222
* Makes it easy for us to migrate the UI to a SPA app.

0 commit comments

Comments
 (0)