Git Product home page Git Product logo

nlog.github.io's Introduction

This is the official NLog GitHub page, nlog-project.org.

Config targets, layouts and layout renderers:

The config of the targets, layouts and layout renderers:

Those are visible and searchable on https://nlog-project.org/config

Add a custom component

Do you like to have a custom target, layout or layout renderer listed at https://nlog-project.org/config?

  • Please make sure you docs are up-to-date. An example is really recommend!
  • Send a PR for one of the JSON files

Add a news post

How to add a new news post.

  1. Create and new MarkDown file (.md) in the _posts folder, starting with the date (yyyy-MM-dd). Don't use spaces or extra dots in the filename! Don't forget the .md extension!
  2. Start the post with the Jekyll front matter,
  • layout: post is required.
  • Choose a good title after title:
  • Example
---
layout: post
title: NLog 3.2.0 has been released
---
  1. Write some GitHub Flavored Markdown and save the file.

Notes

  • The markdown parser is different compared to Github itself. So that means: different syntax sometimes:
    • Code fences (triple tick) isn't working. See NLog 4.0 release post I prefer markdown when it's possible (the hyperlink).
    • Lists should be prepended with a whiteline.
  • You can preview you changes to rename your fork to <your-name>.github.io and browse to it!
  • Changes are visible in about a minute.

nlog.github.io's People

Contributors

304notmodified avatar abakumov-v avatar amitsaha avatar asaharn avatar cbolandk20 avatar corentinaltepe avatar cvanbergen avatar dnlgmzddr avatar gamingrobot avatar hayrullahcansu avatar jkowalski avatar josh-degraw avatar jtheisen avatar kaykins avatar kevindaub avatar kichristensen avatar linmasaki avatar lucaritossa avatar lucianaparaschivei avatar luigiberrettini avatar michelmichels avatar mikhail-barg avatar mirimon avatar prcdpr avatar pysco68 avatar repo-ranger[bot] avatar snakefoot avatar thomasardal avatar timbussmann avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

nlog.github.io's Issues

elmah.io target last in list

The new searchable targets list is awesome. But I just noticed that the elmah.io target is last in the "Integrations (Cloud)" list. Personally, I don't care where the target is on the list, but it just looks a bit weird that everything else is sorted alphabetically. I looked in the code and cannot seem to figure out why it's added as the last item. The target is added here, but it doesn't look like the order in this file is used when generating the website.

Config options for NLog.Web shows wrong package + missing stuff

When going to this URL:

https://nlog-project.org/config/?tab=layout-renderers&search=package:nlog.web

  • Then one sees the following ${configsetting] item:

image

Missing

Btw. the following pages are missing:

Enhancements

  • GrowlNotify should probably be moved into Integrations (GUI tools)
  • R7 InsightOps should probably be moved into Integrations (Cloud)
  • EventLog from NLog.WindowsEventLog should probably say "Writes log message to the Windows EventLog for NetCore".

Aliases

@snakefoot I think it's important to make the aliases visible and searchable on https://nlog-project.org/config.

  1. What do you think about this design?
  • Added aliases to the end
  • Added prefix "package" for the packages

image

  1. What should be do with NLog 4 and NLog 5? Do I need to copy the page and jsons for NLog 5?

API docs: favicon is currently manual action.

Now manual action to overwrite the favicon for the API docs.

From: NLog.github.io\favicon.ico

To: NLog.github.io\documentation\v3.2.1\icons\favicon.ico

TODO: create post step in SHFB config

Better list for targets, layoutrenderers & layouts (including platform support)

The current lists on the current pages (targets, layoutrenderers & layouts) aren't that good. Also the current platform support page is difficult to read.

problems:

  • people can't find the needed targets etc (browser search is limited)
  • the platform support list is in another page.

working on a prototype: https://304notmodified.github.io/search

TODO:

  • search on title and description
  • platform filter
  • hyperlink to nuget package
  • hyperlink to more docs (relative to wiki or absolute)
  • finish/improve styling
  • search on keywords
  • complete platform support in the .JSON files
  • update the absolute url to the JSON files
  • fix focus on field (Vue issue)
  • better page name?
  • better url (not /search)
  • include external packages
  • use platform-notes
  • show "is wrapper"
  • move css to separate file
  • vue no dev mode
  • search on ${..} broken
  • sorted
  • add text for targets, layouts etc (from current wiki)
  • update platforms for all external packages

updates:

  • add NLog.WindowsEventLog package
  • fix package:
    image

Nice-to-have:

  • search in url
  • persist value dropdown in localstorage
  • persist tab in URL
  • hightlight searched text
  • loader
  • grouped
  • Vue components

feedback:

  • no "empty" group
  • unsort the groups

Cleanup Platforms for config items ?

Consider to cleanup platforms and just have .NET Framework and .NET Standard. Further platform-details should be displayed on wiki-page.

        "platforms": [
            "net35",
            "net40",
            "net45",
            "netstandard1.3",
            "netstandard1.5",
            "netstandard2.0",
            "ios",
            "android",
            "mono",
            "wp8"
        ],

Notice .NET Framework 4.6.1 supports .NET Standard 2.0, so maybe just remove the platforms all together? (And .NET Standard 1.3 + 1.5 are no longer super important).

Consider moving appsettings schema to schemastore

We have discussed the NLog schema for appsettings.json files previously. Now that Microsoft finally seems to have embraced the schema available on SchemaStore (https://devblogs.microsoft.com/aspnet/intellisense-for-appsettings-json/), maybe now would be a good time to move the NLog schema to the appsettings.json schema on SchemaStore. Or what are your thoughts on this? As an alternative, the recent code from the appsettings.json schema on SchemaStore should be used for NLog's schema, rather than the current code which is a copy of an early attempt I made ๐Ÿ‘

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.