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

Updated "Getting Started" documentation #1116

Merged
merged 2 commits into from
Jan 8, 2025
Merged

Conversation

sdelgadoc
Copy link
Contributor

Background
One of the biggest barriers for beginners to get started with the python-o365 library is setting up OAuth authentication. The “Getting Started” guide referenced the outdated apps.dev.microsoft.com portal, could include additional detail, and did not include an example of how to use the library. In addition, other tools that use the python-o365 library can benefit from improved getting started instructions.

Challenge
With the transition to the Microsoft Entra Admin Center, the old instructions might confuse users by pointing them toward a deprecated portal. A more detailed guide could help developers navigate the new Microsoft Entra Admin Center and quickly understand python-o365 installation and usage.

Changes

  • Updated Microsoft Entra Admin Center References

    • Removed references to the old apps.dev.microsoft.com portal.
    • Provided detailed, step-by-step instructions for registering applications in the new Microsoft Entra Admin Center (creating apps, generating secrets, adding redirect URIs, and configuring permissions).
  • Expanded Basic Usage Section

    • Included a complete Python code example demonstrating how to instantiate Account and send an email with python-o365.
    • Used fenced code blocks for improved clarity.

@alejcas alejcas merged commit f2dad5b into O365:master Jan 8, 2025
@alejcas
Copy link
Member

alejcas commented Jan 8, 2025

Good job! thank you!

@sdelgadoc
Copy link
Contributor Author

sdelgadoc commented Jan 19, 2025

Hi @alejcas, thanks for accepting the PR! Did you have a chance to run make html when merging so the getting_started.rst file in the source folder generates a new getting_started.html file in the latest folder? The HTML file still shows the previous version of the content.

@alejcas
Copy link
Member

alejcas commented Jan 19, 2025

Hi @alejcas, thanks for accepting the PR! Did you have a chance to run make html when merging so the getting_started.rst file in the source folder generates a new getting_started.html file in the latest folder? The HTML file still shows the previous version of the content.

I'm having some hard weeks this days. I'll do it asap.

@sdelgadoc
Copy link
Contributor Author

This is not urgent @alejcas. No need to expedite. Thank you for your help!

@alejcas
Copy link
Member

alejcas commented Jan 19, 2025

If you want or/and have time, setting this info into the readme could also be very good for beginners.

thanks

@sdelgadoc
Copy link
Contributor Author

Absolutely! I have added the app registration steps to the README in PR #1118. Let me know if you have any edits or questions!

@alejcas
Copy link
Member

alejcas commented Feb 11, 2025

Unfortunately the doc build step is not working although there are no errors.
I don't know why, but I can't get the docs to be published with the latest changes.

Do you know why?

@RogerSelwyn
Copy link
Contributor

When I look at one of my page build jobs I get the below:
Screenshot 2025-02-11 at 16 28 50
When I look at yours there is no build step within the build step.
Screenshot 2025-02-11 at 16 30 17
Could it be that the makefile/sphinx is not supported by GitHub anymore, I can see it was created a long time ago.

@RogerSelwyn
Copy link
Contributor

RogerSelwyn commented Feb 11, 2025

It looks to me like there should be a GitHub action to create the pages, and then use the GitHub pages settings to deploy it. I haven't got time to try it out on my fork this week, but if you don't figure it out I'll try it next week.

https://coderefinery.github.io/documentation/gh_workflow/

Edit: Did you lose the action when you moved to this repository a long time ago, or was someone running it by hand?

@sdelgadoc
Copy link
Contributor Author

Hey @alejcas, I'm not familiar with the workflow but the feedback from @RogerSelwyn looks helpful.

@RogerSelwyn
Copy link
Contributor

I have created this PR to add key missing api docs and automate the publication - #1129

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

Successfully merging this pull request may close these issues.

3 participants