Skip to content

Commit 63aa74f

Browse files
committed
Update README with Azure DevOps documentation
Add provider configuration section explaining how to use either GitHub or Azure DevOps as the project source provider.
1 parent fad556c commit 63aa74f

File tree

1 file changed

+31
-3
lines changed

1 file changed

+31
-3
lines changed

README.md

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
<div align="center">
66
<h3>👋 Welcome to Framna Docs</h3>
7-
<h4>Self-hosted web portal that centralizes OpenAPI documentation and facilitates spec-driven development, built with GitHub-based authorization.</h4>
7+
<h4>Self-hosted web portal that centralizes OpenAPI documentation and facilitates spec-driven development, with support for GitHub and Azure DevOps.</h4>
88
</div>
99

1010
<div align="center">
@@ -43,16 +43,44 @@ Please refer to the following articles in [the wiki](https://github.com/shapehq/
4343

4444
## 👨‍🔧 How does it work?
4545

46-
Framna Docs uses [OpenAPI specifications](https://swagger.io) from GitHub repositories. Users log in with their GitHub account to access documentation for projects they have access to. A repository only needs an OpenAPI spec to be recognized by Framna Docs, but customization is possible with a .framna-docs.yml file. Here's an example:
46+
Framna Docs uses [OpenAPI specifications](https://swagger.io) from GitHub or Azure DevOps repositories. Users log in with their GitHub or Microsoft Entra ID account (depending on the configured provider) to access documentation for projects they have access to. A repository only needs an OpenAPI spec to be recognized by Framna Docs, but customization is possible with a .framna-docs.yml file. Here's an example:
4747

4848
<img width="650" src="https://github.com/shapehq/framna-docs/raw/main/wiki/example-openapi-repository-with-config.png?raw=true"/>
4949

50-
Framna Docs supports spec-driven development by requiring OpenAPI specs in GitHub repos, ensuring version control and peer review. When a pull request is opened, Framna Docs comments with links to preview the documentation:
50+
Framna Docs supports spec-driven development by requiring OpenAPI specs in version-controlled repositories, ensuring peer review. When using GitHub, Framna Docs comments on pull requests with links to preview the documentation:
5151

5252
<img width="760" src="https://github.com/shapehq/framna-docs/raw/main/wiki/pr-comment.png?raw=true"/>
5353

5454
Learn more from the [Adding Documentation](https://github.com/shapehq/framna-docs/wiki/Adding-Documentation-to-Framna-Docs), [Browsing Documentation](https://github.com/shapehq/framna-docs/wiki/Browsing-Documentation), and [Updating Documentation](https://github.com/shapehq/framna-docs/wiki/Updating-Documentation) articles in the wiki.
5555

56+
### Provider Configuration
57+
58+
Framna Docs supports two project source providers: **GitHub** (default) and **Azure DevOps**. Set the `PROJECT_SOURCE_PROVIDER` environment variable to choose your provider.
59+
60+
#### GitHub (default)
61+
62+
```bash
63+
PROJECT_SOURCE_PROVIDER=github
64+
GITHUB_CLIENT_ID=...
65+
GITHUB_CLIENT_SECRET=...
66+
GITHUB_APP_ID=...
67+
GITHUB_PRIVATE_KEY_BASE_64=...
68+
```
69+
70+
#### Azure DevOps
71+
72+
Azure DevOps uses Microsoft Entra ID (formerly Azure AD) for authentication:
73+
74+
```bash
75+
PROJECT_SOURCE_PROVIDER=azure-devops
76+
AZURE_ENTRA_ID_CLIENT_ID=...
77+
AZURE_ENTRA_ID_CLIENT_SECRET=...
78+
AZURE_ENTRA_ID_TENANT_ID=...
79+
AZURE_DEVOPS_ORGANIZATION=your-organization
80+
```
81+
82+
See `.env.example` for a full list of configuration options.
83+
5684
## 👩‍💻 How can I contribute?
5785

5886
Pull requests with bugfixes and new features are much appreciated. We are happy to review PRs and merge them once they are ready, as long as they contain changes that fit within the vision of Framna Docs.

0 commit comments

Comments
 (0)