Add commands for SharePoint Syntex/Premium
Opened this issue · 13 comments
In one of my research, I discovered that there is a special section in the SharePoint API for managing SP Syntex models. Here is the link: https://learn.microsoft.com/en-us/sharepoint/dev/apis/syntex/syntex-model-rest-api
What do you think about the idea of creating a set of commands in CLI, such as m365 spo stx,.. to manage models?
Some of the endpoints look really useful, such as:
https://learn.microsoft.com/en-us/sharepoint/dev/apis/syntex/rest-getbytitle-method
https://learn.microsoft.com/en-us/sharepoint/dev/apis/syntex/rest-applymodel-method
https://learn.microsoft.com/en-us/sharepoint/dev/apis/syntex/rest-getmodelandlibraryinfo
We can also add a command to retrieve the Syntex Content Center site.
Let me know what you think.
@mkm17 I think it is a really awesome area we could introduce to CLI and it's great to see you already started 👏
one comment I have regarding the m365 spo stx contentcentreurl list I would just name it ...contentcentre list. I don't think we need to specify the url in the naming we may just leave it in the description of the command
@mkm17 so @milanholemans pointed out a very valuable comment here #6103 (comment)
which applies to all the created issues. naming 😊
I doe agree with @milanholemans that syntex would be better and clearer than stx so lets change this already.
about the premium honestly I do not know. From what I see know is that premium will become (or rather already is) a evolution of syntex but it does seem that, at least now, both names are used and it kinda seems like syntex is a part of what premium is. So we could change it to premium the question is will it be clear for others. or maybe we should have an alias and support both names for now so syntex and premium 🤔
@pnp/cli-for-microsoft-365-maintainers what do you think 👆?
@mkm17 what is your take on that? Also before we proceed on the issues lets wait to solve this naming discussion
My 2 cents...
The Syntex name was phased out, despite a recent community call presentation (yesterday, I think?). I'd recommend using [premium or spp or prem], because that matches the current branding. In my opinion, Syntex was a bad name anyway and likely why MSFT switched. Syntex didn't really communicate well what it actually did. Since "SharePoint Premium" actually calls out that it's a SharePoint experience, it's more clear. Hopefully Microsoft doesn't switch the name again, but if that is going to be added to M365 CLI, you should at least call it the current name to match user expectations.
It's not good to assume that all users know the history of the product name (Cortex, MS Syntex, SP Syntex). I could see a lot of questions from users about when you'll add SP Premium to the CLI if you went with syntex.
In summary, I think something like this would be clear:
m365 spo premium <command> <params>
@milanholemans @Adam-it hmm perhaps we could use both names for a single command? I believe it’s sometimes done with parameter names when a name is deprecated, but I’m not sure about command names.
In documentation Syntex is used -> #6103 (comment) .
@mkm17 If you could use the old and new name (as you mentioned in the deprecation case), that would be good! It matches the documentation as well as current branding.
@stevecorey365 thanks for you ASAP response to my request. You Rock 🤩.
@mkm17 TBH I would go with what Steve suggest so go with premium and just drop syntex, especially since from MS side it seems to be a replacement as well.
@pnp/cli-for-microsoft-365-maintainers any other feed on that 👆
@milanholemans @Adam-it hmm perhaps we could use both names for a single command?
Yes it is possible. We use alias for that so that one command has multiple naming. But still I think I would aim the near future which is just premium
@Adam-it , ok so I will change naming to
premium
yes lets do that.
Awesome to see this new sub area (spo premium) getting started CLI for M365. You Rock 🤩👏👏👏👏
Hi everyone, in one of the issues @waldekmastykarz propose to change name of the sub area from premium to spp. Check details here -> #6118 (comment)
Hi everyone, in one of the issues @waldekmastykarz propose to change name of the sub area from
premiumtospp. Check details here -> #6118 (comment)
ooo this really makes sense. And will make it easier to find and use instead of having this 'lost' in the spo tree which is already huge. @mkm17 what is your take on that? I think it is an awesome idea 👍
@Adam-it so it's about changing it to m365 spp model get, for example. That is a nice idea. I will update the command spec accordingly.
Hi @mkm17, slightly updated your epic so the issues are properly linked to this epic now
