Skip to content

Commit

Permalink
Remove documentation survey links (#7265)
Browse files Browse the repository at this point in the history
  • Loading branch information
schmittjoseph authored Sep 6, 2024
1 parent 8c3a7f4 commit d2914cc
Show file tree
Hide file tree
Showing 79 changed files with 95 additions and 327 deletions.
5 changes: 1 addition & 4 deletions .github/actions/update-releases-md/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,7 @@ function generateReleasesMdContent(releasesData, repoOwner, repoName) {
previewReleasesTable += `${generateTableRow(releasesData.releases[releaseKey], repoOwner, repoName, false)}\n`;
}

let content =`
### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Freleases)
# Releases
let content =`# Releases
`;

Expand Down
3 changes: 0 additions & 3 deletions documentation/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@

### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2FREADME)

# 📖 `dotnet monitor` documentation

`dotnet monitor` is a tool that makes it easier to get access to diagnostics information in a dotnet process.
Expand Down
3 changes: 0 additions & 3 deletions documentation/api-key-format.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@

### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi-key-format)

# API Key Format
API Keys or MonitorApiKeys used in `dotnet monitor` are JSON Web Tokens or JWTs as defined by [RFC 7519: JSON Web Token (JWT)](https://datatracker.ietf.org/doc/html/rfc7519).
> [!IMPORTANT]
Expand Down
3 changes: 0 additions & 3 deletions documentation/api-key-setup.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@

### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi-key-setup)

# Configuring API Key Authentication

The API Key you use to secure `dotnet monitor` is a secret Json Web Token (JWT), cryptographically signed by a public/private key algorithm. You can **[Recommended]** use the integrated command to generate a key or you can generate the key yourself following the [format, documented here](./api-key-format.md). This guide will use the integrated command.
Expand Down
3 changes: 0 additions & 3 deletions documentation/api/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@

### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2FREADME)

# HTTP API Documentation

The HTTP API enables on-demand extraction of diagnostic information and artifacts from discoverable processes.
Expand Down
3 changes: 0 additions & 3 deletions documentation/api/collectionrules-get.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@

### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Fcollectionrules-get)

# Collection Rules - Get

First Available: 6.3
Expand Down
3 changes: 0 additions & 3 deletions documentation/api/collectionrules-list.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@

### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Fcollectionrules-list)

# Collection Rules - List

First Available: 6.3
Expand Down
3 changes: 0 additions & 3 deletions documentation/api/collectionrules.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@

### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Fcollectionrules)

# Collection Rules

First Available: 6.3
Expand Down
3 changes: 0 additions & 3 deletions documentation/api/defaultprocess.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@

### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Fdefaultprocess)

# Default Process

When using APIs to capture diagnostic artifacts, typically a `pid`, `uid`, or `name` is provided to perform the operation on a specific process. However, these parameters may be omitted if `dotnet monitor` is able to resolve a default process.
Expand Down
3 changes: 0 additions & 3 deletions documentation/api/definitions.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@

### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Fdefinitions)

# Definitions

> [!NOTE]
Expand Down
3 changes: 0 additions & 3 deletions documentation/api/dump.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@

### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Fdump)

# Dump - Get

Captures a managed dump of a specified process without using a debugger.
Expand Down
2 changes: 0 additions & 2 deletions documentation/api/exceptions-custom.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%exceptions-custom)

# Exceptions History - Custom

Captures a history of first chance exceptions that were thrown in the specified process, with the ability to filter which exceptions are included in the response.
Expand Down
3 changes: 0 additions & 3 deletions documentation/api/exceptions.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@

### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%exceptions)

# Exceptions History - Get

Captures a history of first chance exceptions that were thrown in the specified process.
Expand Down
3 changes: 0 additions & 3 deletions documentation/api/gcdump.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@

### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Fgcdump)

# GC Dump - Get

Captures a GC dump of a specified process. These dumps are useful for several scenarios:
Expand Down
3 changes: 0 additions & 3 deletions documentation/api/info.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@

### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Finfo)

# Info - Get

Gets information about the `dotnet monitor` version, the runtime version, and the diagnostic port settings.
Expand Down
3 changes: 0 additions & 3 deletions documentation/api/livemetrics-custom.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@

### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Flivemetrics-custom)

# Livemetrics - Get Custom

Captures metrics for a process, with the ability to specify custom metrics.
Expand Down
3 changes: 0 additions & 3 deletions documentation/api/livemetrics-get.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@

### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Flivemetrics-get)

# Livemetrics - Get

Captures metrics for a chosen process for a duration of time.
Expand Down
3 changes: 0 additions & 3 deletions documentation/api/livemetrics.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@

### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Flivemetrics)

# Live Metrics

| Operation | Description |
Expand Down
3 changes: 0 additions & 3 deletions documentation/api/logs-custom.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@

### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Flogs-custom)

# Logs - Get Custom

Captures log statements that are logged to the [ILogger<> infrastructure](https://docs.microsoft.com/aspnet/core/fundamentals/logging) within a specified process, as described in the settings specified in the request body. By default, logs are collected at the levels as specified by the [application-defined configuration](https://docs.microsoft.com/en-us/aspnet/core/fundamentals/logging/#configure-logging).
Expand Down
3 changes: 0 additions & 3 deletions documentation/api/logs-get.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@

### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Flogs-get)

# Logs - Get

Captures log statements that are logged to the [ILogger<> infrastructure](https://docs.microsoft.com/aspnet/core/fundamentals/logging) within a specified process. By default, logs are collected at the levels as specified by the [application-defined configuration](https://docs.microsoft.com/en-us/aspnet/core/fundamentals/logging/#configure-logging).
Expand Down
3 changes: 0 additions & 3 deletions documentation/api/logs.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@

### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Flogs)

# Logs

The Logs API enables collecting logs that are logged to the [ILogger<> infrastructure](https://docs.microsoft.com/aspnet/core/fundamentals/logging) within a specified process.
Expand Down
3 changes: 0 additions & 3 deletions documentation/api/metrics.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@

### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Fmetrics)

# Metrics - Get

Gets a snapshot of metrics in the Prometheus exposition format of a single process.
Expand Down
3 changes: 0 additions & 3 deletions documentation/api/operations-delete.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@

### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Foperations-delete)

# Operations - Delete

Cancel a running operation. Only valid against operations in the `Running` or `Stopping` state. Transitions the operation to `Cancelled` state. Cancelling an operation may result in an incomplete or unreadable artifact. To stop an operation early while still producing a valid artifact, use the [Stop Operation](operations-stop.md).
Expand Down
3 changes: 0 additions & 3 deletions documentation/api/operations-get.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@

### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Foperations-get)

# Operations - Get

Gets detailed information about a specific operation.
Expand Down
3 changes: 0 additions & 3 deletions documentation/api/operations-list.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@

### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Foperations-list)

# Operations - List

Lists all operations that have been created, as well as their status.
Expand Down
3 changes: 0 additions & 3 deletions documentation/api/operations-stop.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@

### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Foperations-stop)

# Operations - Stop (7.1+)

Gracefully stops a running operation. Only valid against operations with the `isStoppable` property set to `true`, not all operations support being gracefully stopped. Transitions the operation to `Succeeded` or `Failed` state depending on if the operation was successful.
Expand Down
3 changes: 0 additions & 3 deletions documentation/api/operations.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@

### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Foperations)

# Operations

Operations are used to track long running operations in dotnet-monitor, specifically egressing data via egressProviders instead of directly to the client. This api is very similar to [Azure asynchronous operations](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/async-operations#url-to-monitor-status).
Expand Down
3 changes: 0 additions & 3 deletions documentation/api/parameters.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@

### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Fparameters)

# Parameters (experimental feature)

Captures parameters for one or more methods each time they are called.
Expand Down
3 changes: 0 additions & 3 deletions documentation/api/pidvsuid.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@

### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Fpidvsuid)

# Process ID `pid` vs Unique ID `uid`

Many of the HTTP routes allow specifying either the process ID `pid` or the unique ID `uid`. Which one to use depends on the target process and the environment in which the process is running.
Expand Down
3 changes: 0 additions & 3 deletions documentation/api/process-env.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@

### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Fprocess-env)

# Processes - Get Environment

Gets the environment block of a specified process.
Expand Down
3 changes: 0 additions & 3 deletions documentation/api/process-get.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@

### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Fprocess-get)

# Processes - Get

Gets detailed information about a specified process.
Expand Down
3 changes: 0 additions & 3 deletions documentation/api/processes-list.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@

### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Fprocesses-list)

# Processes - List

Lists the processes that are available from which diagnostic information can be obtained.
Expand Down
3 changes: 0 additions & 3 deletions documentation/api/processes.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@

### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Fprocesses)

# Processes

The Processes API enables enumeration of the processes that `dotnet monitor` can detect and allows for obtaining their metadata (such as their names and environment variables).
Expand Down
3 changes: 0 additions & 3 deletions documentation/api/stacks.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@

### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Fstacks)

# Stacks - Get

Captures the call stacks of a target process. Note that only managed frames are collected.
Expand Down
3 changes: 0 additions & 3 deletions documentation/api/trace-custom.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@

### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=trace-customdocumentation%2Fapi%2F)

# Trace - Get Custom

Captures a diagnostic trace of a process using the given set of event providers specified in the request body.
Expand Down
3 changes: 0 additions & 3 deletions documentation/api/trace-get.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@

### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Ftrace-get)

# Trace - Get

Captures a diagnostic trace of a process based on a predefined set of trace profiles.
Expand Down
3 changes: 0 additions & 3 deletions documentation/api/trace.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@

### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fapi%2Ftrace)

# Traces

The Traces API enables collecting `.nettrace` formatted traces without using a profiler.
Expand Down
3 changes: 0 additions & 3 deletions documentation/authentication.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@

### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fauthentication)

# Authentication

Authenticated requests to `dotnet monitor` help protect sensitive diagnostic artifacts from unauthorized users and lower privileged processes. `dotnet monitor` can be configured to use any one of the following authentication modes:
Expand Down
5 changes: 1 addition & 4 deletions documentation/building.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@

### Was this documentation helpful? [Share feedback](https://www.research.net/r/DGDQWXH?src=documentation%2Fbuilding)

# Clone, build and test the repo
------------------------------

Expand Down Expand Up @@ -29,4 +26,4 @@ If you prefer to use *Visual Studio*, *Visual Studio Code*, or *Visual Studio fo

# Updating native build support

Part of the dotnet/runtime repo has been copied into this repo in order to facilitate building of native code. When needing to update the native build support, take a look at [runtime-version.txt](../src/external/runtime-version.txt) for what files should be synchronized from the dotnet/runtime repo. Synchronizing these files is currently done as a manual process. Update the version file with the new commit and file information if a new synchronization occurs.
Part of the dotnet/runtime repo has been copied into this repo in order to facilitate building of native code. When needing to update the native build support, take a look at [runtime-version.txt](../src/external/runtime-version.txt) for what files should be synchronized from the dotnet/runtime repo. Synchronizing these files is currently done as a manual process. Update the version file with the new commit and file information if a new synchronization occurs.
Loading

0 comments on commit d2914cc

Please sign in to comment.