From 498d40e5b9968c101bdee28c6044d0533975cae3 Mon Sep 17 00:00:00 2001 From: Simon Brunning Date: Mon, 1 Jul 2024 15:49:49 +0100 Subject: [PATCH 1/2] Update name from "Redbox Copilot" to "Redbox" everywhere. --- .../redbox_app/redbox_core/email_handler.py | 2 +- .../templates/accessibility-statement.html | 8 +++--- django_app/redbox_app/templates/base.html | 2 +- .../redbox_app/templates/privacy-notice.html | 6 ++-- django_app/redbox_app/templates/support.html | 8 +++--- django_app/tests_playwright/pages.py | 24 ++++++++-------- tests/pages.py | 28 +++++++++---------- 7 files changed, 39 insertions(+), 39 deletions(-) diff --git a/django_app/redbox_app/redbox_core/email_handler.py b/django_app/redbox_app/redbox_core/email_handler.py index 8346d6818..a0b4e117a 100644 --- a/django_app/redbox_app/redbox_core/email_handler.py +++ b/django_app/redbox_app/redbox_core/email_handler.py @@ -4,7 +4,7 @@ EMAIL_MAPPING = { "magic_link": { - "subject": "Redbox Copilot sign-in", + "subject": "Redbox sign-in", "template_name": "email/verification.txt", }, } diff --git a/django_app/redbox_app/templates/accessibility-statement.html b/django_app/redbox_app/templates/accessibility-statement.html index f0116bfd5..2512a1dc8 100644 --- a/django_app/redbox_app/templates/accessibility-statement.html +++ b/django_app/redbox_app/templates/accessibility-statement.html @@ -7,9 +7,9 @@
-

Accessibility statement for Redbox Copilot

+

Accessibility statement for Redbox

-

This accessibility statement applies to Redbox Copilot.

+

This accessibility statement applies to Redbox.

This website is run by the Cabinet Office. We want as many people as possible to be able to use this website. For example, that means you should be able to:

  • change colours, contrast levels and fonts
    • @@ -27,10 +27,10 @@

    Feedback and contact information

    Reporting accessibility problems with this website

    We're always looking to improve the accessibility of this website. If you find any problems not listed on this page or think we're not meeting accessibility requirements, contact the team at {{contact_email}}.

    - +

    Enforcement procedure

    The Equality and Human Rights Commission (EHRC) is responsible for enforcing the Public Sector Bodies (Websites and Mobile Applications) (No. 2) Accessibility Regulations 2018 (the "accessibility regulations"). If you're not happy with how we respond to your complaint, contact the Equality Advisory and Support Service (EASS).

    - +

    Technical information about this website's accessibility

    Cabinet Office is committed to making its website accessible, in accordance with the Public Sector Bodies (Websites and Mobile Applications) (No. 2) Accessibility Regulations 2018.

    diff --git a/django_app/redbox_app/templates/base.html b/django_app/redbox_app/templates/base.html index 8b1da4863..e6e1cb4a9 100644 --- a/django_app/redbox_app/templates/base.html +++ b/django_app/redbox_app/templates/base.html @@ -5,7 +5,7 @@ - {% if pageTitle %} {{ pageTitle }} - {% endif %}Redbox Copilot + {% if pageTitle %} {{ pageTitle }} - {% endif %}Redbox diff --git a/django_app/redbox_app/templates/privacy-notice.html b/django_app/redbox_app/templates/privacy-notice.html index fa8654764..14657b0f3 100644 --- a/django_app/redbox_app/templates/privacy-notice.html +++ b/django_app/redbox_app/templates/privacy-notice.html @@ -8,7 +8,7 @@
    -

    Privacy notice for Redbox Copilot

    +

    Privacy notice for Redbox

    This notice sets out how we will use your personal data, and your rights. It is made under Articles 13 and/or 14 of the UK General Data Protection Regulation (UK GDPR).

    @@ -34,11 +34,11 @@

    Legal basis of processing

Recipients

-

Your personal data will be shared by us with analysts/researchers within the Cabinet Office if you have consented to be contacted further about Redbox Copilot.

+

Your personal data will be shared by us with analysts/researchers within the Cabinet Office if you have consented to be contacted further about Redbox.

As your personal data will be stored on our IT infrastructure it will also be shared with our data processors who provide email, and document management and storage services.

Retention

-

Your personal data will be retained for 12 months after account inactivity. At that point we will delete your email address, depersonalising the data we hold. If you have provided us consent to contact you, we will retain your email until and continue sharing it with evaluators so they can conduct research on the long term impact of Redbox Copilot.

+

Your personal data will be retained for 12 months after account inactivity. At that point we will delete your email address, depersonalising the data we hold. If you have provided us consent to contact you, we will retain your email until and continue sharing it with evaluators so they can conduct research on the long term impact of Redbox.

