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

[304NotModified]

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

[304NotModified]

@snakefoot please your feedback on https://304notmodified.github.io/search

thanks!

[snakefoot]

Maybe use a symbol/icon to display whether it works on all platforms, or it has platform restrictions.

Could also be nice to have a page for "external" / "3rdparty" items

Target-Wrappers should be placed in their own group.

[304NotModified]

I working on grouping now!

[snakefoot]

Starting to get difficult to get an overview. Maybe Targets + TargetWrappers should be moved to a seperate page?

[304NotModified]

I could make tabs, but the downside it that it's less visible after search

[304NotModified]

groups added. Before:

after:

feel free to give feedback on the group names.

I think it will be a bit more clear if the heading sizes is a bit smaller

[snakefoot]

Like the groups, but not when having groups for layoutrenderers and targets mixed together. Doesn't need to be tabs on the same page, can be separate pages.

[304NotModified]

there aren't mixed? layoutrenderers and targets are h2, the groups h3.

[304NotModified]

now header size smaller, a bit more clear.

[304NotModified]

I broke the search LOL

update: only when one platform is selected

[snakefoot]

Same page groups for targets and layoutrenders = Mixed groups

[304NotModified]

Clear. Any suggestions?

[304NotModified]

PS: I like this (on one page)

[304NotModified]

I prefer one page, but tabs is an option or maybe make the separation more clear or the groups less in-your-face

[304NotModified]

this is also nice IMO:

[snakefoot]

If you have the need to create your own Wiki-search-engine, then you should consider to post an issue for Github to improve theirs.

But suddenly your own search-engine needs to make a deep dive into the individual wiki-page to find all relevant info (Ex. some laytoutrenders supports json-destructure) (Ex. some layout renderers affects performance). Or you suddenly have to list all features for each item on the same page to make the search useful.

Maybe one could make an inbetween solution where it is possible to attach tags/metadata to each item. That is included in the search. Again not sure whether it is relevant to have targets and layoutrenderers on the same page just because of sub-optimal search-feature.

[304NotModified]

If you have the need to create your own Wiki-search-engine, then you should consider to post an issue for Github to improve theirs.

LOL Github and listening to feature request of users.

[304NotModified]

But suddenly your own search-engine needs to make a deep dive into the individual wiki-page to find all relevant info (Ex. some laytoutrenders supports json-destructure) (Ex. some layout renderers affects performance). Or you suddenly have to list all features for each item on the same page to make the search useful.

I could create multiple pages, by creating a SPA - that's not the problem. IMO multiple pages aren't better, especially not because "layouts" are too much hidden currently.

Maybe one could make an inbetween solution where it is possible to attach tags/metadata to each item.

I've added "keywords" in the json, but I don't think you are looking for that?

Anyway, I added "panels" to make things more clear. Don't now for sure if I like the style, but anyway the style is also not done yet.

[304NotModified]

panels:

now working on tabs instead of panels

[304NotModified]

@snakefoot now tabs. Is it better?

[snakefoot]

I like the tabs better than the panels. Guess "Targets" should be the first tab. That has a short introduction of all the different "tabs" and their meaning in the the NLog-world.

[304NotModified]

init:

search "json":

[304NotModified]

Guess "Targets" should be the first tab

OK 👍 will change that. including tab-state in the URL

[304NotModified]

do you think I have to add this text? and where?

[snakefoot]

I was thinking 3 bullets, with a one-liner explaining each tab. Maybe placed above the search-box.

[304NotModified]

ps: targets is now the initial tab. Maybe you need to refresh your browser cache (no cachebuster)

[304NotModified]

I was thinking 3 bullets, with a one-liner explaining each tab.

👍

[304NotModified]

moved to https://304notmodified.github.io/config

[304NotModified]

@snakefoot I saw your changes on targets.md, could you also please send the updates to targets.json in the repo?

[304NotModified]

This is done.

The config of the targets, layouts and layout renderers:

• https://github.com/NLog/NLog.github.io/blob/master/config/targets.json
• https://github.com/NLog/NLog.github.io/blob/master/config/layouts.json
• https://github.com/NLog/NLog.github.io/blob/master/config/layout-renderers.json