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

Create a Beginners Guide for Cyclops #628

Open
aviralgarg05 opened this issue Oct 10, 2024 · 5 comments
Open

Create a Beginners Guide for Cyclops #628

aviralgarg05 opened this issue Oct 10, 2024 · 5 comments
Labels
documentation Improvements or additions to documentation

Comments

@aviralgarg05
Copy link

aviralgarg05 commented Oct 10, 2024

Is your feature request related to a problem? Please describe.
In this case, the frustration comes from the lack of comprehensive documentation, error-solving guides, and tutorials during the development of the Automatic Web App using Cyclops-UI with Kubernetes and Docker. The absence of detailed resources made it difficult to troubleshoot and efficiently deploy the application, leading to delays and confusion.

Describe the solution you'd like
To address these challenges, a guide will be created to provide a structured, beginner-friendly walkthrough for using Cyclops-UI with Kubernetes and Docker. It aims to save time by offering clear instructions, tips, and solutions to common issues, ensuring a smoother experience for developers who want to get up and running with Cyclops quickly.

Describe alternatives you've considered
N/A

Additional context
N/A

@petar-cvit petar-cvit added the documentation Improvements or additions to documentation label Oct 10, 2024
@petar-cvit
Copy link
Collaborator

Hey, @aviralgarg05, thanks for the issue. What roadblocks did you hit when setting up Cyclops? We try to keep the docs clear, but happy to add to it if needed

@aviralgarg05
Copy link
Author

I plan to create a comprehensive Cyclops-Beginner's-Guide to help others overcome the roadblocks I faced when setting up Cyclops. My goal is to address the common challenges that beginners encounter, like the lack of detailed, step-by-step instructions and real-world examples in the official documentation.

While the current documentation provides helpful resources, such as pre-configured templates and the cyctl CLI tool, it assumes users already have an advanced understanding of Kubernetes and Docker​(SREDevOps.org and Civo.com).
I intend to bridge this gap by offering a guide that simplifies the setup process, including clearer installation instructions, troubleshooting tips, and practical use cases.

This guide would be aimed at beginners looking for a more accessible introduction to Cyclops, helping them deploy applications and automate workflows with ease. Once I’ve built it, I hope it will serve as a useful supplement to the official documentation and assist new users in getting started with Cyclops more confidently.

@aviralgarg05
Copy link
Author

Pls provide updates to this issue

@petar-cvit
Copy link
Collaborator

@aviralgarg05 I'm not sure I understand what part of the docs you are missing. You can open a PR with the documentation you think might be good to add.

@aviralgarg05
Copy link
Author

I'll open the PR.
Still I would love to explain about what I aim to work on, is to provide a basic entire setup guide for a person as templates that he can just copy paste and begin working on the project.

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
Projects
None yet
Development

No branches or pull requests

2 participants