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

Improve contributing docs #168

Open
evamaxfield opened this issue Feb 17, 2022 · 2 comments
Open

Improve contributing docs #168

evamaxfield opened this issue Feb 17, 2022 · 2 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@evamaxfield
Copy link
Member

While helping onboard a new contributor a few issues encountered were:

  • "Deploying" is confusing when we are an infrastructure project. Thought this meant "deploying to google cloud" when it means "Releasing a new version of the backend"
  • Also thought that she was meant to deploy an infrastructure to contribute. Need to make this much more clear that it is entirely possible (and encouraged) to contribute to CDP without needing to deploy a dev infrastructure
@evamaxfield evamaxfield added documentation Improvements or additions to documentation enhancement New feature or request labels Feb 17, 2022
@isaacna
Copy link
Collaborator

isaacna commented Feb 18, 2022

Hm yeah I guess we do throw around "deploy" and "deployment" a lot which could be confusing. I'll see if I can make the wording more clear.

I'm not sure if this is mentioned in the docs clearly, but maybe we could further emphasize the cdp-backend is just a library and that deployments come from separate repos spawned using cookicutter as a template

@evamaxfield
Copy link
Member Author

Strong agree. These docs should very explicitly mention that to contribute to the backend you do not need a dev deployment. In some cases it helps but a larger majority of issues and features can be done without dev infra.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants