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

refactor(970): moves notices for joining to its own component #972

Merged
merged 5 commits into from
Jan 10, 2025

Conversation

ankushdharkar
Copy link
Contributor

@ankushdharkar ankushdharkar commented Jan 6, 2025

We were copying the same notice for joining in two places. This moves it to its own component, so future changes are easier.

Date: Jan 5, 2025

Developer Name: Ankush Dharkar


Issue Details

Description:

We want to update the text copy for messaging on how to join our squad. But noticed that the message is duplicated, and currently doesn't have support to have some more html added to redirect links and such. E.g a link to follow to twitter flowchart to join, etc.

This change prepares the component that will be reused in future to display the messaging regarding how to join RDS

Is Under Feature Flag

  • Yes - A little differently used here though. By default, the new code which is a harmless text change will show. If something goes wrong, enabling the right feature flag will restore previous behaviour as a kill switch
  • No

Database changes

  • Yes
  • No

Breaking changes (If your feature is breaking/missing something please mention pending tickets)

  • Yes
  • No

Is Development Tested?

  • Yes
  • No

Tested in staging?

  • Yes
  • No

Add relevant Screenshot below ( e.g test coverage etc. )

image

@ankushdharkar ankushdharkar linked an issue Jan 6, 2025 that may be closed by this pull request
5 tasks
@ankushdharkar ankushdharkar self-assigned this Jan 6, 2025
@ankushdharkar ankushdharkar added the enhancement Enhances an existing feature label Jan 6, 2025
We were copying the same notice for joining in two places. This moves it to its own component, so future changes are easier.
Copy link

cloudflare-workers-and-pages bot commented Jan 6, 2025

Deploying www-rds with  Cloudflare Pages  Cloudflare Pages

Latest commit: 4249537
Status: ✅  Deploy successful!
Preview URL: https://9c36b926.www-rds.pages.dev
Branch Preview URL: https://970-update-homepage.www-rds.pages.dev

View logs

@AnujChhikara
Copy link

Hi @ankushdharkar , I have a question. When creating a PR, should we strictly stay within the scope (e.g., just creating a reusable component) and leave related tasks like correcting the text for a separate PR? Or is it better to address both in one PR to make the feature complete?

tejaskh3
tejaskh3 previously approved these changes Jan 6, 2025
@tejaskh3 tejaskh3 self-requested a review January 6, 2025 19:29
tejaskh3
tejaskh3 previously approved these changes Jan 7, 2025
@ankushdharkar
Copy link
Contributor Author

Hi @ankushdharkar , I have a question. When creating a PR, should we strictly stay within the scope (e.g., just creating a reusable component) and leave related tasks like correcting the text for a separate PR? Or is it better to address both in one PR to make the feature complete?

@AnujChhikara It depends. I like to keep things easier for reviewers. If I have to make new changes and refactor, I increase the scope of review here. Now, one group of reviewers just have to check if this PR creates no side-effects. And a future (and maybe different group) can check if the new message for 2025 is correct. Since each group has to focus on smaller changes, the review is less likely to get stuck and will be moved forward faster.

@tejaskh3 tejaskh3 self-requested a review January 7, 2025 16:10
@ankushdharkar ankushdharkar changed the title feat(970): moves notices for joining to its own component refactor(970): moves notices for joining to its own component Jan 7, 2025
@AnujChhikara
Copy link

AnujChhikara commented Jan 8, 2025

Can we please update the screenshot to reflect new changes ? I think attached screenshot is outdated.

@surajmaity1
Copy link

surajmaity1 commented Jan 8, 2025

Please change the text from 'Closes' to 'Open' before GitHub issue ticket of Issue Details section as issue is still open.
Later you can mark it close when issue ticket will be closed.

@AnujChhikara
Copy link

Please change the text from 'Closes' to 'Open' before GitHub issue ticket of Issue Details section as issue is still open.
Later you can mark it close when issue ticket will be closed.

@surajmaity1I don't think we need that, Closes mean this PR resolve the issue and we follow the same format in our PRs also

@ankushdharkar
Copy link
Contributor Author

Please change the text from 'Closes' to 'Open' before GitHub issue ticket of Issue Details section as issue is still open. Later you can mark it close when issue ticket will be closed.

Good callout @surajmaity1

But this, is PR 1/N. If you take a look at the issue, there are more changes to be done after this refactoring PR is merged. In fact, this PR is going to make it easier to make those future changes correctly.

@surajmaity1
Copy link

surajmaity1 commented Jan 8, 2025

Please change the text from 'Closes' to 'Open' before GitHub issue ticket of Issue Details section as issue is still open. Later you can mark it close when issue ticket will be closed.

Good callout @surajmaity1

