docker / getting-started

Contributing to Docker Getting Started

The Docker Getting Started repository (https://github.com/docker/getting-started/) is a valuable resource for newcomers to Docker. While it doesn’t have a formal contributing guide, here’s a breakdown of how you can contribute effectively:

Understanding the Project

The project primarily consists of:

  • JavaScript, HTML, CSS, and Shell scripts: These form the interactive tutorials and guides on the website.
  • Dockerfiles: Define the Docker images used in the tutorials.
  • Docker Compose: Used to orchestrate the containers for some tutorials.

Exploring the Codebase

  • src/ directory: Contains the main JavaScript codebase, which powers the tutorials and the website.
  • docs/ directory: Houses the Markdown files that make up the content of the tutorials.
  • Dockerfile: Defines the base image used for the Docker Getting Started tutorials.
  • docker-compose.yml: Configures the multi-container setup for tutorials.
  • package.json: Lists project dependencies and scripts for development, testing, and deployment.

Suggested Contribution Areas

  1. Improving Existing Tutorials:
  • Content: Review existing tutorials for accuracy, clarity, and completeness. Identify areas for improvement and suggest edits.
  • Code: Enhance code examples within tutorials to make them more concise and easier to understand.
  1. Creating New Tutorials:
  • Topic Selection: Identify a valuable Docker concept that’s not well-covered in the existing tutorials.
  • Content Structure: Craft a clear and well-organized tutorial, including code examples, explanations, and step-by-step instructions.
  1. Fixing Bugs:
  • Issue Tracker: Review the issue tracker on GitHub (https://github.com/docker/getting-started/issues) for reported bugs.
  • Reproducing Issues: Carefully reproduce the bug and gather relevant details.
  • Submitting Pull Requests: Propose a fix for the bug through a pull request, ensuring it doesn’t introduce new issues.
  1. Improving User Experience:
  • Website UI/UX: Suggest improvements to the website’s design and functionality, making it more user-friendly.
  • Accessibility: Ensure the website is accessible to users with disabilities.
  • Performance Optimization: Identify and address any performance bottlenecks on the website.

Contributing Process

  1. Fork the Repository: Create a fork of the Docker Getting Started repository on your GitHub account.
  2. Create a Branch: Create a new branch in your fork for your contribution.
  3. Make Changes: Make the necessary changes to the codebase or content.
  4. Commit Your Changes: Commit your changes with descriptive commit messages.
  5. Push to Your Fork: Push your branch to your fork on GitHub.
  6. Open a Pull Request: Open a pull request from your branch to the main repository.
  7. Respond to Feedback: Review feedback from the maintainers and address any requests for changes.

Testing Your Changes

Before submitting a pull request, ensure you have tested your changes thoroughly.

  • Run Tests: Use the npm test command to run the test suite for the project.
  • Local Development: Use npm run dev to start the development server and preview your changes locally.

Code Style

Maintain consistency with the project’s code style:

  • JavaScript: Follow standard JavaScript practices, including indentation, variable naming, and code comments.
  • Markdown: Use Markdown syntax for all documentation files.

Community Interaction

  • Join Discussions: Engage with the community on GitHub issues, forums, or other platforms.
  • Provide Support: Help others troubleshoot issues and answer their questions.

Your contributions, no matter how small, can help make Docker Getting Started an even better resource for the Docker community.