docs: updates docs on gh-team-allowlist

[dversoza]

To better describe the flag about using the team name and not the slug, with practical examples.

[nitrocode]

Thank you @dversoza !

[jamengual]

I do not think this is correct, when I created this functionality if you did not pass the slug it would not find the team.

are you confident that this works?

[jamengual]

it is possible that it worked but you might be allowing everyone

[dversoza]

Hey @jamengual, in my case, using "Engineering Team:apply" instead of "engineering-team:apply" was the only way to make it work.

Using the slug returned an error response, and the permissions didn't work.

As it took me a long time, multiple back-and-forth tests, and code investigation to figure this out, I decided to add this note to the documentation to help newcomers.

--edit

As you mentioned, I also tested it, and it worked for preventing other teams from running plan or apply.

[nitrocode]

We had a previous similar PR #2005 to mention it was a slug too. The PR here made it even more clear.

I wonder why a name would work but a slug wouldn't? It would be nice to support both.