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

[Enhancement] Add Devcontainer for Documentation Development #123

Open
jayesh9747 opened this issue Jan 29, 2025 · 1 comment
Open

[Enhancement] Add Devcontainer for Documentation Development #123

jayesh9747 opened this issue Jan 29, 2025 · 1 comment

Comments

@jayesh9747
Copy link
Contributor

[Enhancement] Add Devcontainer for Documentation Development

Desired behavior

Currently, contributors need to manually set up the website documentation development environment on their local system. This setup process can be complex and time-consuming due to dependency management and platform-specific issues.

By providing a Devcontainer, contributors can quickly start developing in a pre-configured, standardized environment without worrying about system-specific configurations. This ensures:

  • A consistent development experience across all contributors.
  • No dependency conflicts or local setup issues.
  • Easy integration with VS Code Remote Containers and GitHub Codespaces.

Current behavior

  • Developers must manually install dependencies and configure their local environment.
  • Potential issues arise due to differences in OS, dependencies, and package versions.
  • Contributors may face challenges in getting started, leading to a higher onboarding time.

Value add

  • Simplifies onboarding for new contributors by removing manual setup steps.
  • Prevents dependency conflicts and ensures uniformity across development environments.
  • Enhances productivity by allowing developers to start contributing immediately.

Add labels

  • enhancement
  • documentation
  • developer-experience
@jayesh9747
Copy link
Contributor Author

@LiZhenCheng9527 l want to work on this issue. i will open PR very soon.

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

1 participant