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

Use Consistent Terminology Regarding Documents, Files, Messages, and Submissions #6543

Merged
merged 5 commits into from Sep 15, 2022

Conversation

nathandyer
Copy link
Contributor

Status

Ready for review

Description of Changes

Fixes #2421 and fixes #6173

Changes proposed in this pull request:

This updates the remaining user-facing references from 'Documents' to either 'Files' or 'Submissions,' depending on the given use-case. In a previous meeting we mentioned using 'Submission' for everything, but in practice I discovered that is not feasible. That's because 'Submission' includes both files and messages, but there are instances where it's necessary to specify between files and messages. This change eliminates the usage of 'Documents,' and adds consistency to the work that has already been done more recently.

Testing

This can be tested by building according to the steps in the README.

Deployment

This will require new translations.

Side-note, is it necessary here to run make translate to update the translation files, or does that happen after the fact?

Checklist

If you made changes to the server application code:

  • Linting (make lint) and tests (make test) pass in the development container

Choose one of the following:

  • I have opened a PR in the docs repo for these changes, or will do so later
  • I would appreciate help with the documentation
  • These changes do not require documentation

Just to note, normally these changes would require documentation updates, but it appears that the newer terminology has already made it into the product for all the user-facing strings shown in the documentation. I have gone through the source and journalist guides, and do not see any outdated strings that would need to be replaced.

@nathandyer nathandyer requested a review from a team as a code owner September 14, 2022 19:13
Copy link
Contributor

@zenmonkeykstop zenmonkeykstop left a comment

Choose a reason for hiding this comment

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

Looking good, have a couple of minor suggestions for text tweaks.

securedrop/source_app/main.py Outdated Show resolved Hide resolved
securedrop/source_templates/footer.html Outdated Show resolved Hide resolved
@zenmonkeykstop
Copy link
Contributor

Looks good, thank @nathandyer! The dev docs do recommend running make translate whenever strings are updated, but IIRC so long as it's run eventually it's not a problem.

@zenmonkeykstop zenmonkeykstop merged commit 542b59d into develop Sep 15, 2022
@zenmonkeykstop zenmonkeykstop deleted the 2421-use-consistent-terminology branch September 15, 2022 23:45
@eloquence eloquence added this to the 2.5.0 milestone Sep 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants