Skip to content

Commit

Permalink
Merge pull request #753 from i-dot-ai/feature/missing-redbox-copilot-…
Browse files Browse the repository at this point in the history
…renames

Changed remaining references to redbox-copilot to just redbox
  • Loading branch information
252afh authored Jul 17, 2024
2 parents e71ac72 + 2351309 commit 904c58b
Show file tree
Hide file tree
Showing 14 changed files with 450 additions and 449 deletions.
2 changes: 1 addition & 1 deletion .env.django
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ ENVIRONMENT=LOCAL
POSTGRES_USER=redbox-core
POSTGRES_DB=redbox-core
POSTGRES_PASSWORD=insecure
CONTACT_EMAIL=redbox-copilot@cabinetoffice.gov.uk
CONTACT_EMAIL=redbox-support@cabinetoffice.gov.uk
POSTGRES_HOST=db
CORE_API_HOST=core-api
CORE_API_PORT=5002
Expand Down
2 changes: 1 addition & 1 deletion .env.example
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ ENVIRONMENT=LOCAL
POSTGRES_USER=redbox-core
POSTGRES_DB=redbox-core
POSTGRES_PASSWORD=insecure
CONTACT_EMAIL=redbox-copilot@cabinetoffice.gov.uk
CONTACT_EMAIL=redbox-support@cabinetoffice.gov.uk
POSTGRES_HOST=db
CORE_API_HOST=core-api
CORE_API_PORT=5002
Expand Down
2 changes: 1 addition & 1 deletion .env.integration
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ ENVIRONMENT=INTEGRATION
POSTGRES_USER=redbox-core
POSTGRES_DB=redbox-core
POSTGRES_PASSWORD=insecure
CONTACT_EMAIL=redbox-copilot@cabinetoffice.gov.uk
CONTACT_EMAIL=redbox-support@cabinetoffice.gov.uk
POSTGRES_HOST=db
CORE_API_HOST=core-api
CORE_API_PORT=5002
Expand Down
2 changes: 1 addition & 1 deletion .env.test
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ ENVIRONMENT=LOCAL
POSTGRES_USER=redbox-core
POSTGRES_DB=redbox-core
POSTGRES_PASSWORD=insecure
CONTACT_EMAIL=redbox-copilot@cabinetoffice.gov.uk
CONTACT_EMAIL=redbox-support@cabinetoffice.gov.uk
POSTGRES_HOST=localhost
CORE_API_HOST=localhost
CORE_API_PORT=5002
Expand Down
838 changes: 419 additions & 419 deletions CHANGELOG.md

Large diffs are not rendered by default.

