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

Update README with project information #152

Open
hasheddan opened this issue Apr 23, 2021 · 3 comments
Open

Update README with project information #152

hasheddan opened this issue Apr 23, 2021 · 3 comments
Assignees

Comments

@hasheddan
Copy link
Member

There should be information about the purpose of the project, how to use it, and any governance / licensing info.

@hasheddan hasheddan self-assigned this Apr 23, 2021
@nickgerace
Copy link

nickgerace commented Sep 1, 2021

Hey @hasheddan! (fancy seeing you here)

@StrongMonkey and I would love to customize what shows up for rancher/fleet. For instance, we would love to add a link to our homepage. Is there a recommended way to do this?

I'd be happy to help with the README from what we do. Thanks!

@hasheddan
Copy link
Member Author

Hey @nickgerace! Thanks for stopping by :) I am glad to hear that the site provides some use for y'all! Arbitrary information is not currently supported on the repo page, but that would be awesome to add. You can stick info in the CRD field descriptions to have them surface on the individual CRD pages, but I don't think that is quite what y'all are looking for. I imagine the best solution here would be something like what is described in #134

@nickgerace
Copy link

nickgerace commented Sep 1, 2021

That makes sense to me! We do something similar for Rust Cloud Native: though it's a static, pre-commit process using JSON to edit a markdown file: https://github.com/rust-cloud-native/rust-cloud-native.github.io/blob/f77c152c9d8f2e08005e6475a02cd4fc99a0cf75/src/main.rs

EDIT: ^ it's a bit hacky, I should add, but I believe it's a similar idea

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants