Skip to content

Commit

Permalink
Update README and CONTRIBUTING following adoption
Browse files Browse the repository at this point in the history
  • Loading branch information
selfissued committed Oct 30, 2024
1 parent be72e3f commit f9394f6
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 38 deletions.
14 changes: 2 additions & 12 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,9 @@
# How to Contribute

The OpenID Connect working group page is https://openid.net/wg/connect/. It describes how to participate in the working group, including OpenID Federation.
The OpenID Connect working group page is https://openid.net/wg/connect/. It describes how to participate in the working group.

You can send feedback on the specification in a way that enables the working group to act upon it by
1. signing the contribution agreement at https://openid.net/intellectual-property/ to join the working group (please specify that you are joining the “AB/Connect” working group on your contribution agreement),
2. joining the working group mailing list at https://lists.openid.net/mailman/listinfo/openid-specs-ab, and
3. sending your feedback to the list.

Working group members can also contribute via GitHub.

When contributing, please adhere to the following guidelines:
When contributing via GitHub, please adhere to the following guidelines:

- **Issues**: Use the issue tracker to report problems or suggest enhancements.
- **Pull Requests**: Submit pull requests linked to Issues that were approved during a Working Group call.
- **Commit Messages**: Use clear and descriptive commit messages.

Thanks,<br/>
OpenID Connect Working Group
36 changes: 10 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,22 @@
# OpenID Federation 1.0
# OpenID Connect Relying Party Metadata Choices 1.0

This repository contains the OpenID Federation specification, which has been migrated from [Bitbucket](https://bitbucket.org/openid/connect/src/master/) to the OpenID Foundation's GitHub.
The OpenID Federation specification defines protocols and guidelines for implementing federated infrastructures among different domains and services.
This repository contains the OpenID Connect Relying Party Metadata Choices specification.

## Overview

OpenID Federation 1.0 is:

- a technical specification that shows us how to evaluate the Trust from a technical perspective,
- a technology that defines how to build trust infrastructures,
- a system for securely establishing the interoperability of participants.

## Status

News about OpenID Federation is available at the OpenID Foundation website [here](https://openid.net/tag/federation/).

The latest released draft of the specification is available at [https://openid.net/specs/openid-federation-1_0.html](https://openid.net/specs/openid-federation-1_0.html).
The most recent Implementer's Draft is available at [https://openid.net/specs/openid-federation-1_0-ID4.html](https://openid.net/specs/openid-federation-1_0-ID4.html).
This specification extends the OpenID Connect Dynamic Client Registration 1.0 specification to enable RPs to express a set of supported values for some RP metadata parameters, rather than just single values. This functionality is particularly useful when Automatic Registration, as defined in OpenID Federation 1.0, is used, since there is no registration response from the OP to tell the RP what choices were made by the OP.

## Builds

You can view the latest editors' draft at [https://openid.github.io/federation/main.html](https://openid.github.io/federation/main.html).
The latest released draft of the specification is available at [https://openid.net/specs/openid-connect-rp-metadata-choices-1_0.html](https://openid.net/specs/openid-connect-rp-metadata-choices-1_0.html).

You can view the latest editors' draft at [https://openid.github.io/rp-metadata-choices/main.html](https://openid.github.io/rp-metadata-choices/main.html).

Previews for each branch of this project are automatically built and published at the URL https://openid.github.io/federation/$branchname.html.
Previews for each branch of this project are automatically built and published at the URL https://openid.github.io/rp-metadata-choices/$branchname.html.
Previews for branches associated with pending Pull Requests are accessible using this pattern.

## Getting Started
To get started working on the OpenID Federation specification, clone this repository and review the documentation provided in the root directory.
## Build the HTML ##

````bash
git clone https://github.com/openid/federation.git
cd federation
````
Please read the [CONTRIBUTING.md](CONTRIBUTING.md) to learn how to contribute to this project.
```docker run -v `pwd`:/data danielfett/markdown2rfc openid-connect-rp-metadata-choices-1_0.md```

## Contact

For further information and to get involved, please visit the [OpenID Connect Working Group website](https://openid.net/wg/connect/).

0 comments on commit f9394f6

Please sign in to comment.