-
Notifications
You must be signed in to change notification settings - Fork 529
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
[Feature Request]: Update the Android FAQ #5246
Comments
Also copying @jlevick, the UX Writer, here, in case there are any questions about the above. Thanks! |
@deonwaju, PTAL at this issue. |
Warning: Update the Android FAQ Please review if this aligns so I can make a PR. @adhiamboperes |
Hi @deonwaju, could you please review the issue requirements again? I am not sure there is need for updating the name property of the strings. Its seems like you just need to update the text of a few strings, create a few new ones per issue description and finally make sure that the FAQs display in the app in then requested order. Additionally, you only need to make these changes in the english string files. Translations are handled externally. |
No I meant the name property of the string, to change it e.g, the current FAQ1 is "How can I create a new profile?" FAQ1 needs to be "What is Oppia?" and so on, the proper arrangement So I do understand the task, thanks for clarifying this though >Additionally, you only need to make these changes in the english string files. Translations are handled externally. |
Great, you can put up a PR for this. |
Just to clarify-- you don't need to translate the strings, but you may need to reorder the questions in the translations as well. |
Yeah, Thanks, I understand better now. |
Could someone please tell me how to solve issues. what is the procedure? I am new to open source. Thanks. |
Hi @shashijaiswal1, welcome to Oppia-Android. The first step would be to identify an issue. I recommend looking at the list of unassigned first issues and see one that you could work on. Once you find one, comment under it and tag me or @adhiamboperes and we will guide you on the next steps. |
Hi @shashijaiswal1, Our wiki is great place to get started contributing to opensource at Oppia. |
<!-- READ ME FIRST: Please fill in the explanation section below and check off every point from the Essential Checklist! --> ## Explanation <!-- - Explain what your PR does. If this PR fixes an existing bug, please include - "Fixes #bugnum:" in the explanation so that GitHub can auto-close the issue - when this PR is merged. --> Fixes #5246: "Update the Android FAQ" 1. Changed the order in which the FAQ questions where arranged by refactoring the property name of each string to the appropriate one based on requirements from #5246. 2. Added new questions based on requirements from #5246. 3. Refactored the faq question property names in the tests written in FAQListFragmentTest.kt according to the new order in which the questions where arranged. 4. Created a string extension file in string extensions to check if string resource contains a placeholder, to be able to dynamically replace the placeholders with the appropriate string values. 5. Used the string extension to check if any string resource file from the FAQ questions and answers contains a placeholder, then call function to replace placeholder with appropriate string value. https://github.com/oppia/oppia-android/assets/54560535/d2c0b6cb-251b-4591-9221-1d95a308cc74 https://github.com/oppia/oppia-android/assets/54560535/7b409e30-e9f6-4b4b-80ed-5449678a184f ## Essential Checklist <!-- Please tick the relevant boxes by putting an "x" in them. --> - [x] The PR title and explanation each start with "Fix #bugnum: " (If this PR fixes part of an issue, prefix the title with "Fix part of #bugnum: ...".) - [x] Any changes to [scripts/assets](https://github.com/oppia/oppia-android/tree/develop/scripts/assets) files have their rationale included in the PR explanation. - [x] The PR follows the [style guide](https://github.com/oppia/oppia-android/wiki/Coding-style-guide). - [x] The PR does not contain any unnecessary code changes from Android Studio ([reference](https://github.com/oppia/oppia-android/wiki/Guidance-on-submitting-a-PR#undo-unnecessary-changes)). - [x] The PR is made from a branch that's **not** called "develop" and is up-to-date with "develop". - [x] The PR is **assigned** to the appropriate reviewers ([reference](https://github.com/oppia/oppia-android/wiki/Guidance-on-submitting-a-PR#clarification-regarding-assignees-and-reviewers-section)).
## Explanation Renamed FAQ question and answer strings from index-based to more descriptive qualifiers. The corresponding translations to the previous strings have been deleted. The goal is to to overwrite existing faq strings and re-translate them, since a number of updates were made in #5246 and #5332. [device-2024-02-22-030542.webm](https://github.com/oppia/oppia-android/assets/59600948/be9a7cc8-89eb-4a1f-a02f-1466ffb0092f) ## Essential Checklist <!-- Please tick the relevant boxes by putting an "x" in them. --> - [ ] The PR title and explanation each start with "Fix #bugnum: " (If this PR fixes part of an issue, prefix the title with "Fix part of #bugnum: ...".) - [ ] Any changes to [scripts/assets](https://github.com/oppia/oppia-android/tree/develop/scripts/assets) files have their rationale included in the PR explanation. - [x] The PR follows the [style guide](https://github.com/oppia/oppia-android/wiki/Coding-style-guide). - [x] The PR does not contain any unnecessary code changes from Android Studio ([reference](https://github.com/oppia/oppia-android/wiki/Guidance-on-submitting-a-PR#undo-unnecessary-changes)). - [x] The PR is made from a branch that's **not** called "develop" and is up-to-date with "develop". - [x] The PR is **assigned** to the appropriate reviewers ([reference](https://github.com/oppia/oppia-android/wiki/Guidance-on-submitting-a-PR#clarification-regarding-assignees-and-reviewers-section)). ## For UI-specific PRs only <!-- Delete these section if this PR does not include UI-related changes. --> If your PR includes UI-related changes, then: - Add screenshots for portrait/landscape for both a tablet & phone of the before & after UI changes - For the screenshots above, include both English and pseudo-localized (RTL) screenshots (see [RTL guide](https://github.com/oppia/oppia-android/wiki/RTL-Guidelines)) - Add a video showing the full UX flow with a screen reader enabled (see [accessibility guide](https://github.com/oppia/oppia-android/wiki/Accessibility-A11y-Guide)) - For PRs introducing new UI elements or color changes, both light and dark mode screenshots must be included - Add a screenshot demonstrating that you ran affected Espresso tests locally & that they're passing --------- Co-authored-by: Ben Henning <[email protected]>
Is your feature request related to a problem? Please describe.
The UX Writing team has done a review of the Android app FAQ and would like to propose updates to it.
Describe the solution you'd like
FAQ items should be arranged in this order:
Updates to existing questions:
Q: How can I create a new profile? -- should be updated:
New questions:
Why are there only math lessons?
Oppia’s mission is to help learners gain necessary life skills. Math is an essential skill in everyday life. Oppia will be offering new lessons on science and other subjects soon!
Will you be making more lessons?
Yes, Oppia will be offering new lessons on science and other subjects soon. Please check back for updates!
I found a bug. How can I report it?
How do I get the app in my language?
The Oppia app currently supports English, Brazilian Portuguese, Arabic, and Nigerian Pidgin. Choose one of these languages in the menu, under Options. To request the app in your language, please contact us at email address.
How do I update the app?
Describe alternatives you've considered
N/A
Additional context
See the original design issue at oppia/design-team#75 for the discussion.
The text was updated successfully, but these errors were encountered: