nlog / nlog.github.io Goto Github PK

As below, this website becomes difficult to read because the broken css

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).

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

When going to this URL:

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

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

Missing

Btw. the following pages are missing:

• https://github.com/NLog/NLog/wiki/AspNet-Request-ContentType-layout-renderer (AspNetCore only)
• https://github.com/NLog/NLog/wiki/AspNet-Environment-layout-renderer (AspNetCore only)
• https://github.com/NLog/NLog/wiki/AspNet-WebRootPath-layout-renderer (AspNet + AspNetCore)
• https://github.com/NLog/NLog/wiki/AspNet-AppBasePath-layout-renderer (AspNet + AspNetCore)
• NLog.ETW is 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".

nlog.web, nlog.windows.forms etc

https://nlog-project.org/feed/

All URLs used in config files and XSD referencing schemas present in the schemas folder are broken.

An example of the change in URL:
http://www.nlog-project.org/schemas/NLog.xsd became https://nlog-project.org/schemas/NLog.xsd

It would be better if you could restore the old URLs, otherwise every user has to update their link and also the XSD files in the schemas folder should be updated

For example: http://nlog-project.org/documentation/v3.2.1/html/T_NLog_Targets_ChainsawTarget.htm

the 'more' link is broken. (links to http://nlog-project.org/documentation/v3.2.1/html/config.html)

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:
  

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

Although it seems to not be possible in Github pages it would be nice if we could add some (meta) headers.

See report of nlog-project.org

vs Github.com

Markdown issue after change with Github. # won't work anymore

info (maybe related)

http://stackoverflow.com/questions/35242130/not-rendering-html-heading-tags-after-githubs-recent-update-for-pages-and-jek
http://idratherbewriting.com/2016/02/21/bug-with-kramdown-and-rouge-with-github-pages/

@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

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

Needs add info about the${configsetting} layout renderer that requires installing package NLog.Extensions.Configuration.
More info NLog/NLog#2947

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.

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 👍

Could be neat if build-step was added to NLog.github.io, so it would produce indexable Wiki:

• https://nlog-project.org/wiki/
• https://github.com/NLog/NLog.wiki.git

See also: NLog/NLog#4637

Pull-requests are wellcome

About https://nlog-project.org/2021/08/25/nlog-5-0-preview1-ready.html:

• maybe we should remove "Preview-1" and change the date?
• tables aren't supported I see:
  

@snakefoot

Instead of having NLog v2 documentation as first hit on Google-Search, then it should be current version.

See also: https://nlog-project.org/documentation/

Will probably also reduce the penalty of having "duplicate" content

Needs add info about the windows-identity layout renderer that requires installing package Nlog.WindowsIdentity.

More - NLog/NLog#3029

https://nlog-project.org/config/?tab=targets