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 Documentation for Running the Project Locally #301

Closed
divyansh-prks opened this issue Feb 10, 2025 · 3 comments
Closed

[Docs] : Add Documentation for Running the Project Locally #301

divyansh-prks opened this issue Feb 10, 2025 · 3 comments

Comments

@divyansh-prks
Copy link
Contributor

Reason/Context

There is not any proper Documentation for setting up microcks.io project locally for new contributers .
If we add proper instructions for installation of local setup step by step it will be easier for contributer to contribute in the project

Description

Image

Implementation ideas

No response

@yada
Copy link
Member

yada commented Feb 10, 2025

@divyansh-prks please check #286 @krishi-agrawal already on it, maybe you join your forces 🙌

@divyansh-prks
Copy link
Contributor Author

divyansh-prks commented Feb 11, 2025

@yada I Have a suggestion whether you like it or not , what if we create a seperate website for All the guidance listed over there and All the contributing guidance ,resources listed over there of our all seven projects that we are currently working on with all local setup commands like this .
whose url can be like-> https://docs.microcks.io/project/contributing

Image

@yada
Copy link
Member

yada commented Feb 11, 2025

Thanks for the suggestion, @divyansh-prks, but I feel it will be overkill. We will have one mentee per project, and information related to each project will be included in the onboarding: project issue(s). Plus, this information will not be of use (most of it) outside of the related projects! On the other hand, information like this #286 is, yes, very useful and can be stored in the Microcks website repo.

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