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

Remove deprecated keys in example templates? #1097

Closed
qupig opened this issue Apr 27, 2024 · 2 comments
Closed

Remove deprecated keys in example templates? #1097

qupig opened this issue Apr 27, 2024 · 2 comments

Comments

@qupig
Copy link
Contributor

qupig commented Apr 27, 2024

This really confused new adopters, for example we have in the template:

{
  "policies": {
    "Cookies": {
      "Allow": ["http://example.org/"],
      "AllowSession": ["http://example.edu/"],
      "Block": ["http://example.edu/"],
      "Default": true | false,
      "AcceptThirdParty": "always" | "never" | "from-visited",
      "ExpireAtSessionEnd": true | false,
      "RejectTracker": true | false,
      "Locked": true | false,
      "Behavior": "accept" | "reject-foreign" | "reject" | "limit-foreign" | "reject-tracker" | "reject-tracker-and-partition-foreign",
      "BehaviorPrivateBrowsing": "accept" | "reject-foreign" | "reject" | "limit-foreign" | "reject-tracker" | "reject-tracker-and-partition-foreign",
    }
  }
}

But in the documentation we don't describe all the keys.

Through my background knowledge, I know that there is a conflict between Default, AcceptThirdParty, RejectTracker and Behavior, I even need to doubt their priority because I think they all ultimately affect network.cookie.cookieBehavior.

But through more investigation, I found that they were once already marked as deprecated in the documentation:
Remove deprecated policies from the documentation (they remain in the GPO templates)

If it were my choice, I might prefer to keep the deprecation description in the documentation for a while and remove those keys in the example templates, since that's probably where people will start editing and modifying.

Including them in the example templates without a deprecation flag really confuses newcomers. But the deal is done, and maybe all we can do now is remove those deprecated keys from the example templates as well, without confusing more people.

@mkaply
Copy link
Collaborator

mkaply commented Apr 29, 2024

That's a good callout. I'll put them back (and remove from the examples)

@mkaply
Copy link
Collaborator

mkaply commented May 2, 2024

Fixed!

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

No branches or pull requests

2 participants