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

Add Description for Cloud Native Buildpack and Tools with Repo Links in README #697

Open
4 tasks
Ayush9026 opened this issue Apr 21, 2024 · 1 comment
Open
4 tasks
Labels
type/enhancement Issue that requests a new feature or improvement.

Comments

@Ayush9026
Copy link

Summary

We need to enhance the README file for our Cloud Native Buildpack repository by adding detailed descriptions for the buildpack and all associated tools. This will provide users with a clear understanding of what each tool does and how it contributes to the Cloud Native Buildpack ecosystem.

What questions should this documentation answer?

  • The enhanced README will serve as a comprehensive guide for users, showcasing the Cloud Native Buildpack ecosystem and facilitating better understanding and utilization of the tools.

Who is the target audience for this documentation?

  • App Developer
  • Buildpack Author
  • Operator
  • Other:

Additional Information

  • Add a section in the README titled "Cloud Native Buildpack Description" with a brief overview of CNBs.

  • Include subsections for each tool, such as "Tool A Description," "Tool B Description," and so on.

  • Write concise descriptions for each tool, highlighting its purpose, functionalities, and contributions to the buildpack workflow.

  • Provide hyperlinks to the respective repositories of each tool for easy access and further exploration.

@Ayush9026 Ayush9026 added the type/enhancement Issue that requests a new feature or improvement. label Apr 21, 2024
@Ayush9026
Copy link
Author

/assign @Ayush9026

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/enhancement Issue that requests a new feature or improvement.
Projects
None yet
Development

No branches or pull requests

1 participant