Skip to content

Set expectation for example_nordvpnlite_config.json#1565

Open
gindoslaw wants to merge 1 commit intoNordSecurity:mainfrom
gindoslaw:patch-2
Open

Set expectation for example_nordvpnlite_config.json#1565
gindoslaw wants to merge 1 commit intoNordSecurity:mainfrom
gindoslaw:patch-2

Conversation

@gindoslaw
Copy link
Copy Markdown

Add a small message for the nordvpnlite users.

Problem

example_nordvpnlite_config.json may be a temptation for a copy-paste. Settings are good for software engineers, but also are the trap for new users.

Solution

Add warning at the beginning of the file and point user to the alternative file used in OpenWRT package.

Add small message for the nordvpnlite users
@gindoslaw gindoslaw requested a review from a team as a code owner November 6, 2025 15:59
@nord-llt
Copy link
Copy Markdown

nord-llt commented Nov 6, 2025

CLA assistant check
All committers have signed the CLA.

@@ -1,3 +1,7 @@
# This file is not for copy&paste
Copy link
Copy Markdown
Contributor

@tomasz-grz tomasz-grz Nov 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unfortunately JSON format does not support file comments.

And would also cause test_config_example to fail. which is there only to make sure the example config is updated and valid..

The main question is if we actually need example_nordvpnlite_config.json, maybe better documentation instead?

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 this pull request may close these issues.

3 participants