Your rights

You have the right to request information about how your personal data are processed, and to request a copy of that personal data.

diff --git a/django_app/redbox_app/templates/support.html b/django_app/redbox_app/templates/support.html index 294c4ce3b..acbf4d170 100644 --- a/django_app/redbox_app/templates/support.html +++ b/django_app/redbox_app/templates/support.html @@ -14,19 +14,19 @@

User guide

You can download the User Guide (PDF, 1.1MB), a step-by-step guide to signing in and using your account.

-

Accessing Redbox Copilot

-

You can access your Redbox Copilot account by visiting . You'll need to type your work email address in the box provided and select the submit button.

+

Accessing Redbox

+

You can access your Redbox account by visiting . You'll need to type your work email address in the box provided and select the submit button.

#}

Signing in

-

If you're having trouble signing in to the Redbox Copilot platform, check that:

+

If you're having trouble signing in to the Redbox platform, check that:

  • you're using your work email address
  • you've typed your work email address correctly
-

You should check your junk or spam folder for an email from Redbox Copilot.

+

You should check your junk or spam folder for an email from Redbox.

If you're still having trouble then you can contact us using the details at the bottom of this page.

diff --git a/django_app/tests_playwright/pages.py b/django_app/tests_playwright/pages.py index da30115ed..adbfd4dcf 100644 --- a/django_app/tests_playwright/pages.py +++ b/django_app/tests_playwright/pages.py @@ -100,7 +100,7 @@ def __init__(self, page): super().__init__(page) def get_expected_page_title(self) -> str: - return "Redbox Copilot" + return "Redbox" def navigate_to_sign_in(self) -> "SignInPage": self.page.get_by_role("link", name="Sign in", exact=True).click() @@ -109,7 +109,7 @@ def navigate_to_sign_in(self) -> "SignInPage": class SignInPage(BasePage): def get_expected_page_title(self) -> str: - return "Sign in - Redbox Copilot" + return "Sign in - Redbox" @property def email(self) -> str: @@ -126,7 +126,7 @@ def continue_(self) -> "SignInLinkSentPage": class SignInLinkSentPage(BasePage): def get_expected_page_title(self) -> str: - return "Sign in - link sent - Redbox Copilot" + return "Sign in - link sent - Redbox" class SignInConfirmationPage(BasePage): @@ -135,7 +135,7 @@ def __init__(self, page, magic_link: URL): super().__init__(page) def get_expected_page_title(self) -> str: - return "Sign in - confirmation - Redbox Copilot" + return "Sign in - confirmation - Redbox" def navigate_to_documents_page(self) -> "DocumentsPage": self.page.get_by_role("button", name="Start", exact=True).click() @@ -144,7 +144,7 @@ def navigate_to_documents_page(self) -> "DocumentsPage": class HomePage(SignedInBasePage): def get_expected_page_title(self) -> str: - return "Redbox Copilot" + return "Redbox" class DocumentRow(NamedTuple): @@ -154,7 +154,7 @@ class DocumentRow(NamedTuple): class DocumentsPage(SignedInBasePage): def get_expected_page_title(self) -> str: - return "Documents - Redbox Copilot" + return "Documents - Redbox" def delete_latest_document(self) -> "DocumentDeletePage": self.page.get_by_role("button", name="Remove").first.click() @@ -171,7 +171,7 @@ def get_all_document_rows(self) -> list[DocumentRow]: class DocumentDeletePage(SignedInBasePage): def get_expected_page_title(self) -> str: - return "Remove document - Redbox Copilot" + return "Remove document - Redbox" def confirm_deletion(self) -> "DocumentsPage": self.page.get_by_role("button", name="Remove").click() @@ -180,7 +180,7 @@ def confirm_deletion(self) -> "DocumentsPage": class DocumentUploadPage(SignedInBasePage): def get_expected_page_title(self) -> str: - return "Upload a document - Redbox Copilot" + return "Upload a document - Redbox" def upload_document(self, upload_file: Path) -> DocumentsPage: self.get_file_chooser_by_label().set_files(upload_file) @@ -200,7 +200,7 @@ class FeedbackType(Enum): class ChatsPage(SignedInBasePage): def get_expected_page_title(self) -> str: - return "Chats - Redbox Copilot" + return "Chats - Redbox" @property def write_message(self) -> str: @@ -228,17 +228,17 @@ def give_feedback(self, feedback: FeedbackType): class PrivacyPage(BasePage): def get_expected_page_title(self) -> str: - return "Privacy notice - Redbox Copilot" + return "Privacy notice - Redbox" class AccessibilityPage(BasePage): def get_expected_page_title(self) -> str: - return "Accessibility statement - Redbox Copilot" + return "Accessibility statement - Redbox" class SupportPage(BasePage): def get_expected_page_title(self) -> str: - return "Support - Redbox Copilot" + return "Support - Redbox" def batched(iterable, n): diff --git a/tests/pages.py b/tests/pages.py index 3ce210f69..6fbafa25a 100644 --- a/tests/pages.py +++ b/tests/pages.py @@ -113,7 +113,7 @@ def __init__(self, page, base_url: URL): @property def expected_page_title(self) -> str: - return "Redbox Copilot" + return "Redbox" def navigate_to_sign_in(self) -> "SignInPage": self.page.get_by_role("link", name="Sign in", exact=True).click() @@ -123,7 +123,7 @@ def navigate_to_sign_in(self) -> "SignInPage": class SignInPage(BasePage): @property def expected_page_title(self) -> str: - return "Sign in - Redbox Copilot" + return "Sign in - Redbox" @property def email(self) -> str: @@ -141,11 +141,11 @@ def continue_(self) -> "SignInLinkSentPage": class SignInLinkSentPage(BasePage): @property def expected_page_title(self) -> str: - return "Sign in - link sent - Redbox Copilot" + return "Sign in - link sent - Redbox" class SignInConfirmationPage(BasePage): - EXPECTED_TITLE = "Sign in - confirmation - Redbox Copilot" + EXPECTED_TITLE = "Sign in - confirmation - Redbox" def __init__(self, page, magic_link: URL): page.goto(str(magic_link)) @@ -174,13 +174,13 @@ def _where_are_we(page: Page) -> Union["DocumentsPage", "MyDetailsPage"]: class HomePage(SignedInBasePage): @property def expected_page_title(self) -> str: - return "Redbox Copilot" + return "Redbox" class MyDetailsPage(SignedInBasePage): @property def expected_page_title(self) -> str: - return "My details - Redbox Copilot" + return "My details - Redbox" @property def grade(self) -> str: @@ -220,7 +220,7 @@ class DocumentRow: class DocumentsPage(SignedInBasePage): @property def expected_page_title(self) -> str: - return "Documents - Redbox Copilot" + return "Documents - Redbox" def navigate_to_upload(self) -> "DocumentUploadPage": self.page.get_by_role("button", name="Add document").click() @@ -259,7 +259,7 @@ def wait_for_documents_to_complete(self, retry_interval: int = 5, max_tries: int class DocumentUploadPage(SignedInBasePage): @property def expected_page_title(self) -> str: - return "Upload a document - Redbox Copilot" + return "Upload a document - Redbox" def upload_documents(self, upload_files: Sequence[Path]) -> DocumentsPage: self.get_file_chooser_by_label().set_files(upload_files) @@ -275,7 +275,7 @@ def get_file_chooser_by_label(self): class DocumentDeletePage(SignedInBasePage): @property def expected_page_title(self) -> str: - return "Remove document - Redbox Copilot" + return "Remove document - Redbox" def confirm_deletion(self) -> "DocumentsPage": self.page.get_by_role("button", name="Remove").click() @@ -300,7 +300,7 @@ def navigate_to_citations(self) -> "CitationsPage": class ChatsPage(SignedInBasePage): @property def expected_page_title(self) -> str: - return "Chats - Redbox Copilot" + return "Chats - Redbox" @property def write_message(self) -> str: @@ -372,7 +372,7 @@ def wait_for_latest_message(self, role="Redbox") -> ChatMessage: class CitationsPage(SignedInBasePage): @property def expected_page_title(self) -> str: - return "Citations - Redbox Copilot" + return "Citations - Redbox" def back_to_chat(self) -> ChatsPage: self.page.get_by_role("link", name="Back to chat", exact=True).click() @@ -382,16 +382,16 @@ def back_to_chat(self) -> ChatsPage: class PrivacyPage(BasePage): @property def expected_page_title(self) -> str: - return "Privacy notice - Redbox Copilot" + return "Privacy notice - Redbox" class AccessibilityPage(BasePage): @property def expected_page_title(self) -> str: - return "Accessibility statement - Redbox Copilot" + return "Accessibility statement - Redbox" class SupportPage(BasePage): @property def expected_page_title(self) -> str: - return "Support - Redbox Copilot" + return "Support - Redbox" From caa142abc84745ec408c9b90a3e008fa47901a28 Mon Sep 17 00:00:00 2001 From: Simon Brunning Date: Mon, 1 Jul 2024 16:10:33 +0100 Subject: [PATCH 2/2] Update name from "Redbox Copilot" to "Redbox" in non user-facing files. --- CODE_OF_CONDUCT.md | 2 +- README.md | 8 ++++---- docs/contributing.md | 10 +++++----- docs/index.md | 6 +++--- 4 files changed, 13 insertions(+), 13 deletions(-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 330fb1af8..07069256c 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -1,4 +1,4 @@ -# Code of Conduct - Redbox Copilot +# Code of Conduct - Redbox ## Our Pledge diff --git a/README.md b/README.md index f3609b93f..133720843 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# 📮 Redbox Copilot +# 📮 Redbox > [!IMPORTANT] > Incubation Project: This project is an incubation project; as such, we DON’T recommend using it in any critical use case. This project is in active development and a work in progress. This project may one day Graduate, in which case this disclaimer will be removed. @@ -6,10 +6,10 @@ > [!NOTE] > The original streamlit-app has moved to its own repository https://github.com/i-dot-ai/redbox-copilot-streamlit. -Redbox Copilot is a retrieval augmented generation (RAG) app that uses GenAI to chat with and summarise civil service documents. It's designed to handle a variety of administrative sources, such as letters, briefings, minutes, and speech transcripts. +Redbox is a retrieval augmented generation (RAG) app that uses GenAI to chat with and summarise civil service documents. It's designed to handle a variety of administrative sources, such as letters, briefings, minutes, and speech transcripts. -- **Better retrieval**. Redbox Copilot increases organisational memory by indexing documents -- **Faster, accurate summarisation**. Redbox Copilot can summarise reports read months ago, supplement them with current work, and produce a first draft that lets civil servants focus on what they do best +- **Better retrieval**. Redbox increases organisational memory by indexing documents +- **Faster, accurate summarisation**. Redbox can summarise reports read months ago, supplement them with current work, and produce a first draft that lets civil servants focus on what they do best https://github.com/i-dot-ai/redbox-copilot/assets/8233643/e7984242-1403-4c93-9e68-03b3f065b38d diff --git a/docs/contributing.md b/docs/contributing.md index b894fbe80..2e2897de8 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -1,4 +1,4 @@ -# Contributing to Redbox Copilot +# Contributing to Redbox First off, thanks for taking the time to contribute! ❤️ @@ -13,7 +13,7 @@ All types of contributions are encouraged and valued. See the [Table of Contents ## Table of Contents -- [Contributing to Redbox Copilot](#contributing-to-redbox-copilot) +- [Contributing to Redbox](#contributing-to-redbox-copilot) - [Code of Conduct](#code-of-conduct) - [I Have a Question](#i-have-a-question) - [I Want To Contribute](#i-want-to-contribute) @@ -29,7 +29,7 @@ All types of contributions are encouraged and valued. See the [Table of Contents ## Code of Conduct This project and everyone participating in it is governed by the -[Redbox Copilot Code of Conduct](https://github.com/i-dot-ai/redbox-copilot/blob/main/CODE_OF_CONDUCT.md). +[Redbox Code of Conduct](https://github.com/i-dot-ai/redbox-copilot/blob/main/CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to i-dot-ai-enquiries@cabinetoffice.gov.uk @@ -92,7 +92,7 @@ Once it's filed: ### Suggesting Enhancements -This section guides you through submitting an enhancement suggestion for Redbox Copilot, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions. +This section guides you through submitting an enhancement suggestion for Redbox, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions. #### Before Submitting an Enhancement @@ -110,7 +110,7 @@ Enhancement suggestions are tracked as [GitHub issues](https://github.com/i-dot- - Provide a **step-by-step description of the suggested enhancement** in as many details as possible. - **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you. - You may want to **include screenshots and animated GIFs** which help you demonstrate the steps or point out the part which the suggestion is related to. You can use [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) on Linux. -- **Explain why this enhancement would be useful** to most Redbox Copilot users. You may also want to point out the other projects that solved it better and which could serve as inspiration. +- **Explain why this enhancement would be useful** to most Redbox users. You may also want to point out the other projects that solved it better and which could serve as inspiration. ## Styleguides diff --git a/docs/index.md b/docs/index.md index e78881175..093401ed4 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,9 +1,9 @@ # Welcome to Redbox -Redbox Copilot is a retrieval augmented generation (RAG) app that uses GenAI to chat with and summarise civil service documents. It's designed to handle a variety of administrative sources, such as letters, briefings, minutes, and speech transcripts. +Redbox is a retrieval augmented generation (RAG) app that uses GenAI to chat with and summarise civil service documents. It's designed to handle a variety of administrative sources, such as letters, briefings, minutes, and speech transcripts. -- **Better retrieval**. Redbox Copilot increases organisational memory by indexing documents -- **Faster, accurate summarisation**. Redbox Copilot can summarise reports read months ago, supplement them with current work, and produce a first draft that lets civil servants focus on what they do best +- **Better retrieval**. Redbox increases organisational memory by indexing documents +- **Faster, accurate summarisation**. Redbox can summarise reports read months ago, supplement them with current work, and produce a first draft that lets civil servants focus on what they do best !!! info "Version" This documentation is for Redbox version: