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 #4460: Add Wiki documentation for adding the spotlight experience to any element #4943

Merged
merged 14 commits into from
Apr 27, 2023

Conversation

JishnuGoyal
Copy link
Contributor

@JishnuGoyal JishnuGoyal commented Apr 11, 2023

Explanation

Fixes #4460
This PR adds a new page to the Wiki explaining how Spotlights should be used, how new ones should be added and how should they be tested.

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

@JishnuGoyal JishnuGoyal requested a review from BenHenning as a code owner April 11, 2023 11:05
@JishnuGoyal JishnuGoyal self-assigned this Apr 11, 2023
@JishnuGoyal
Copy link
Contributor Author

JishnuGoyal commented Apr 11, 2023

Additionally, here is this link to the original Spotlight Wiki doc: https://docs.google.com/document/d/1houcOoZLbTgdwnL1HnmocolEjP6exfY-R_qsNbYPY7Y/edit#

Copy link
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 @JishnuGoyal! I think the filename is incorrect. Also we need to add this to the _Sidebar.md file so that it can be found on the side.

Besides that, since I've already reviewed the contents of this file in detail, I'm actually going to defer to @seanlip for the PR review since he's also broadly going to be reviewing wiki pages moving forward.

wiki/Spotlight Guide Outdated Show resolved Hide resolved
@BenHenning BenHenning requested a review from seanlip April 15, 2023 00:19
@BenHenning BenHenning assigned JishnuGoyal and unassigned BenHenning Apr 15, 2023
@BenHenning
Copy link
Member

@JishnuGoyal please assign to @seanlip once the comments above are addressed.

@JishnuGoyal
Copy link
Contributor Author

Hey @BenHenning, how exactly should I make sure this file is shown in the sidebar?

@JishnuGoyal JishnuGoyal assigned seanlip and BenHenning and unassigned JishnuGoyal Apr 17, 2023
@JishnuGoyal
Copy link
Contributor Author

PTAL @seanlip , thanks!

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.

Thanks @JishnuGoyal! Took a full pass, PTAL.

Re including this page in the sidebar, @BenHenning's already given you a pointer -- please add it to the relevant place in _Sidebar.md. Thanks!

wiki/Spotlight Guide.md Outdated Show resolved Hide resolved
wiki/Spotlight Guide.md Outdated Show resolved Hide resolved
wiki/Spotlight Guide.md Outdated Show resolved Hide resolved
wiki/Spotlight Guide.md Outdated Show resolved Hide resolved
wiki/Spotlight Guide.md Outdated Show resolved Hide resolved
wiki/Spotlight Guide.md Outdated Show resolved Hide resolved
wiki/Spotlight Guide.md Outdated Show resolved Hide resolved
wiki/Spotlight Guide.md Outdated Show resolved Hide resolved
wiki/Spotlight Guide.md Outdated Show resolved Hide resolved
wiki/Spotlight Guide.md Outdated Show resolved Hide resolved
@seanlip seanlip assigned JishnuGoyal and unassigned seanlip and BenHenning Apr 18, 2023
wiki/Spotlight Guide.md Outdated Show resolved Hide resolved
@JishnuGoyal
Copy link
Contributor Author

Please take another pass at this @seanlip , thanks!

@JishnuGoyal JishnuGoyal assigned seanlip and unassigned JishnuGoyal Apr 22, 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.

Thanks @JishnuGoyal, I think the page content looks fine. But I think you missed @BenHenning's comment from before. Could you please:

(a) Add this page to the _Sidebar.md file so that users can get to it
(b) Make sure this page is named in the same way as others in the wiki (no spaces in the name, use hyphens)

Once you've done that, this PR can be merged. Thanks!

@seanlip seanlip assigned JishnuGoyal and unassigned seanlip Apr 25, 2023
@JishnuGoyal
Copy link
Contributor Author

Updated the file name and added the same to the sidebar.

@seanlip PTAL, thanks!

@oppiabot oppiabot bot assigned seanlip and unassigned JishnuGoyal Apr 25, 2023
@oppiabot
Copy link

oppiabot bot commented Apr 25, 2023

Unassigning @JishnuGoyal since a re-review was requested. @JishnuGoyal, please make sure you have addressed all review comments. Thanks!

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.

Thanks! LGTM.

@oppiabot oppiabot bot unassigned seanlip Apr 26, 2023
@oppiabot
Copy link

oppiabot bot commented Apr 26, 2023

Unassigning @seanlip since they have already approved the PR.

@JishnuGoyal
Copy link
Contributor Author

I have updated this branch. @BenHenning PTAL, thanks!

@oppiabot oppiabot bot assigned BenHenning and unassigned JishnuGoyal Apr 27, 2023
@oppiabot
Copy link

oppiabot bot commented Apr 27, 2023

Unassigning @JishnuGoyal since a re-review was requested. @JishnuGoyal, please make sure you have addressed all review comments. Thanks!

@seanlip seanlip merged commit 60e6d81 into oppia:develop Apr 27, 2023
@seanlip
Copy link
Member

seanlip commented Apr 27, 2023

Merged. Thanks @JishnuGoyal!

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.

Add Wiki documentation for adding the spotlight experience to any element
3 participants