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

[OIDC] User docs #13285

Merged
merged 34 commits into from
Mar 28, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
480595b
docs/user: OIDC doc skeleton
woodruffw Mar 23, 2023
75ef2ce
docs/user: dump the OIDC docs in
woodruffw Mar 23, 2023
8f78f48
OIDC publishing: retitle
woodruffw Mar 23, 2023
73aaf16
docs: recase
woodruffw Mar 23, 2023
33f20df
docs: remove misbehaving directory
woodruffw Mar 23, 2023
475c070
docs: fixup
woodruffw Mar 23, 2023
dd1438f
docs: fix images
woodruffw Mar 23, 2023
9d3d9b9
user/main: remove unused macro
woodruffw Mar 23, 2023
23a7a45
docs: subpages!
woodruffw Mar 23, 2023
717b5c8
mkdocs: add nav
woodruffw Mar 23, 2023
0a310a4
docs: fix headers, use breakout
woodruffw Mar 23, 2023
0c5ec4a
docs: add missing preview breakout
woodruffw Mar 23, 2023
7355811
Merge remote-tracking branch 'upstream/main' into tob-oidc-user-docs
woodruffw Mar 23, 2023
d710805
Losslessly squash assets by ~40%
hugovk Mar 23, 2023
2bf8a48
Apply suggestions from code review
woodruffw Mar 23, 2023
e90802a
Update docs/user/OIDC-publishing/adding-a-publisher.md
woodruffw Mar 23, 2023
7e4c4d5
Merge pull request #1623 from hugovk/13285-squash-pngs
woodruffw Mar 23, 2023
69d8437
Apply suggestions from code review
woodruffw Mar 24, 2023
8a417bf
Apply suggestions from code review
woodruffw Mar 24, 2023
e408cb7
Apply suggestions from code review
woodruffw Mar 24, 2023
e172c99
Update docs/user/main.py
woodruffw Mar 24, 2023
ab13e65
docs: rename entire tree
woodruffw Mar 24, 2023
77fdaf5
docs: remove "above" ref
woodruffw Mar 24, 2023
2ac579a
docs: OIDC -> trusted
woodruffw Mar 24, 2023
83790a8
docs: emphasize permission preference
woodruffw Mar 24, 2023
62d8aaa
docs: add a diff
woodruffw Mar 24, 2023
c9e37a0
docs: document risks with untrusted committers
woodruffw Mar 24, 2023
c69eac5
docs: remove ref to beta
woodruffw Mar 24, 2023
ae693ba
Apply suggestions from code review
di Mar 24, 2023
f21748b
docs: use a canonical PyPI project name
woodruffw Mar 25, 2023
a7f63b9
docs: more picture updates
woodruffw Mar 25, 2023
3051803
Merge remote-tracking branch 'upstream/main' into tob-oidc-user-docs
woodruffw Mar 25, 2023
508db84
Apply suggestions from code review
di Mar 28, 2023
514a25b
Merge branch 'main' into tob-oidc-user-docs
di Mar 28, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/user/assets/dropdown.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/user/assets/manage-link.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/user/assets/pending-publisher-form.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
woodruffw marked this conversation as resolved.
Show resolved Hide resolved
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
woodruffw marked this conversation as resolved.
Show resolved Hide resolved
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/user/assets/project-publishing-form.png
woodruffw marked this conversation as resolved.
Show resolved Hide resolved
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/user/assets/project-publishing-link.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/user/assets/project-publishing.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/user/assets/publishing-link.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/user/assets/required-reviewers.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
28 changes: 25 additions & 3 deletions docs/user/main.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,20 @@
from pathlib import Path


OIDC_PUBLISHING = """
!!! info

OpenID Connect publishing functionality is currently in closed beta.

You can register for the closed beta using
woodruffw marked this conversation as resolved.
Show resolved Hide resolved
[this form](https://forms.gle/XUsRT8KTKy66TuUp7).

**NOTE**: Access to the OIDC beta is provided on a *per-user* basis: users
can register OIDC publishers against projects once added to the beta, but
other maintainers/owners of the project can't modify OIDC settings unless
they're *also* in the beta.
"""

ORG_ACCOUNTS = """
!!! info

Expand All @@ -8,9 +25,9 @@
to be one of the first to know how you can begin using them.
"""

PREVIEW_FEATURES = {
'org-accounts': ORG_ACCOUNTS
}
PREVIEW_FEATURES = {"oidc-publishing": OIDC_PUBLISHING, "org-accounts": ORG_ACCOUNTS}

_HERE = Path(__file__).parent.resolve()


def define_env(env):
Expand All @@ -19,3 +36,8 @@ def define_env(env):
@env.macro
def preview(preview_feature):
return PREVIEW_FEATURES.get(preview_feature, "")

@env.macro
def image(name):
path = _HERE / "assets" / name
return f"![]({path})"
Loading