Skip to content

Commit

Permalink
fix: Feedback addressed
Browse files Browse the repository at this point in the history
  • Loading branch information
volodymyr-chekyrta committed Mar 15, 2024
1 parent 0436ed4 commit a61778d
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 1 deletion.
2 changes: 1 addition & 1 deletion Documentation/APIs_Compatibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ If your platform version is older than December 2023, follow the instructions be

1. Setup the [mobile-api-extensions](https://github.com/raccoongang/mobile-api-extensions) plugin to your platform.
The Plugin contains extended Open edX APIs for mobile applications.
2. Roll back the modifications that brought in the new APIs [3bca8bf](https://github.com/openedx/openedx-app-ios/commit/3bca8bfa994163635e1128f0404007c6d0d4761f).
2. Roll back the modifications that brought in the new APIs [42f518a](https://github.com/openedx/openedx-app-android/commit/42f518a264d4300c8c2ca349072addd7d16ff91a).
17 changes: 17 additions & 0 deletions Documentation/ConfigurationManagement.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ config_mapping:
- `config_directory` provides the path of the config directory.
- `config_mappings` provides mappings that can be utilized to map the Android Build Variant to a defined folder within the config directory, and it will be referenced.

Note: You can specify `config_directory` to any folder outside the repository to store the configs as a separate project.

### Configuration Files
In the `default_config` folder, select your environment folder: prod, stage, dev or any other you have created.
Open `config.yaml` and fill in the required fields.
Expand Down Expand Up @@ -59,6 +61,20 @@ MICROSOFT:
CLIENT_ID: 'microsoftClientID'
```
Also, all envirenment folders contain a `file_mappings.yaml` file that points to the config files to be parsed.

By modifying `file_mappings.yaml`, you can achieve splitting of the base `config.yaml` or add additional configuration files.

Example:

```yaml
android:
files:
- auth_client.yaml
- config.yaml
- feature_flags.yaml
```

## Available Third-Party Services
- **Firebase:** Analytics, Crashlytics, Cloud Messaging
- **Google:** Sign in and Sign up via Google
Expand All @@ -69,6 +85,7 @@ MICROSOFT:
- **SegmentIO:** Analytics

## Available Feature Flags
- **PRE_LOGIN_EXPERIENCE_ENABLED:** Enables the pre login courses discovery experience.
- **WHATS_NEW_ENABLED:** Enables the "What's New" feature to present the latest changes to the user.
- **SOCIAL_AUTH_ENABLED:** Enables SSO buttons on the SignIn and SignUp screens.
- **COURSE_NESTED_LIST_ENABLED:** Enables an alternative visual representation for the course structure.
Expand Down

0 comments on commit a61778d

Please sign in to comment.