Update docs to increase visibility of setup guide
🎯 Aim
The aim of this issue is to update our guidance to make the basic install + setup + login really clear and a step by step path. The initial setup, so when we use m365 setup command or, since not everybody can use this option, we need to add the app reg manually, is a must have before we start using CLI for Microsoft 365. From our docs it is not that obvious and easy to find guide. It is not even in the top 3 guides in our docs 🤔.
I suggest we do the following to make this all easier for our users.
- first of all let's add a new group in our docs "Getting Started" and in this group add the following:
- "Overview" page - this is a new page in which we do a high level explanation of what needs to be done with the 'happy' path easiest steps to get started. Like how to install using npm, how to setup using the setup command and the initial login. If someone wants to use yarn for installing or docker or adding the app reg manually then for those scenarios we provide links to the following next pages mentioned below which provide more content.
- Next page is the install guide - as we have now
- then we add the setup guide next with name 'Setup the CLI'
- then we reorder and show the 'Log in to Microsoft 365' page
- then we go with 'Use the CLI'
- . ... then everything else as we have now
Also we should refactor the 'Use your own Microsoft Entra identity' content. The content is generally ok and well written. I would only refactor it a bit describing this is an obligatory step everyone need to perform in order to use CLI for Microsoft 365
📸 Expected result
Suggested menu order
1. Getting Started
1. Overview ----> new page
2. Install the CLI
3. Setup the CLI ----> old/new page
4. Log in to Microsoft 365
2. Use the CLI
3. .... all other
@pnp/cli-for-microsoft-365-maintainers any feed? should we open it up?
Great suggestion! What we really need to keep in mind is the guide to be useful for someone with basic experience of Node.js-based apps on Microsoft Cloud and not just a list of links that send you to other pages so that in the end, you had to go to 4 other places before you can run the first command. I suggest that the first page guides readers through the steps without any explanation, and includes links for them to follow if they need more information.
Fully agree with @waldekmastykarz’s feedback. Other than that precaution about minimizing clicks between pages, this is a solid suggestion.
Ok I rechecked this issue and it seems quite solid, also from the comments I don't see we need some more clarity on this. Let's open this up