Velero Development Guidelines

Oct 13, 2025 by talynt.org 37 views

Introduction

As a developer, it's essential to have access to accurate and up-to-date documentation to ensure a smooth development process. However, in the case of Velero's documentation, there seems to be a discrepancy between the provided information and the actual requirements. In this article, we'll delve into the issue of deprecated requirements listed on the Development page and explore the necessary steps to rectify the situation.

The Issue

The issue at hand is related to the Documentation under the Development heading, which mentions generating the clientset. However, according to this issue, this no longer happens as part of the make update step. This confusion was experienced by a community member who stumbled upon an old issue from @carlisia from ~5 years ago.

Expected Outcome

As a developer, one would expect the documentation to be up-to-date and accurate. In this case, the expected outcome is that the Development page in the documentation should reflect the current requirements and guidelines for Velero development. Unfortunately, this is not the case, and the page still lists deprecated requirements.

Impact on Development

The impact of this issue on development is significant. As a new developer to Velero, it's essential to have access to accurate and up-to-date information to ensure a smooth development process. The lack of formal development guidelines in the documentation can lead to confusion and frustration, ultimately affecting the overall quality of the project.

Community Involvement

To address this issue, the Velero community is invited to participate in voting on the issue. By using the "reaction smiley face" up to the right of the comment, community members can vote on the importance of fixing this bug. The project's top voted issues listed here provide a clear indication of the community's priorities.

How to Vote

To vote on this issue, follow these simple steps:

Go to the issue page: https://github.com/vmware-tanzu/velero/issues/2607
Click on the "reaction smiley face" up to the right of the comment
Choose one of the following reactions:
- :+1: for "I would like to see this bug fixed as soon as possible"
- :-1: for "There are more important bugs to focus on right now"

Conclusion

In conclusion, the issue of deprecated requirements listed on the Development page in Velero's documentation is a significant concern that affects the development process. By involving the community in voting on this issue, we can ensure that the documentation is updated to reflect the current requirements and guidelines for Velero development. Let's work together to make Velero's documentation the best it can be!

Recommendations

To address this issue, we recommend the following:

Update the Development page in the documentation to reflect the current requirements and guidelines for Velero development.
Provide formal development guidelines in the documentation to ensure that developers have access to accurate and up-to-date information.
Encourage community involvement in voting on issues to ensure that the community's priorities are reflected in the project's development.

Future Development

In the future, it's essential to maintain accurate and up-to-date documentation to ensure a smooth development process. By involving the community in the development process and providing regular updates, we can ensure that Velero's documentation remains the best it can be.

Velero Development Guidelines

While the Development page in the documentation is a good starting point, it's essential to provide formal development guidelines to ensure that developers have access to accurate and up-to-date information. Some potential guidelines to include are:

Code Style: Provide guidelines on code style, including indentation, naming conventions, and commenting.
Testing: Provide guidelines on testing, including unit testing, integration testing, and end-to-end testing.
Deployment: Provide guidelines on deployment, including containerization, orchestration, and scaling.
Security: Provide guidelines on security, including authentication, authorization, and data encryption.

By providing formal development guidelines, we can ensure that Velero's documentation is comprehensive and accurate, making it easier for developers to contribute to the project.

Conclusion

Introduction

As a developer, it's essential to have access to accurate and up-to-date documentation to ensure a smooth development process. However, in the case of Velero's documentation, there seems to be a discrepancy between the provided information and the actual requirements. In this article, we'll address some of the frequently asked questions (FAQs) related to Velero's documentation and provide clarification on the current state of the project.

Q: What is the current state of Velero's documentation?

A: Velero's documentation is currently undergoing updates to reflect the current requirements and guidelines for Velero development. However, some sections of the documentation may still contain deprecated information.

Q: Why is the Development page in the documentation outdated?

A: The Development page in the documentation was not updated to reflect the current requirements and guidelines for Velero development. This was due to a lack of formal development guidelines in the documentation.

Q: How can I contribute to Velero's documentation?

A: You can contribute to Velero's documentation by:

Reporting any outdated or incorrect information to the Velero community.
Providing feedback on the current documentation.
Helping to update the documentation to reflect the current requirements and guidelines for Velero development.

Q: What are the benefits of having up-to-date documentation?

A: Having up-to-date documentation provides several benefits, including:

Improved development process: Accurate and up-to-date documentation ensures a smooth development process.
Increased community involvement: Up-to-date documentation encourages community involvement and participation.
Better project management: Accurate documentation helps project managers to make informed decisions.

Q: How can I get involved in the Velero community?

A: You can get involved in the Velero community by:

Joining the Velero Slack channel: Join the Velero Slack channel to connect with other developers and community members.
Participating in GitHub issues: Participate in GitHub issues to help resolve bugs and provide feedback.
Contributing to the documentation: Contribute to the documentation by providing feedback and helping to update the documentation.

Q: What are the next steps for Velero's documentation?

A: The next steps for Velero's documentation include:

Updating the Development page: Update the Development page in the documentation to reflect the current requirements and guidelines for Velero development.
Providing formal development guidelines: Provide formal development guidelines to ensure that developers have access to accurate and up-to-date information.
Encouraging community involvement: Encourage community involvement in the development process and provide regular updates.

Q: How can I stay up-to-date with the latest developments in Velero?

A: You can stay up-to-date with the latest developments in Velero by:

Following the Velero blog: Follow the Velero blog to stay informed about the latest developments and updates.
Joining the Velero Slack channel: Join the Velero Slack channel to connect with other developers and community members.
Participating in GitHub issues: Participate in GitHub issues to help resolve bugs and provide feedback.

Conclusion

In conclusion, Velero's documentation is currently undergoing updates to reflect the current requirements and guidelines for Velero development. By getting involved in the Velero community and contributing to the documentation, you can help ensure that Velero's documentation is the best it can be. Let's work together to make Velero's documentation the best it can be!