Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ IF SUFFICIENT INFORMATION IS NOT PROVIDED VIA THE FOLLOWING TEMPLATE THE ISSUE M
>

### OS and Version?
> Windows 7, 8 or 10. Linux (which distribution). macOS (Yosemite? El Capitan? Sierra?)
> Windows 8, 10, or 11. Linux (which distribution). macOS (Mojave? Catalina? Big Sur? Monterey?)

### Versions
>
Expand Down
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## [project-title] Changelog
# Microsoft identity platform product documentation backing code changelog

<a name="x.y.z"></a>
# x.y.z (yyyy-mm-dd)
Expand Down
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Contributing to [project-title]
# Contributing to Microsoft identity platform product documentation backing code

This project welcomes contributions and suggestions. Most contributions require you to agree to a
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
Expand Down Expand Up @@ -51,12 +51,12 @@ chances of your issue being dealt with quickly:
* **Suggest a Fix** - if you can't fix the bug yourself, perhaps you can point to what might be
causing the problem (line of code or commit)

You can file new issues by providing the above information at the corresponding repository's issues link: https://github.com/[organization-name]/[repository-name]/issues/new].
You can file new issues by providing the above information at the corresponding repository's issues link: https://github.com/Azure-Samples/ms-identity-docs-code-python/issues/new].

### <a name="submit-pr"></a> Submitting a Pull Request (PR)
Before you submit your Pull Request (PR) consider the following guidelines:

* Search the repository (https://github.com/[organization-name]/[repository-name]/pulls) for an open or closed PR
* Search the repository (https://github.com/Azure-Samples/ms-identity-docs-code-python/pulls) for an open or closed PR
that relates to your submission. You don't want to duplicate effort.

* Make your changes in a new git fork:
Expand All @@ -69,7 +69,7 @@ Before you submit your Pull Request (PR) consider the following guidelines:
* Rebase your fork and force push to your GitHub repository (this will update your Pull Request):

```shell
git rebase master -i
git rebase main -i
git push -f
```

Expand Down
61 changes: 11 additions & 50 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,57 +1,18 @@
# Project Name
# Microsoft identity platform product documentation backing code

(short, 1-3 sentenced, description of the project)
This repo contains code used to directly support the product documentation for the [Microsoft identity platform](https://docs.microsoft.com/azure/active-directory/develop/). It is a mono-repo that contains all of the referenced tutorials relating to Python-based implementations using the [Microsoft Autentication Library (MSAL) for Python](https://github.com/AzureAD/microsoft-authentication-library-for-python).

## Features
## Content

This project framework provides the following features:
This repo contains the following code to directly support the product docs:

* Feature 1
* Feature 2
* ...

## Getting Started

### Prerequisites

(ideally very short, if any)

- OS
- Library version
- ...

### Installation

(ideally very short)

- npm install [package name]
- mvn install
- ...

### Quickstart
(Add steps to get up and running quickly)

1. git clone [repository clone url]
2. cd [respository name]
3. ...


## Demo

A demo app is included to show how to use the project.

To run the demo, follow these steps:

(Add steps to start up the demo)

1.
2.
3.
* Coming Soon!

## Resources

(Any additional resources or related projects)

- Link to supporting information
- Link to similar sample
- ...
- [Microsoft identity platform product documentation](https://docs.microsoft.com/azure/active-directory/develop/)
- [Microsoft Authentication Library (MSAL) documentation](https://docs.microsoft.com/azure/active-directory/develop/msal-overview)
- [Microsoft Authentication Library (MSAL) for Python](https://github.com/AzureAD/microsoft-authentication-library-for-python)
- [msal on PyPI](https://pypi.org/project/msal/)
- [Microsoft Authentication Library (MSAL) for Python SDK Docs](https://msal-python.readthedocs.io/en/latest/)
- [MSAL for Python Roadmap](https://github.com/AzureAD/microsoft-authentication-library-for-python/wiki/Roadmap)