Skip to content

[DX] Remove outdated info from dev-docs #12360

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.

Sign up for GitHub

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

Open
Luke-Oldenburg wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[DX] Remove outdated info from dev-docs #12360

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions dev-docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# All About HCB

HCB is a tool for hackers to hack on the real world, like GitHub, but for building with atoms and people, not bits and cycles. Thank you so much for contributing to the HCB database.
HCB is a tool for hackers to hack on the real world, like GitHub, but for building with atoms and people, not bits and cycles. Thank you so much for contributing to the HCB codebase.

## Table of Contents
- [Home](#)
Expand Down Expand Up @@ -93,7 +93,7 @@ HCB's operations team perform their work through the admin dashboard on HCB and

### Deployment & Monitoring

HCB is deployed on [Heroku](https://www.heroku.com/). We have two dynos, one for Rails and one for our [Sidekiq](https://github.com/sidekiq/sidekiq) workers. We handle errors using [AppSignal](https://www.appsignal.com/). We also run [status.hackclub.com](https://status.hackclub.com/) using [Checkly](https://www.checklyhq.com/).
HCB is deployed on [Hetzner](https://www.hetzner.com/). We have two dynos, one for Rails and one for our [Sidekiq](https://github.com/sidekiq/sidekiq) workers. We handle errors using [AppSignal](https://www.appsignal.com/). We also run [status.hackclub.com](https://status.hackclub.com/) using [Checkly](https://www.checklyhq.com/).

***

Expand Down
6 changes: 1 addition & 5 deletions dev-docs/development.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Development

We recommend using Docker to get an instance running locally. It should work out-of-the-box and is how most contributors work on HCB.
We recommend using GitHub Codespaces to get an instance running. It should work out-of-the-box and is how most contributors work on HCB.

- [Running HCB locally](#running-hcb-locally)
- [Quickstart with GitHub Codespaces](#quickstart-with-github-codespaces)
Expand Down Expand Up @@ -165,10 +165,6 @@ HCB has a limited set of tests created using [RSpec](https://rspec.info/). Run t
bundle exec rspec
```

### Staging access

All PRs are deployed in a staging enviroment using Heroku. Login using the email `staging@bank.engineering`. Visit [`#hcb-staging`](https://hackclub.slack.com/archives/C07KLU4B0M7) on the [Hack Club Slack](https://hackclub.com/slack) for the code.

## Credentials

External contributors should provide credentials via a [`.env.development`](/.env.development) file [(view example)](/.env.development.example). Developers using the `devcontainer` setup (eg. in GitHub Codespaces), will need to rebuild the container after modifying the [`.env.development`](/.env.development) file to pull in the new variables.
Expand Down