docs: add Cloud Native Landscape submission guide#11
Conversation
Step-by-step guide for listing KubeOrch on the CNCF landscape, including category recommendation, YAML entry template, logo requirements, and LFX Insights registration. Closes #4 Signed-off-by: Mohit Nagaraj <mohitnagaraj20@gmail.com>
mohit-nagaraj
requested review from
Kshitijknk07 and
Naman-B-Parlecha
as code owners
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request introduces a new documentation file to streamline the process of listing the KubeOrch project on the CNCF Cloud Native Landscape. It aims to provide clear, step-by-step instructions for maintainers to prepare and submit the project's entry, ensuring compliance with landscape requirements and facilitating its visibility within the cloud-native ecosystem. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces a comprehensive guide for submitting the KubeOrch project to the CNCF Cloud Native Landscape. The documentation is well-structured and provides clear, step-by-step instructions. My review focuses on improving the usability and consistency of the guide. I've suggested converting plain URLs into clickable Markdown links and aligning the repository URL in the sample pull request description with the one specified in the landscape.yml configuration. These changes will make the guide easier to follow and help prevent potential issues during the landscape submission process.
|
|
||
| ### 1. Fork the Landscape Repository | ||
|
|
||
| Fork https://github.com/cncf/landscape |
There was a problem hiding this comment.
For better readability and usability, it's recommended to format the URL as a Markdown link. This makes it clickable directly from rendered Markdown views.
| Fork https://github.com/cncf/landscape | |
| Fork [cncf/landscape](https://github.com/cncf/landscape) |
| Adding KubeOrch, a visual Kubernetes workflow orchestrator. | ||
|
|
||
| - Website: https://docs.kubeorch.dev | ||
| - GitHub: https://github.com/KubeOrch |
There was a problem hiding this comment.
To maintain consistency with the landscape.yml entry for repo_url, it's better to use the main repository URL here instead of the organization URL. This avoids potential confusion during the review of the landscape pull request.
| - GitHub: https://github.com/KubeOrch | |
| - GitHub: https://github.com/KubeOrch/core |
|
|
||
| ## Also Register on LFX Insights | ||
|
|
||
| 1. Go to https://insights.lfx.linuxfoundation.org/ |
There was a problem hiding this comment.
For better usability, this URL should be a clickable Markdown link, making it easier for users to navigate to the site.
| 1. Go to https://insights.lfx.linuxfoundation.org/ | |
| 1. Go to [LFX Insights](https://insights.lfx.linuxfoundation.org/) |
1 participant
Summary
LANDSCAPE_SUBMISSION.mdwith complete instructions for CNCF landscape listingRelated Issue
Closes #4
Action Required
A maintainer needs to prepare the SVG logo and submit the PR to cncf/landscape.
Test plan