Skip to content

Commit

Permalink
[#133] Add a page to the userguide explaining unsupported settings.
Browse files Browse the repository at this point in the history
  • Loading branch information
netomi committed Dec 4, 2023
1 parent 9c65ccd commit 9fc5ac8
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 0 deletions.
17 changes: 17 additions & 0 deletions docs/userguide/unsupported.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
Not all features or settings of a GitHub organization and its associated resources can be managed
by the means of `otterdog`. The following non-exhaustive list outlines settings that are currently not supported:

- setting the profile picture of an organization or a social media preview for a repository [#119](https://gitlab.eclipse.org/eclipsefdn/security/otterdog/-/issues/119)
- manage default repository labels on organization level
- manage custom properties
- organization rulesets (only rulesets on repo level are supported atm)
- secrets and variables for codespaces and dependabot
- managing GitHub apps or oauth policies
- managing pinned repositories for an organization
- enabling private vulnerability reporting [#27](https://gitlab.eclipse.org/eclipsefdn/security/otterdog/-/issues/27)
- tag protections [#143](https://gitlab.eclipse.org/eclipsefdn/security/otterdog/-/issues/143)
- supporting merge queue settings for a branch protection rule [#86](https://gitlab.eclipse.org/eclipsefdn/security/otterdog/-/issues/86)

Most of the unsupported settings are only accessible via the Web UI of GitHub.
In case you would like to have a specific feature of GitHub being supported by `otterdog`,
please open a ticket [at](https://gitlab.eclipse.org/eclipsefdn/security/otterdog/-/issues/new).
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ nav:
- Validate: reference/operations/validate.md
- User Guide:
- Renaming of Resources: userguide/renaming.md
- Unsupported Settings: userguide/unsupported.md

- Contribute: contributing.md

Expand Down

0 comments on commit 9fc5ac8

Please sign in to comment.