13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[![Integration Tests](https://github.com/i-dot-ai/redbox-copilot/actions/workflows/integration.yml/badge.svg?branch=main)](https://github.com/i-dot-ai/redbox-copilot/actions/workflows/integration.yml?query=branch%3Amain)
[![Integration Tests](https://github.com/i-dot-ai/redbox/actions/workflows/integration.yml/badge.svg?branch=main)](https://github.com/i-dot-ai/redbox/actions/workflows/integration.yml?query=branch%3Amain)

# 📮 Redbox

Expand All @@ -13,6 +13,7 @@ Redbox is a retrieval augmented generation (RAG) app that uses GenAI to chat wit
- **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

# Setup
Expand Down Expand Up @@ -53,7 +54,7 @@ For every microservice that we have written in python we define its dependencies
This means that our project is structured approximately like this:

```txt
redbox-copilot/
redbox/
├── django_app
│ ├── app/
│ ├── static/
Expand Down Expand Up @@ -183,16 +184,16 @@ On initial app setup you will need to run `poetry run python manage.py collectst

checkout the `main` branch of the following repos:

- https://github.com/i-dot-ai/redbox-copilot
- https://github.com/i-dot-ai/i-ai-core-infrastructure/
- https://github.com/i-dot-ai/redbox-copilot-infra-config
* https://github.com/i-dot-ai/redbox
* https://github.com/i-dot-ai/i-ai-core-infrastructure/
* https://github.com/i-dot-ai/redbox-copilot-infra-config

If, and only if, you want to deploy something other than HEAD then replace `var.image_tag` in `infrastructure/aws/ecs.tf` with the hash of the build you want deployed.

Now run the commands below remembering to replace ENVIRONMENT with `dev`, `preprod` or `prod`

```commandline
cd redbox-copilot
cd redbox
make tf_init
make tf_apply env=<ENVIRONMENT>
```
2 changes: 1 addition & 1 deletion django_app/redbox_app/asgi.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
ASGI config for redbox copilot project.
ASGI config for redbox project.
It exposes the ASGI callable as a module-level variable named ``application``.
Expand Down
6 changes: 3 additions & 3 deletions docs/DEVELOPER_SETUP.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

## Installing packages

Currently, we use [poetry](https://python-poetry.org/) to manage our python packages. The list of poetry groups and python packages we install can be found [here](https://github.com/i-dot-ai/redbox-copilot/blob/main/pyproject.toml) in `pyproject.toml`.
Currently, we use [poetry](https://python-poetry.org/) to manage our python packages. The list of poetry groups and python packages we install can be found [here](https://github.com/i-dot-ai/redbox/blob/main/pyproject.toml) in `pyproject.toml`.

Run the following to install the packages into a virtual environment poetry will create.

Expand Down Expand Up @@ -49,7 +49,7 @@ You will need to install `poppler` and `tesseract` to run the `worker`

## Building and running the project

To view all the build commands, check the `Makefile` that can be found [here](https://github.com/i-dot-ai/redbox-copilot/blob/main/Makefile).
To view all the build commands, check the `Makefile` that can be found [here](https://github.com/i-dot-ai/redbox/blob/main/Makefile).

The project currently consists of multiple docker images needed to run the project in its entirety. If you only need a subsection of the project running, for example if you're only editing the django app, you can run a subset of the images. The images currently in the project are:

Expand Down Expand Up @@ -92,7 +92,7 @@ Some parts of the project can be run independently for development, for example
docker compose up django-app
```

For any other commands available, check the `Makefile` [here](https://github.com/i-dot-ai/redbox-copilot/blob/main/Makefile).
For any other commands available, check the `Makefile` [here](https://github.com/i-dot-ai/redbox/blob/main/Makefile).

## How to run tests

Expand Down
2 changes: 1 addition & 1 deletion docs/architecture/adr/rag_evaluation.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ PR is the pull request that submitted the change, including information such as

Format:

- \[ADR in review]\(https://github.com/i-dot-ai/redbox-copilot/pull/330) 2024-05-13
- \[ADR in review]\(https://github.com/i-dot-ai/redbox/pull/330) 2024-05-13

<!-- - \[Status of ADR e.g. approved, amended, etc.\]\(URL of pull request\) YYYY-MM-DD -->

Expand Down
22 changes: 11 additions & 11 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ All types of contributions are encouraged and valued. See the [Table of Contents
<!-- omit in toc -->
## Table of Contents

- [Contributing to Redbox](#contributing-to-redbox-copilot)
- [Contributing to Redbox](#contributing-to-redbox)
- [Code of Conduct](#code-of-conduct)
- [I Have a Question](#i-have-a-question)
- [I Want To Contribute](#i-want-to-contribute)
Expand All @@ -29,20 +29,20 @@ 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 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/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


## I Have a Question

> If you want to ask a question, we assume that you have read the available [Documentation](https://github.com/i-dot-ai/redbox-copilot/tree/main/docs).
> If you want to ask a question, we assume that you have read the available [Documentation](https://github.com/i-dot-ai/redbox/tree/main/docs).
Before you ask a question, it is best to search for existing [Issues](https://github.com/i-dot-ai/redbox-copilot/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.
Before you ask a question, it is best to search for existing [Issues](https://github.com/i-dot-ai/redbox/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.

If you then still feel the need to ask a question and need clarification, we recommend the following:

- Open an [Issue](https://github.com/i-dot-ai/redbox-copilot/issues/new).
- Open an [Issue](https://github.com/i-dot-ai/redbox/issues/new).
- Provide as much context as you can about what you're running into.
- Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant.

Expand All @@ -60,8 +60,8 @@ We will then take care of the issue as soon as possible.
A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.

- Make sure that you are using the latest version.
- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](https://github.com/i-dot-ai/redbox-copilot/docs). If you are looking for support, you might want to check [this section](#i-have-a-question)).
- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/i-dot-ai/redbox-copilotissues?q=label%3Abug).
- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (Make sure that you have read the [documentation](https://github.com/i-dot-ai/redbox/docs). If you are looking for support, you might want to check [this section](#i-have-a-question)).
- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the [bug tracker](https://github.com/i-dot-ai/redbox/issues?q=label%3Abug).
- Also make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
- Collect information about the bug:
- Stack trace (Traceback)
Expand All @@ -78,7 +78,7 @@ A good bug report shouldn't leave others needing to chase you up for more inform
We use GitHub issues to track bugs and errors. If you run into an issue with the project:

- Open an [Issue](https://github.com/i-dot-ai/redbox-copilot/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
- Open an [Issue](https://github.com/i-dot-ai/redbox/issues/new). (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
- Explain the behavior you would expect and the actual behavior.
- Please provide as much context as possible and describe the *reproduction steps* that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
- Provide the information you collected in the previous section.
Expand All @@ -97,14 +97,14 @@ This section guides you through submitting an enhancement suggestion for Redbox,
#### Before Submitting an Enhancement

- Make sure that you are using the latest version.
- Read the [documentation](https://github.com/i-dot-ai/redbox-copilot/docs) carefully and find out if the functionality is already covered, maybe by an individual configuration.
- Perform a [search](https://github.com/i-dot-ai/redbox-copilot/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
- Read the [documentation](https://github.com/i-dot-ai/redbox/docs) carefully and find out if the functionality is already covered, maybe by an individual configuration.
- Perform a [search](https://github.com/i-dot-ai/redbox/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.

<!-- omit in toc -->
#### How Do I Submit a Good Enhancement Suggestion?

Enhancement suggestions are tracked as [GitHub issues](https://github.com/i-dot-ai/redbox-copilot/issues).
Enhancement suggestions are tracked as [GitHub issues](https://github.com/i-dot-ai/redbox/issues).

- Use a **clear and descriptive title** for the issue to identify the suggestion.
- Provide a **step-by-step description of the suggested enhancement** in as many details as possible.
Expand Down
2 changes: 1 addition & 1 deletion docs/frontends/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
This page lists the frontends that are available for the the Redbox backend.

- [Streamlit](https://github.com/i-dot-ai/redbox-copilot-streamlit) - A lightweight frontend, ideal for demos and quick prototyping.
- [Django](https://github.com/i-dot-ai/redbox-copilot/tree/main/django_app) - A full-featured frontend, ideal for production deployments.
- [Django](https://github.com/i-dot-ai/redbox/tree/main/django_app) - A full-featured frontend, ideal for production deployments.

## Motivations

Expand Down
2 changes: 1 addition & 1 deletion infrastructure/aws/postgres/data.tf
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ provider "aws" {
default_tags {
tags = {
"platform:environment" = terraform.workspace
"platform:repository" = "https://github.com/i-dot-ai/redbox-copilot"
"platform:repository" = "https://github.com/i-dot-ai/redbox"
"platform:security-level" = "base"
"platform:deployed-via" = "github"

Expand Down
2 changes: 1 addition & 1 deletion infrastructure/aws/provider.tf
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ provider "aws" {
default_tags {
tags = {
"platform:environment" = terraform.workspace
"platform:repository" = "https://github.com/i-dot-ai/redbox-copilot"
"platform:repository" = "https://github.com/i-dot-ai/redbox"
"platform:security-level" = "base"

Organisation = "co"
Expand Down
2 changes: 1 addition & 1 deletion infrastructure/aws/universal/provider.tf
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ provider "aws" {
default_tags {
tags = {
"platform:environment" = "prod"
"platform:repository" = "https://github.com/i-dot-ai/redbox-copilot"
"platform:repository" = "https://github.com/i-dot-ai/redbox"
"platform:security-level" = "base"

Organisation = "co"
Expand Down

0 comments on commit 904c58b

Please sign in to comment.