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

Fix #4622: Android Wiki migration #4893

Merged
merged 390 commits into from
Mar 17, 2023
Merged

Fix #4622: Android Wiki migration #4893

merged 390 commits into from
Mar 17, 2023

Conversation

gp201
Copy link
Member

@gp201 gp201 commented Mar 8, 2023

Explanation

  • Fixes Migrate Android wiki to store source files in oppia-android repository #4622
  • The PR does the following: This PR moves the android wiki into the oppia-andoird codebase allowing contributors to make PRs to the wiki along with changes to the codebase itself. This PR also introduces a GitHub Action (Runs when a PR is merged into develop and when a user makes change to the wiki via the web interface) that copies the content of the wiki folder along with the git history of the wiki folder and deploys it to the oppia-android wiki repository.

The steps followed to achieve this wiki migration are present here:
Oppia Android Wiki Migration V2 (1).pdf

Note: Please ensure GitHub actions have write permissions. Please follow these instructions to enable it:

GrantingReadandWritePermissionsonGitHub_PDF.pdf

Essential Checklist

  • 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 files have their rationale included in the PR explanation.
  • The PR follows the style guide.
  • The PR does not contain any unnecessary code changes from Android Studio (reference).
  • The PR is made from a branch that's not called "develop" and is up-to-date with "develop".
  • The PR is assigned to the appropriate reviewers (reference).

For UI-specific PRs only

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)
  • Add a video showing the full UX flow with a screen reader enabled (see accessibility guide)
  • Add a screenshot demonstrating that you ran affected Espresso tests locally & that they're passing

@gp201 gp201 removed their assignment Mar 16, 2023
@MohitGupta121
Copy link
Member

@gp201 Thanks, PTAL, replied to comments.

@MohitGupta121 MohitGupta121 assigned gp201 and unassigned MohitGupta121 Mar 16, 2023
@gp201 gp201 assigned MohitGupta121 and unassigned gp201 Mar 16, 2023
@gp201
Copy link
Member Author

gp201 commented Mar 16, 2023

@MohitGupta121 PTAL

Copy link
Member

@MohitGupta121 MohitGupta121 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@gp201 LGTM, Thanks.

@MohitGupta121 MohitGupta121 removed their assignment Mar 16, 2023
wiki/Wiki.md Outdated Show resolved Hide resolved
wiki/Wiki.md Outdated Show resolved Hide resolved
@U8NWXD U8NWXD assigned gp201 and unassigned U8NWXD Mar 16, 2023
Copy link
Sponsor Member

@BenHenning BenHenning left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @gp201! The PR broadly LGTM, so approving it. I'm fine with @seanlip resolving any open comments from me once they're resolved, and merging.

@seanlip let's go with a squash merge here (per our discussion about whether to do a special one-time direct merge). I think it avoids introducing inconsistency in the history of the develop branch (since all other commits were proper PR squashes), and we'll have better wiki consistency moving forward as wiki files will be changed within PRs.

wiki/Wiki.md Outdated Show resolved Hide resolved
wiki/Wiki.md Outdated Show resolved Hide resolved
wiki/Wiki.md Show resolved Hide resolved
wiki/_Sidebar.md Outdated Show resolved Hide resolved
@BenHenning BenHenning assigned seanlip and unassigned BenHenning Mar 16, 2023
Copy link
Member

@seanlip seanlip left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Putting a review hold since I'm taking over approval for Ben (just making sure his comments are resolved). @gp201 please ping me once they are and I'll merge it. Thanks!

@seanlip seanlip removed their assignment Mar 16, 2023
@gp201 gp201 assigned seanlip and U8NWXD and unassigned gp201 Mar 16, 2023
@gp201
Copy link
Member Author

gp201 commented Mar 16, 2023

@seanlip @U8NWXD PTAL

Copy link
Member

@seanlip seanlip left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks @gp201!

@oppiabot oppiabot bot unassigned seanlip Mar 17, 2023
@oppiabot
Copy link

oppiabot bot commented Mar 17, 2023

Unassigning @seanlip since they have already approved the PR.

@seanlip seanlip enabled auto-merge (squash) March 17, 2023 11:39
@seanlip seanlip merged commit 57ec240 into oppia:develop Mar 17, 2023
Uticodes pushed a commit to Uticodes/oppia-android that referenced this pull request Mar 23, 2023
<!-- 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 oppia#4622
- The PR does the following: This PR moves the android wiki into the
oppia-andoird codebase allowing contributors to make PRs to the wiki
along with changes to the codebase itself. This PR also introduces a
GitHub Action (Runs when a PR is merged into develop and when a user
makes change to the wiki via the web interface) that copies the content
of the wiki folder along with the git history of the wiki folder and
deploys it to the oppia-android wiki repository.

The steps followed to achieve this wiki migration are present here: 
[Oppia Android Wiki Migration V2
(1).pdf](https://github.com/oppia/oppia-android/files/10921370/Oppia.Android.Wiki.Migration.V2.1.pdf)

### Note: Please ensure GitHub actions have write permissions. Please
follow these instructions to enable it:

[GrantingReadandWritePermissionsonGitHub_PDF.pdf](https://github.com/oppia/oppia-android/files/10919834/GrantingReadandWritePermissionsonGitHub_PDF.pdf)


## 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)).

## 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))
- Add a screenshot demonstrating that you ran affected Espresso tests
locally & that they're passing

---------

Co-authored-by: Rajat Talesra <rajattalesra4914@gmail.com>
Co-authored-by: Ben Henning <henning.benmax@gmail.com>
Co-authored-by: Akshay Nandwana <akshaynandwana001@gmail.com>
Co-authored-by: Srikanth K B <srikanth.kadaba@gmail.com>
Co-authored-by: Jan <fsharpasharp@users.noreply.github.com>
Co-authored-by: Abhay Garg <54636525+prayutsu@users.noreply.github.com>
Co-authored-by: Arjun Gupta <arjupta.90@gmail.com>
Co-authored-by: Sparsh Agrawal <55937724+Sparsh1212@users.noreply.github.com>
Co-authored-by: Farees Hussain <fareezzhussain@gmail.com>
Co-authored-by: Sarthak Agarwal <agarwal.sarthak262012@gmail.com>
Co-authored-by: Sean Lip <sean@seanlip.org>
Co-authored-by: Apoorv Srivastava <53645584+MaskedCarrot@users.noreply.github.com>
Co-authored-by: Vinita Murthi <murthi.vinita@gmail.com>
Co-authored-by: Ankita Saxena <ankitasonu24@gmail.com>
Co-authored-by: Vojtěch Jelínek <vojtech.jelinek@hey.com>
Co-authored-by: Ben Henning <ben@oppia.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Migrate Android wiki to store source files in oppia-android repository