But this, is PR 1/N. If you take a look at the issue, there are more changes to be done after this refactoring PR is merged. In fact, this PR is going to make it easier to make those future changes correctly.

It makes sense. It'll be better if you break the issue into few parts and mention in this ticket ( #970 ) with checkboxes and mark only checkboxes those are completed so that we can track whole task.

@ankushdharkar
Copy link
Contributor Author

Please change the text from 'Closes' to 'Open' before GitHub issue ticket of Issue Details section as issue is still open. Later you can mark it close when issue ticket will be closed.

Good callout @surajmaity1
But this, is PR 1/N. If you take a look at the issue, there are more changes to be done after this refactoring PR is merged. In fact, this PR is going to make it easier to make those future changes correctly.

It makes sense. It'll be better if you break the issue into few parts and mention in this ticket ( #970 ) with checkboxes and mark only checkboxes those are completed.

That may be an overkill here, since PR description should be complete on its own. Happy to discuss if having atomic issues is mandatory, or a suggestion.

  1. It's a refactor PR
  2. Original issue is mentioned
  3. This change serves as an intermediate, yet self-sufficient or/and gated change towards the enhancement

@pankajjs
Copy link
Member

pankajjs commented Jan 8, 2025

Suggestion: I see this sentence We're currently not accepting new applications. Please come back later. is being used at three places in the new changes. Can we store it in a const variable and reuse it?
@ankushdharkar

@ankushdharkar
Copy link
Contributor Author

Suggestion: I see this sentence We're currently not accepting new applications. Please come back later. is being used at three places in the new changes. Can we store it in a const variable and reuse it? @ankushdharkar

Given that the code for 2 sentences are going to be deleted during feature flag cleanup, and the sentence will then live on only in the single component, putting it in a constant may be unnecessary at this point, as a single source of truth will be maintained i.e <NoticeForJoining />

Copy link
Member

@pankajjs pankajjs left a comment

Choose a reason for hiding this comment

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

LGTM

@AnujChhikara
Copy link

Please change the text from 'Closes' to 'Open' before GitHub issue ticket of Issue Details section as issue is still open. Later you can mark it close when issue ticket will be closed.

Good callout @surajmaity1

But this, is PR 1/N. If you take a look at the issue, there are more changes to be done after this refactoring PR is merged. In fact, this PR is going to make it easier to make those future changes correctly.

Can we include a note in the 'Additional Notes' section clarifying that this PR doesn't completely close the issue?

@prakashchoudhary07 prakashchoudhary07 merged commit f8c0184 into develop Jan 10, 2025
3 checks passed
@prakashchoudhary07 prakashchoudhary07 deleted the 970-update-homepage branch January 10, 2025 18:56
@tejaskh3 tejaskh3 mentioned this pull request Jan 12, 2025
10 tasks
iamitprakash added a commit that referenced this pull request Jan 15, 2025
* [My Site Migration] Identity Linking get started page (#965)

* resolve merge commits

* feat: add get started page

* remove: unused auth url

* fix: css for get started on identity page

* feat: add identity page behind feature flag

* nit: remove unwanted .DS_store

---------

Co-authored-by: Mehul Kiran Chaudhari <[email protected]>

* [My Site Migration] Identity Linking step1 page (#966)

* resolve merge commits

* feat: add get started page

* remove: unused auth url

* fix: css for get started on identity page

* feat: add identity page behind feature flag

* feat: setp1 page in identity linking

* remove: unused redirect-auth util

* Remove .DS_Store files from repository

* feat: add varaible css

* feat: add varaible css

* refactor(970): moves notices for joining to its own component (#972)

* feat(970): moves notices for joining to its own component

We were copying the same notice for joining in two places. This moves it to its own component, so future changes are easier.

* refactor(970): added review changes: year - 2024

* refactor(970): fixed messaging for joining

---------

Co-authored-by: Amit Prakash <[email protected]>
Co-authored-by: Achintya Chatterjee <[email protected]>

* [My Site Migration] Identity Linking step2,3 page (#967)

* resolve merge commits

* feat: add get started page

* remove: unused auth url

* fix: css for get started on identity page

* feat: add identity page behind feature flag

* feat: setp1 page in identity linking

* remove: unused redirect-auth util

* Remove .DS_Store files from repository

* feat: add varaible css

* feat: add varaible css

* feat: add step2 on identity linking page

* feat: add step2 and step3 page

* feat: add reload step

* feat: add varaible css

---------

Co-authored-by: TEJAS <[email protected]>
Co-authored-by: Mehul Kiran Chaudhari <[email protected]>
Co-authored-by: Ankush Dharkar <[email protected]>
Co-authored-by: Amit Prakash <[email protected]>
Co-authored-by: Lakshay Manchanda <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Enhances an existing feature refactor-only
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update Homepage - Jan 2025