[DT-1048] Remove outdated Brew instructions #2732
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
fboulnois
requested review from
rushtong and
rjohanek
and removed request for
a team
fboulnois
commented
Nov 19, 2024
| 3. [jq](https://stedolan.github.io/jq/) is a command line JSON processing tool. | ||
| 4. [Docker](https://www.docker.com/) is a tool to deliver software in packages called containers. Docker for MacOS also includes [Kubernetes](https://kubernetes.io/), which deploys groups of containers together in clusters. | ||
| 5. [Vault](https://www.vaultproject.io/) is an encrypted database used to store many of the team's secrets such as keys and passwords. |
There was a problem hiding this comment.
No longer relevant for DUOS
fboulnois
commented
Nov 19, 2024
| 6. [Volta](https://volta.sh/) is a tool to manage installations of [`nodejs`](https://nodejs.org/en/) and its dependencies. The DUOS user interface is built using `nodejs`. | ||
| 7. [Google Cloud SDK](https://cloud.google.com/sdk) is a command-line interface to Google Cloud services. Once it is installed, you'll need to allow auth access and configure Docker to connect to the appropriate Google Cloud endpoint when necessary, which is done with the configuration below. | ||
| 8. [IntelliJ IDEA](https://www.jetbrains.com/idea/) is an integrated development environment (IDE) for Java. There are two versions available: **Ultimate** (paid) and **Community** (open-source). We recommend the Ultimate Edition to Broad employees for its database navigation capabilities. Alternatively, the Community Edition has all the features needed for development, and this version can be installed by switching `intellij-idea` with `intellij-idea-ce` in the Brewfile. | ||
| 9. [Postgres](https://www.postgresql.org/) is an advanced open-source database. |
There was a problem hiding this comment.
We use Docker Postgres instances instead
fboulnois
commented
Nov 19, 2024
| @@ -33,7 +33,6 @@ Ensure that you have access to the required team resources. If you encounter a p | |||
| DUOS and [Terra](https://terra.bio/) use [Sam](https://github.com/broadinstitute/sam) to abstract identity and access management. To gain access to these services, first create a non-Broad email address through Gmail. This email address will specifically be used for development purposes in our non-prod environments. Next, to register as a new user, click the `Sign in with Google` button in each of the environments with the newly created email address and follow the prompts: | |||
|
|
|||
| - [Dev](https://bvdp-saturn-dev.appspot.com/) | |||
| - [Alpha](https://bvdp-saturn-alpha.appspot.com/) | |||
There was a problem hiding this comment.
Environment no longer exists
fboulnois
commented
Nov 19, 2024
| @@ -53,29 +52,18 @@ brew bundle --no-lock install | |||
| Running the `brew` command above will install the following tools: | |||
|
|
|||
| 1. [Git](https://git-scm.com/) is a version control tool for tracking changes in projects and code. | |||
| 2. [git-secrets](https://github.com/awslabs/git-secrets) prevents developers from committing passwords and secrets to git. | |||
There was a problem hiding this comment.
Automatically installed by BITS
fboulnois
changed the title
s-rubenstein
approved these changes
Nov 19, 2024
fboulnois
commented
Nov 19, 2024
| @@ -33,7 +33,6 @@ Ensure that you have access to the required team resources. If you encounter a p | |||
| DUOS and [Terra](https://terra.bio/) use [Sam](https://github.com/broadinstitute/sam) to abstract identity and access management. To gain access to these services, first create a non-Broad email address through Gmail. This email address will specifically be used for development purposes in our non-prod environments. Next, to register as a new user, click the `Sign in with Google` button in each of the environments with the newly created email address and follow the prompts: | |||
There was a problem hiding this comment.
As a follow-up, we can think of a single Data Team getting-started.md in the future. My goal for such a document is that a developer has their environment set up so that they can start developing, which is upstream from running the service locally.
rushtong
approved these changes
Nov 19, 2024
| @@ -88,7 +76,7 @@ volta setup && volta install ${NODE_VERSION} | |||
|
|
|||
| ## 6. Create GitHub token | |||
|
|
|||
| The GitHub token verifies team permissions. This token is necessary for the next step, [Login to Vault](#9-login-to-vault). To create a token: | |||
| The GitHub token verifies team permissions. To create a token: | |||
There was a problem hiding this comment.
I think the token is unnecessary, the only need for it that I remember was for vault access. Mine has expired and I haven't needed to regenerate one since.
There was a problem hiding this comment.
It is (rarely) used for some GitHub tasks, such as launching a GitHub Action from the command line and clearing the GitHub cache.
rjohanek
approved these changes
Nov 20, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Addresses
https://broadworkbench.atlassian.net/browse/DT-1048
Summary
Remove outdated Brew instructions that are no longer relevant for the team.
Have you read Terra's Contributing Guide lately? If not, do that first.