Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Aliases #184

Closed
304NotModified opened this issue Feb 12, 2022 · 9 comments · Fixed by #187
Closed

Aliases #184

304NotModified opened this issue Feb 12, 2022 · 9 comments · Fixed by #187

Comments

@304NotModified
Copy link
Member

304NotModified commented Feb 12, 2022

@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?
@304NotModified
Copy link
Member Author

related NLog/NLog#4716

@304NotModified
Copy link
Member Author

@snakefoot
Copy link
Contributor

snakefoot commented Feb 15, 2022 via email

@snakefoot
Copy link
Contributor

snakefoot commented Apr 10, 2022

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

Nothing has been removed with NLog 5, so the wiki-pages remains the same. There might be a new nuget-package, but I think people will recognize from the NLog-version-number whether it is relevant for NLog4 or NLog5.

For me it is okay to only maintain a single NLog-config-page (since it matches the wiki-pages).

@304NotModified
Copy link
Member Author

Im afraid that people get confused with the changes between nlog 4 and 5.

We need at least someting to the docs for that. And im thinking of adding a note to https://nlog-project.org/config/

I consider this as a showstopper :(

@304NotModified
Copy link
Member Author

The aliases are new for nlog 5.

But im aware of the large user base of nlog 4

@snakefoot
Copy link
Contributor

Im afraid that people get confused with the changes between nlog 4 and 5.

That is usually how the wiki-pages works. When adding details about new features, then one also specify what version of NLog is required.

@snakefoot
Copy link
Contributor

snakefoot commented Apr 19, 2022

Since the alias-feature seems to be very difficult to explain and understand, and it is blocking the NLog 5.0 release (Cannot get my pull-requests merged for NLog5-docs), then I'm fine with either option:

  • Have it as an exotic feature that is not documented, that NLog-config-parser can be forgiving sometimes.
  • Merge the alias-feature to the NLog4-master-branch, since it is not a breaking change.
  • Remove the alias-feature from the NLog5-dev-branch.

@304NotModified
Copy link
Member Author

I just added (NLog 5 only) to the tooltip in #187

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants