Git Product home page Git Product logo

docs.docfx's Introduction

App Metrics DocFx

This repo contains the source code for https://alhardy.github.io/app-metrics-docs/ which is the documentation for App Metrics 1.0

Building

  • Download and install DocFX (Add to your path to make things easier)
  • In the repo's root run docfx --build

Serving the static site locally

In the repo's root run docfx --serve

docs.docfx's People

Contributors

alhardy avatar fontanaricardo avatar jaxelr avatar jenyayel avatar joestead avatar marcdenman avatar mikefonted avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar

docs.docfx's Issues

Health Checks and nuget packages to include

I wanted to share an issue that tripped me up a bit, since it may be an opportunity to help some future new user.

I started my own sample project to explore this library, and in the beginning I followed the Getting Started > Configuring a Web Host instructions, adding the App.Metrics.Extensions.Middleware and App.Metrics.Formatters.Json nuget packages.

Later, I tried to create a health check class, which inherited HealthCheck, but it did not work. What ended up making it work, was adding the App.Metrics nuget package.

I would suggest mentioning adding this package either in the intro, or on the Health Checks page (or both).

AspNet Middleware Configuration: IgnoredRoutesRegexPatterns vs IgnoredRequestPatterns

First off, this library is some fantastic work!

When comparing the documentation for the following files, I noticed that the json file uses the IgnoredRequestPatterns key while the configuration.md file lists the IgnoredRoutesRegexPatterns key.

  • /src/samples/App.Metrics.Formatters.Json.Samples/AspNetOptions.json
  • web-applictaion-monitoring/configuration.md

I believe the key in the json file should be changed to IgnoredRoutesRegexPatterns. I tested this in an app that I'm working on, and IgnoredRequestPatterns does not work, but IgnoredRoutesRegexPatterns does.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.