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

Updates why this cli docs #6452

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Updates why this cli docs #6452

wants to merge 4 commits into from

Conversation

Adam-it
Copy link
Member

@Adam-it Adam-it commented Oct 26, 2024

🎯 Aim

Based on our internal discussion the aim is to update the 'Why this CLI' docs page to provide more details and advantages of our product.

📸 Result

image

@Adam-it Adam-it added the docs label Oct 26, 2024
Copy link
Member

@waldekmastykarz waldekmastykarz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very nice! Some suggestions for improvement.

docs/docs/about/why-cli.mdx Outdated Show resolved Hide resolved
docs/docs/about/why-cli.mdx Outdated Show resolved Hide resolved
docs/docs/about/why-cli.mdx Outdated Show resolved Hide resolved
docs/docs/about/why-cli.mdx Outdated Show resolved Hide resolved
docs/docs/about/why-cli.mdx Outdated Show resolved Hide resolved
docs/docs/about/why-cli.mdx Outdated Show resolved Hide resolved
docs/docs/about/why-cli.mdx Outdated Show resolved Hide resolved
docs/docs/about/why-cli.mdx Outdated Show resolved Hide resolved
docs/docs/about/why-cli.mdx Outdated Show resolved Hide resolved
docs/docs/about/why-cli.mdx Outdated Show resolved Hide resolved
@Adam-it
Copy link
Member Author

Adam-it commented Nov 1, 2024

@waldekmastykarz, @milanholemans ready for another check?

@milanholemans milanholemans self-assigned this Dec 15, 2024
Copy link
Contributor

@milanholemans milanholemans left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few remarks from my side 😊

docs/docs/about/why-cli.mdx Outdated Show resolved Hide resolved
docs/docs/about/why-cli.mdx Outdated Show resolved Hide resolved
docs/docs/about/why-cli.mdx Outdated Show resolved Hide resolved
docs/docs/about/why-cli.mdx Outdated Show resolved Hide resolved
docs/docs/about/why-cli.mdx Outdated Show resolved Hide resolved
docs/docs/about/why-cli.mdx Outdated Show resolved Hide resolved
docs/docs/about/why-cli.mdx Outdated Show resolved Hide resolved
@milanholemans milanholemans marked this pull request as draft December 15, 2024 00:32
@Adam-it Adam-it marked this pull request as ready for review December 17, 2024 10:36
@Adam-it
Copy link
Member Author

Adam-it commented Dec 17, 2024

@milanholemans thanks for your review. I applied most of your comments. Do you wanna take the PR for another spin 🙂?

Copy link
Contributor

@milanholemans milanholemans left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Apart from a few tiny remarks, nothing more to add. Nice job!

- ***[Manage SharePoint Framework solutions](../cmd/spfx/spfx-doctor)***. CLI for Microsoft 365 will help you setup your local environment for SPFx development and will help you with common tasks when developing SPFx solutions, like validating its correctness or getting guidance on how to upgrade it.
- Make [CLI for Microsoft 365 your own](../user-guide/configuring-cli). CLI for Microsoft 365 offers a variety of settings that will allow you to customize it for your specific use case or needs. If going over the settings is challenging, then you will love the [m365 setup](../cmd/setup) command that will help you customize CLI for common use cases like setting it to be tailored to be run in a script.
- AI, Of course, we have an AI! CLI for Microsoft 365 comes along with an [AI assistant chili 🌶️](../user-guide/chili) that will help you find the right commands for your tasks.
- How many CLI's allows you to run it as your API in an app? That is what I though. [CLI for Microsoft 365 may be used as an API](../user-guide/use-cli-api) in your Node.js app.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- How many CLI's allows you to run it as your API in an app? That is what I though. [CLI for Microsoft 365 may be used as an API](../user-guide/use-cli-api) in your Node.js app.
- How many CLIs allow you to run them as an API in your app? Exactly! [CLI for Microsoft 365 can be used as an API](../user-guide/use-cli-api) in your Node.js app.

- You may use it in CI/CD pipelines. It integrates easily with Azure DevOps and natively with GitHub workflows. CLI has dedicated [GitHub actions](../user-guide/github-actions) which you may use directly in GitHub workflow and it allows you to scaffold a pipeline for [Azure DevOps](../cmd/spfx/project/project-azuredevops-pipeline-add) and [GitHub workflows](../cmd/spfx/project/project-github-workflow-add).
- ***[Manage SharePoint Framework solutions](../cmd/spfx/spfx-doctor)***. CLI for Microsoft 365 will help you setup your local environment for SPFx development and will help you with common tasks when developing SPFx solutions, like validating its correctness or getting guidance on how to upgrade it.
- Make [CLI for Microsoft 365 your own](../user-guide/configuring-cli). CLI for Microsoft 365 offers a variety of settings that will allow you to customize it for your specific use case or needs. If going over the settings is challenging, then you will love the [m365 setup](../cmd/setup) command that will help you customize CLI for common use cases like setting it to be tailored to be run in a script.
- AI, Of course, we have an AI! CLI for Microsoft 365 comes along with an [AI assistant chili 🌶️](../user-guide/chili) that will help you find the right commands for your tasks.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- AI, Of course, we have an AI! CLI for Microsoft 365 comes along with an [AI assistant chili 🌶️](../user-guide/chili) that will help you find the right commands for your tasks.
- AI, of course, we have AI! CLI for Microsoft 365 comes along with an [AI assistant chili 🌶️](../user-guide/chili) that will help you find the right commands for your tasks.


### Why not use PnP PowerShell instead?

If you use PowerShell, PnP PowerShell is a convenient solution that you can use to manage different parts of Microsoft 365. CLI for Microsoft 365 offers additional flexibility with the ability to run it in any shell. CLI for Microsoft 365 also offers unique commands to manage SPFx solutions. Whether you're a beginner or an advanced user, and want to use CLI for daily interactive use or scripting, you can configure CLI for Microsoft 365 to your needs making an invaluable tool in your toolbox. CLI for Microsoft 365- offers interactive mode by default which will actively prompt you for required options. CLI for Microsoft 365 is also more intuitive since all commands are grouped into areas like `spo` for SharePoint Online or `entra` for Entra ID, which makes it easier to find the command or operation you are looking for.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
If you use PowerShell, PnP PowerShell is a convenient solution that you can use to manage different parts of Microsoft 365. CLI for Microsoft 365 offers additional flexibility with the ability to run it in any shell. CLI for Microsoft 365 also offers unique commands to manage SPFx solutions. Whether you're a beginner or an advanced user, and want to use CLI for daily interactive use or scripting, you can configure CLI for Microsoft 365 to your needs making an invaluable tool in your toolbox. CLI for Microsoft 365- offers interactive mode by default which will actively prompt you for required options. CLI for Microsoft 365 is also more intuitive since all commands are grouped into areas like `spo` for SharePoint Online or `entra` for Entra ID, which makes it easier to find the command or operation you are looking for.
If you use PowerShell, PnP PowerShell is a convenient solution that you can use to manage different parts of Microsoft 365. CLI for Microsoft 365 offers additional flexibility with the ability to run it in any shell. CLI for Microsoft 365 also offers unique commands to manage SPFx solutions. Whether you're a beginner or an advanced user, and want to use CLI for daily interactive use or scripting, you can configure CLI for Microsoft 365 to your needs making an invaluable tool in your toolbox. CLI for Microsoft 365 offers interactive mode by default which will actively prompt you for required options. CLI for Microsoft 365 is also more intuitive since all commands are grouped into areas like `spo` for SharePoint Online or `entra` for Entra ID, which makes it easier to find the command or operation you are looking for.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants