Skip to content

Commit

Permalink
docs: capitalise github and fix some typos (#3985)
Browse files Browse the repository at this point in the history
  • Loading branch information
@dabeeeenster
dabeeeenster authored May 20, 2024
1 parent 021f22f commit 1a453ed
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions docs/docs/integrations/project-management/github.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,14 @@ View your Flagsmith Flags inside your GitHub Issues and Pull Request
4. In the Flagsmith application, the button will now say "Manage Integration", click on it.
5. Finally, select the repository you wish to link.

### From github
### From GitHub

1. In GitHub, add the app from the [GitHub Marketplace](https://github.com/apps/flagsmith).
2. Select your organisation.
3. Select your repositories where you want install the app.
4. You will be redirected back to the Flagsmith app to finish the integration setup.
5. Select your Flagsmith Organisation.
6. Select the Flagmsith Project you want to associate with the repository where the app was installed to create the
6. Select the Flagsmith Project you want to associate with the repository where the app was installed to create the
Integration.

## Adding a Flagsmith Flag to a GitHub issue or pull request
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/system-administration/authentication/04-LDAP.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ are using the correct environment variables.
| **LDAP_DEFAULT_FLAGSMITH_ORGANISATION_ID** | 1 | All newly created users will be added to this originisation | None |
| **LDAP_AUTH_SYNC_USER_RELATIONS** | custom_auth.ldap.sync_user_groups | Path to a callable used to sync user relations. Note: if you are setting this value to `custom_auth.ldap.sync_user_groups` please make sure `LDAP_DEFAULT_FLAGSMITH_ORGANISATION_ID` is set. | django_python3_ldap.utils.sync_user_relations |
| **LDAP_AUTH_FORMAT_SEARCH_FILTERS** | custom_auth.ldap.login_group_search_filter | Path to a callable used to add search filters to login to restrict login to a certain group | django_python3_ldap.utils.format_search_filters |
| **LDAP_SYNCED_GROUPS** | CN=Readers,CN=Roles,CN=webapp01,<br/>dc=admin,dc=com:CN=Marvel,CN=Roles,<br/>CN=webapp01,dc=admin,dc=com | colon(:) seperated list of DN's of ldap group that will be copied over to flagmsith (lazily, i.e: On user login we will create the group(s) and add the current user to the group(s) if the user is a part of them). Note: please make sure to set `LDAP_AUTH_SYNC_USER_RELATIONS` to `custom_auth.ldap.sync_user_groups` in order for this to work. | [] |
| **LDAP_SYNCED_GROUPS** | CN=Readers,CN=Roles,CN=webapp01,<br/>dc=admin,dc=com:CN=Marvel,CN=Roles,<br/>CN=webapp01,dc=admin,dc=com | colon(:) seperated list of DN's of ldap group that will be copied over to Flagsmith (lazily, i.e: On user login we will create the group(s) and add the current user to the group(s) if the user is a part of them). Note: please make sure to set `LDAP_AUTH_SYNC_USER_RELATIONS` to `custom_auth.ldap.sync_user_groups` in order for this to work. | [] |
| **LDAP_LOGIN_GROUP** | CN=Readers,CN=Roles,CN=webapp01,<br/>dc=admin,dc=com | DN of the user allowed login user group. Note: Please make sure to set `LDAP_AUTH_FORMAT_SEARCH_FILTERS` to `custom_auth.ldap.login_group_search_filter` in order for this to work. | None |
| **LDAP_SYNC_USER_USERNAME** | john | Username used by [sync_ldap_users_and_groups](#sync-ldap-groups) in order to connect to the server. | None |
| **LDAP_SYNC_USER_PASSWORD** | password | Password used by [sync_ldap_users_and_groups](#sync-ldap-groups) in order to connect to the server. | None |
Expand All @@ -118,7 +118,7 @@ are using the correct environment variables.
| **LDAP_DEFAULT_FLAGSMITH_ORGANISATION_ID** | 1 | All newly created users will be added to this originisation | None |
| **LDAP_AUTH_SYNC_USER_RELATIONS** | flagsmith_ldap.ldap.sync_user_groups | Path to a callable used to sync user relations. Note: if you are setting this value to `flagsmith_ldap.ldap.sync_user_groups` please make sure `LDAP_DEFAULT_FLAGSMITH_ORGANISATION_ID` is set. | django_python3_ldap.utils.sync_user_relations |
| **LDAP_AUTH_FORMAT_SEARCH_FILTERS** | flagsmith_ldap.ldap.login_group_search_filter | Path to a callable used to add search filters to login to restrict login to a certain group | django_python3_ldap.utils.format_search_filters |
| **LDAP_SYNCED_GROUPS** | CN=Readers,CN=Roles,CN=webapp01,<br/>dc=admin,dc=com:CN=Marvel,CN=Roles,<br/>CN=webapp01,dc=admin,dc=com | colon(:) seperated list of DN's of ldap group that will be copied over to flagmsith (lazily, i.e: On user login we will create the group(s) and add the current user to the group(s) if the user is a part of them). Note: please make sure to set `LDAP_AUTH_SYNC_USER_RELATIONS` to `flagsmith.ldap.sync_user_groups` in order for this to work. | [] |
| **LDAP_SYNCED_GROUPS** | CN=Readers,CN=Roles,CN=webapp01,<br/>dc=admin,dc=com:CN=Marvel,CN=Roles,<br/>CN=webapp01,dc=admin,dc=com | colon(:) seperated list of DN's of ldap group that will be copied over to Flagsmith (lazily, i.e: On user login we will create the group(s) and add the current user to the group(s) if the user is a part of them). Note: please make sure to set `LDAP_AUTH_SYNC_USER_RELATIONS` to `flagsmith.ldap.sync_user_groups` in order for this to work. | [] |
| **LDAP_LOGIN_GROUP** | CN=Readers,CN=Roles,CN=webapp01,<br/>dc=admin,dc=com | DN of the user allowed login user group. Note: Please make sure to set `LDAP_AUTH_FORMAT_SEARCH_FILTERS` to `flagsmith_ldap.ldap.login_group_search_filter` in order for this to work. | None |
| **LDAP_SYNC_USER_USERNAME** | john | Username used by [sync_ldap_users_and_groups](#sync-ldap-groups) in order to connect to the server. | None |
| **LDAP_SYNC_USER_PASSWORD** | password | Password used by [sync_ldap_users_and_groups](#sync-ldap-groups) in order to connect to the server. | None |
Expand Down

0 comments on commit 1a453ed

Please sign in to comment.