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(core): change revision history label from 'Version' to the more accurate 'Revision' #6956

Merged
merged 3 commits into from
Jun 18, 2024

Conversation

bjoerge
Copy link
Member

@bjoerge bjoerge commented Jun 17, 2024

Description

This makes our labeling of revision to be more consistent. We are calling it revision in someplaces but not everywhere. Also updated the code to be more consistent too.

What to review

  • Is the way I've deprecate the old i18n key ok?
  • Would it be better to leave the key as-is and instead just change the label?

Testing

Don't think it makes all that much sense to add automated testing for this one

Notes for release

n/a - should just make the studio terminology more consistent.

@bjoerge bjoerge requested a review from a team as a code owner June 17, 2024 14:07
@bjoerge bjoerge requested review from binoy14 and removed request for a team June 17, 2024 14:07
Copy link

vercel bot commented Jun 17, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
page-building-studio ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 18, 2024 1:04pm
performance-studio ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 18, 2024 1:04pm
test-compiled-studio ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 18, 2024 1:04pm
test-next-studio ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 18, 2024 1:04pm
test-studio ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 18, 2024 1:04pm
1 Ignored Deployment
Name Status Preview Comments Updated (UTC)
studio-workshop ⬜️ Ignored (Inspect) Visit Preview Jun 18, 2024 1:04pm

Copy link
Contributor

No changes to documentation

Copy link
Contributor

github-actions bot commented Jun 17, 2024

Component Testing Report Updated Jun 18, 2024 1:10 PM (UTC)

File Status Duration Passed Skipped Failed
comments/CommentInput.spec.tsx ✅ Passed (Inspect) 43s 14 0 0
formBuilder/ArrayInput.spec.tsx ✅ Passed (Inspect) 7s 3 0 0
formBuilder/inputs/PortableText/Annotations.spec.tsx ✅ Passed (Inspect) 27s 6 0 0
formBuilder/inputs/PortableText/copyPaste/CopyPaste.spec.tsx ✅ Passed (Inspect) 32s 11 7 0
formBuilder/inputs/PortableText/Decorators.spec.tsx ✅ Passed (Inspect) 14s 6 0 0
formBuilder/inputs/PortableText/DisableFocusAndUnset.spec.tsx ✅ Passed (Inspect) 8s 3 0 0
formBuilder/inputs/PortableText/DragAndDrop.spec.tsx ✅ Passed (Inspect) 44s 2 0 0
formBuilder/inputs/PortableText/FocusTracking.spec.tsx ✅ Passed (Inspect) 36s 15 0 0
formBuilder/inputs/PortableText/Input.spec.tsx ✅ Passed (Inspect) 1m 14s 20 0 0
formBuilder/inputs/PortableText/ObjectBlock.spec.tsx ✅ Passed (Inspect) 1m 4s 18 0 0
formBuilder/inputs/PortableText/PresenceCursors.spec.tsx ✅ Passed (Inspect) 7s 3 9 0
formBuilder/inputs/PortableText/RangeDecoration.spec.tsx ✅ Passed (Inspect) 20s 9 0 0
formBuilder/inputs/PortableText/Styles.spec.tsx ✅ Passed (Inspect) 15s 6 0 0
formBuilder/inputs/PortableText/Toolbar.spec.tsx ✅ Passed (Inspect) 29s 12 0 0

* Label for latest revision for timeline menu dropdown
* @deprecated use `timeline.latest-revision` instead
* */
'timeline.latest-version': 'Latest revision',
Copy link
Contributor

Choose a reason for hiding this comment

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

defer to @rexxars on deprecating i18n keys. Not sure we have a process

Copy link
Member Author

@bjoerge bjoerge Jun 18, 2024

Choose a reason for hiding this comment

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

There's no clear process, but we can make this an opportunity to establish one?

This was a fair amount of OCD-induced change 😅, but I still feel the change it's justified by the likelyhood of existing language bundles already having translated "version" instead of "revision" (for example, the norwegian bundle is currently using "Siste versjon" here, when it should be "Siste revisjon"), and this change will give downstream locale implementors a chance to notice the change.

I've pushed some added clarity in the comments in 4864109 based on input from @rexxars.

Copy link
Contributor

Choose a reason for hiding this comment

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

understood, I am okay with the change just wanted to call it out

'timeline.latest-version': 'Latest version',

/** Label for latest revision for timeline menu dropdown */
'timeline.latest-revision': 'Latest revision',
Copy link
Contributor

Choose a reason for hiding this comment

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

@bjoerge I don't see anywhere in the code timeline.latest-revision key being used. Is that expected?

Copy link
Member Author

Choose a reason for hiding this comment

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

🤦🏼 forgot to change it in code, fixed in 66f81e4. Thanks for catching!

Copy link
Contributor

@binoy14 binoy14 left a comment

Choose a reason for hiding this comment

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

makes sense to me, thanks!

@bjoerge bjoerge added this pull request to the merge queue Jun 18, 2024
Merged via the queue into next with commit b90820c Jun 18, 2024
44 checks passed
@bjoerge bjoerge deleted the change-version-to-revision branch June 18, 2024 13:30
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.

2 participants