zulip icon indicating copy to clipboard operation
zulip copied to clipboard

Finish renaming Display settings -> Preferences

Open alya opened this issue 1 year ago • 80 comments

To finish out the work in #25945, we should update the following uses of "display settings" -> "preferences":

zerver/lib/hotspots.py:            "Go to Settings to configure your notifications and display settings."
zerver/models.py:    ### Display settings. ###

as well as many other variables in the code (https://github.com/zulip/zulip/issues/26874#issuecomment-1737885164):

CZO thread

alya avatar Sep 26 '23 21:09 alya

Hello @zulip/server-onboarding members, this issue was labeled with the "area: onboarding" label, so you may want to check it out!

zulipbot avatar Sep 26 '23 21:09 zulipbot

@zulipbot claim

Ciggzy1312 avatar Sep 27 '23 02:09 Ciggzy1312

Welcome to Zulip, @Ciggzy1312! We just sent you an invite to collaborate on this repository at https://github.com/zulip/zulip/invitations. Please accept this invite in order to claim this issue and begin a fun, rewarding experience contributing to Zulip!

Here's some tips to get you off to a good start:

As you work on this issue, you'll also want to refer to the Zulip code contribution guide, as well as the rest of the developer documentation on that site.

See you on the other side (that is, the pull request side)!

zulipbot avatar Sep 27 '23 02:09 zulipbot

@zulipbot claim

arnavchhokra avatar Sep 27 '23 07:09 arnavchhokra

@arnavchhokra This issue cannot be claimed, as someone else is already working on it. Please see our contributor guide for advice on finding an issue to work on. Thanks!

zulipbot avatar Sep 27 '23 07:09 zulipbot

PR #26882 solves this issue

Ciggzy1312 avatar Sep 27 '23 10:09 Ciggzy1312

There's a lot more things that can be renamed. update_display_settings is part of the API (and already deprecated and to be removed) and thus cannot be simply renamed, but there's a bunch more that can be done:

$ git grep -i 'display[ _-]settings' | grep -v update_display_settings | grep -v display_settings_legacy | grep -v locale
api_docs/changelog.md:  `demote_inactive_streams` display settings.
docs/overview/changelog.md:  view can now be configured via "Display settings".
docs/overview/changelog.md:- Added nice UI for selecting a default language to display settings.
web/e2e-tests/settings.test.ts:    const display_settings_section = '[data-section="preferences"]';
web/e2e-tests/settings.test.ts:    await page.click(display_settings_section);
web/e2e-tests/settings.test.ts:    await page.waitForSelector(display_settings_section, {visible: true});
web/e2e-tests/settings.test.ts:    await page.click(display_settings_section);
web/e2e-tests/settings.test.ts:    await page.waitForSelector(display_settings_section, {visible: true});
web/e2e-tests/settings.test.ts:    await page.click(display_settings_section);
web/src/admin.js:        display_settings: settings_config.get_all_display_settings(),
web/src/hashchange.js:    if (section === "display-settings") {
web/src/hashchange.js:        // Since display-settings was deprecated and replaced with preferences
web/src/hashchange.js:        // #settings/display-settings is being redirected to #settings/preferences.
web/src/server_events_dispatch.js:            const user_display_settings = [
web/src/server_events_dispatch.js:            if (user_display_settings.includes(event.property)) {
web/src/settings.js:        ...settings_config.display_settings_labels,
web/src/settings.js:        display_settings: settings_config.get_all_display_settings(),
web/src/settings_config.ts:        user_display_settings: string[];
web/src/settings_config.ts:export const get_all_display_settings = (): DisplaySettings => ({
web/src/settings_config.ts:        user_display_settings: [
web/src/settings_config.ts:export const display_settings_labels = {
web/src/settings_config.ts:    ...display_settings_labels,
web/src/settings_display.js:        const $spinner = $container.find(".emoji-display-settings-status").expectOne();
web/src/settings_display.js:                    $container.find(".emoji-display-settings-status").expectOne(),
web/src/settings_display.js:    const $spinner = $(settings_panel.container).find(".emoji-display-settings-status");
web/styles/settings.css:.display-settings-form,
web/styles/settings.css:label.display-settings-radio-choice-label {
web/styles/settings.css:    .display-settings-form select {
web/templates/settings/display_settings.hbs:<form class="display-settings-form">
web/templates/settings/display_settings.hbs:    <div class="emoji-display-settings {{#if for_realm_settings}}settings-subsection-parent{{else}}subsection-parent{{/if}}">
web/templates/settings/display_settings.hbs:            {{> settings_save_discard_widget section_name="emoji-display-settings" show_only_indicator=(not for_realm_settings) }}
web/templates/settings/display_settings.hbs:                    <label class="display-settings-radio-choice-label">
web/templates/settings/display_settings.hbs:                    <label class="display-settings-radio-choice-label">
web/templates/settings/display_settings.hbs:        {{#each display_settings.settings.user_display_settings}}
web/templates/settings/display_settings.hbs:              render_only=(lookup ../display_settings.render_only this)
web/templates/settings/organization_user_settings_defaults.hbs:    {{> display_settings prefix="realm_" for_realm_settings=true full_name=full_name}}
web/templates/settings/user_display_settings.hbs:    {{> display_settings prefix="user_" for_realm_settings=false}}
web/templates/settings_tab.hbs:    {{> settings/user_display_settings }}
web/tests/i18n.test.js:        display_settings: {
zerver/lib/hotspots.py:            "Go to Settings to configure your notifications and display settings."
zerver/models.py:    ### Display settings. ###

If you choose to work on this further, please rename one element at a time -- e.g. settings_display.js => settings_preferences.js would be one commit that carefully and thoroughly renames just that one thing, passing all tests, and emoji-display-settings => emoji-preferences would be another commit -- it's like 10x easier to review such a PR and we definitely won't review a PR for this work not done that way.

timabbott avatar Sep 27 '23 18:09 timabbott

is this issue still open to claim?

AdityaDKale avatar Sep 28 '23 14:09 AdityaDKale

@AdityaDKale yes, feel free to take it up Do follow the instructions mentioned by Tim on how to proceed

Ciggzy1312 avatar Sep 28 '23 14:09 Ciggzy1312

@zulipbot claim

AdityaDKale avatar Sep 28 '23 14:09 AdityaDKale

@AdityaDKale No pressure, just curious if you're still working on this issue?

Winter3531 avatar Oct 02 '23 13:10 Winter3531

Yes I am actually working on this issue. Thanks for concern.

AdityaDKale avatar Oct 02 '23 13:10 AdityaDKale

@zulipbot claim

ezekielmose avatar Oct 04 '23 02:10 ezekielmose

@ezekielmose This issue cannot be claimed, as someone else is already working on it. Please see our contributor guide for advice on finding an issue to work on. Thanks!

zulipbot avatar Oct 04 '23 02:10 zulipbot

I don't think I have to modify web/e2e-tests/settings.test.ts file right? Also should I modify

web/src/admin.js
web/src/hashchange.js
web/src/server_events_dispatch.js
web/src/settings.js
web/src/settings_config.ts
web/styles/settings.css
web/templates/settings/display_settings.hbs
web/templates/settings/organization_user_settings_defaults.hbs
web/templates/settings/user_display_settings.hbs
web/templates/settings_tab.hbs
web/tests/i18n.test.js
zerver/lib/hotspots.py
zerver/models.py

according to your previous given answer @timabbott ?

AdityaDKale avatar Oct 04 '23 15:10 AdityaDKale

I think I have fixed a part of this issue right? @timabbott

AdityaDKale avatar Oct 07 '23 14:10 AdityaDKale

@alya Thanks for the input. Please check if this suits your need.

AdityaDKale avatar Oct 15 '23 15:10 AdityaDKale

@AdityaDKale You have been unassigned from this issue because you have not made any updates for over 14 days. Please feel free to reclaim the issue if you decide to pick up again. Thanks!

zulipbot avatar Oct 25 '23 15:10 zulipbot

@zulipbot claim

lata-11 avatar Oct 30 '23 11:10 lata-11

HI @AdityaDKale! I can see you had actively worked on this bug. Since you had not been active for 2 weeks it was available so I took it. I just wanted to confirm are you still planning to work on this or should I start? Thanks.

lata-11 avatar Oct 31 '23 02:10 lata-11

Sure thing !! You can start on this issue. Just follow the instructions mentioned by Tim.

AdityaDKale avatar Oct 31 '23 06:10 AdityaDKale

@lata-11 You have been unassigned from this issue because you have not made any updates for over 14 days. Please feel free to reclaim the issue if you decide to pick up again. Thanks!

zulipbot avatar Nov 10 '23 09:11 zulipbot

@zulipbot claim

Aditya8840 avatar Nov 15 '23 14:11 Aditya8840

Welcome to Zulip, @Aditya8840! We just sent you an invite to collaborate on this repository at https://github.com/zulip/zulip/invitations. Please accept this invite in order to claim this issue and begin a fun, rewarding experience contributing to Zulip!

Here's some tips to get you off to a good start:

As you work on this issue, you'll also want to refer to the Zulip code contribution guide, as well as the rest of the developer documentation on that site.

See you on the other side (that is, the pull request side)!

zulipbot avatar Nov 15 '23 14:11 zulipbot

@Aditya8840 You have been unassigned from this issue because you have not made any updates for over 14 days. Please feel free to reclaim the issue if you decide to pick up again. Thanks!

zulipbot avatar Nov 28 '23 15:11 zulipbot

@Aditya8840 We noticed that you have not made any updates to this issue or linked PRs for 10 days. Please comment here if you are still actively working on it. Otherwise, we'd appreciate a quick @zulipbot abandon comment so that someone else can claim this issue and continue from where you left off.

If we don't hear back, you will be automatically unassigned in 4 days. Thanks!

I'm actively working on this issue.

Aditya8840 avatar Nov 28 '23 16:11 Aditya8840

@Aditya8840 are you still working on this issue?

mehul-srivastava avatar Dec 03 '23 04:12 mehul-srivastava

@zulipbot claim

Miteshsuthar935 avatar Dec 03 '23 14:12 Miteshsuthar935

Welcome to Zulip, @Miteshsuthar935! We just sent you an invite to collaborate on this repository at https://github.com/zulip/zulip/invitations. Please accept this invite in order to claim this issue and begin a fun, rewarding experience contributing to Zulip!

Here's some tips to get you off to a good start:

As you work on this issue, you'll also want to refer to the Zulip code contribution guide, as well as the rest of the developer documentation on that site.

See you on the other side (that is, the pull request side)!

zulipbot avatar Dec 03 '23 14:12 zulipbot

@Miteshsuthar935 Could you kindly unassign yourself and assign me to the open pull request? I'm actively working on it at the moment.

Aditya8840 avatar Dec 03 '23 17:12 Aditya8840