Add tags to samples. Closes #3640

[martinlingstuyl]

Closes #3640

This PR adds tags to samples, creates a tags index page, and a page containing an list of available tags.

This really is a first draft. @pnp/cli-for-microsoft-365-maintainers, for a critical review.

[Adam-it]

nice change 🤩. Thanks for opening this PR. We'll review it shortly 😉

[Jwaegebaert]

Really love the implementation of the tags. I have nothing to add, the PR looks great from my perspective. Good job @martinlingstuyl 🚀

[martinlingstuyl]

What about the chosen list of tags and the application of tags on the samples? Does that make sense?

[martinlingstuyl]

they just become a catch-all tag.

I expected this to come up 😂 I'll remove it.

I'll also add the one liners and merge security with permission management 👍

[martinlingstuyl]

Ok guys, I updated some things. Additional feedback very welcome!

[Jwaegebaert]

Hey @martinlingstuyl, before we continue with the review. Could you resolve the conflicts this PR currently has. 😄

[martinlingstuyl]

Will do!

[waldekmastykarz]

I also noticed that many if not all samples have keywords at the end. Have we considered using them as tags as well?

[martinlingstuyl]

Thanks for the valuable feedback @waldekmastykarz. I must say I largely ignored the keywords, as they often included for example the platform (SharePoint, Office 365) or a container term like Governance that I found questionable in its application.

I could check what keywords can be merged with tags, and delete all the keywords sections. That a good idea?

[waldekmastykarz]

I could check what keywords can be merged with tags, and delete all the keywords sections. That a good idea?

Good point! Let's do that 👍

[martinlingstuyl]

Hi @waldekmastykarz, I revisited the list and all samples.

• I added some more tags and removed some others.
• I checked the keywords, merged them with tags if necessary, and removed them.
• I removed the descriptions.

Let's see what you think of it. 🤙

[martinlingstuyl]

ok, I updated the code based on your comments @waldekmastykarz, don't forget to read my reply on the comment about mkdocs nav titles.

[waldekmastykarz]

Hey @martinlingstuyl, looks great! I'm a bit on the fence when it comes to us maintaining a list of tags. Seems like our original idea was to have a list of tags from which contributors of new samples can choose when submitting samples. As such, it would make more sense for it to be in our contribution guide rather than docs, because that's where contributors will be looking at. We could also consider suggesting that contributors of new samples try to use existing tags as much as possible and introduce new tags only when we don't have anything else matching. That way we only have the automatically generated list from tags used in samples and don't have to keep another list up to date manually, which will help us save work and increase consistency.

[waldekmastykarz]

Merged manually. Thank you! 👏

[martinlingstuyl]

Hey @martinlingstuyl, looks great! I'm a bit on the fence when it comes to us maintaining a list of tags. Seems like our original idea was to have a list of tags from which contributors of new samples can choose when submitting samples. As such, it would make more sense for it to be in our contribution guide rather than docs, because that's where contributors will be looking at. We could also consider suggesting that contributors of new samples try to use existing tags as much as possible and introduce new tags only when we don't have anything else matching. That way we only have the automatically generated list from tags used in samples and don't have to keep another list up to date manually, which will help us save work and increase consistency.

That's what we agreed on indeed. And you're right that they'd fit better in the contribution docs. I'll check it out and move the list of available tags there. 🤙