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

Developer docs need updated #997

Open
1 task done
etsauer opened this issue May 19, 2023 · 1 comment
Open
1 task done

Developer docs need updated #997

etsauer opened this issue May 19, 2023 · 1 comment
Labels
kind/feature Categorizes issue or PR as related to a new feature. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one.

Comments

@etsauer
Copy link
Collaborator

etsauer commented May 19, 2023

Feature description

Keeping track of developer docs updates that are needed:

  • https://pelorus.readthedocs.io/en/v2.0.9/Development/#updating-the-chart-versions says to use ./scripts/bump-version for chart version updates, but now we have make rc-release instead.
  • We should consolidate developer setup into a single section rather than distributing bits and pieces throughout the doc.
  • Some of the developer setup simply isn't covered in this doc. For example:
    • there are packages you need installed BEFORE make dev-env will work. They include gcc and python3-devel but there are probably others we are missing
  • In general, very few of the make commands and when to use them are covered in this doc
  • Need to better document a process of testing operator changes

How this will help you

This will lower the barrier to community contributors wanting to help make updates to Pelorus, including me.

Feature priority

⌛ It will greatly improve my experience using Pelorus

Code of Conduct

  • I agree to follow Pelorus's Code of Conduct
@etsauer etsauer added kind/feature Categorizes issue or PR as related to a new feature. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels May 19, 2023
@mateusoliveira43
Copy link
Collaborator

About the developer setup, I already had trouble as well #756

I think this will never be truly solved as we accept any Linux and MacOs systems

I believe the solution would be to have a container image launch the developer environment, like I do in some personal projects. Example https://github.com/mateusoliveira43/python-project-template#docker

@mateusoliveira43 mateusoliveira43 self-assigned this May 31, 2023
@mateusoliveira43 mateusoliveira43 removed their assignment Jul 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/feature Categorizes issue or PR as related to a new feature. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one.
Projects
None yet
Development

No branches or pull requests

2 participants