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

[DOCS] Add a readme #4

Open
kkrishguptaa opened this issue Dec 26, 2023 · 6 comments
Open

[DOCS] Add a readme #4

kkrishguptaa opened this issue Dec 26, 2023 · 6 comments
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@kkrishguptaa
Copy link

I think it might be a good idea to add a README file which tells that this is the documentation repository of ksctl and it can link to the main repo

@dipankardas011
Copy link
Member

dipankardas011 commented Dec 29, 2023

@xkrishguptaa
Does this answer your question https://github.com/kubesimplify/ksctl?tab=readme-ov-file#repositories

@kkrishguptaa
Copy link
Author

I do get that but when someone lands of the repository, shouldn't they see a readme? A readme that tells them about the repo and about the project in brief linking to the main repo?

@dipankardas011
Copy link
Member

sure. then you can raise a PR for ksctl-docs and ksctl-cli :>

@dipankardas011
Copy link
Member

@xkrishguptaa you can work on the README 💚

@kkrishguptaa
Copy link
Author

Thank you for the assignment! Actually I'm having exams so I'll start this after 21st if that's alright :)

@dipankardas011 dipankardas011 added documentation Improvements or additions to documentation good first issue Good for newcomers labels Jan 23, 2024
@dipankardas011
Copy link
Member

@fi-krish are you still working on this issue?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants