A concise title for the service that fits the pattern identified and in use across all services.
Less than 500 words that describe what a service delivers, providing an informative, descriptive, and comprehensive overview of the value a service brings to the table.
Links to any documentation for the service, including any machine-readable definitions like an OpenAPI definition or Postman Collection, as well as any human-readable documentation generated from definitions, or handcrafted and published as part of the repository.
An outline of what other services, tooling, and libraries needed to make a service operate, providing a complete list of EVERYTHING required to work properly.
A step by step outline from start to finish of what is needed to setup and operate a service, providing as much detail as you possibly for any new user to be able to get up and running with a service.
Providing details and instructions for mocking, monitoring, and testing a service, including any services or tools used, as well as links or reports that are part of active testing for a service.
An outline of all configuration and environmental variables that can be adjusted or customized as part of service operations, including as much detail on default values, or options that would produce different known results for a service.
An outline broken into three groups, 1) planned additions, 2) current issues, 3) changelog. Providing a simple, descriptive outline of the roadmap for a service with links to any GitHub issues that support what the plan is for a service.
A list of relevant discussions regarding a service with title, details, and any links to relevant GitHub issues, blog posts, or other updates that tell a story behind the work that has gone into a service.
The name, title, email, phone, or other relevant contact information for the owner, or owners of a service providing anyone with the information they need to reach out to the person who is responsible for a service.
| Project | Note |
|---|---|
| Project A | Notes on Project A |
| Project B | Notes on Project B |
| Project C | Notes on Project C |
| Project D | Notes on Project D |
| Project | Note |
|---|---|
| Tutorial on Python | The Python Tutorial |
| Hadoop Tutorial | The “Getting Started with Hadoop” Tutorial |
| Data Science Tutorial | A Complete Tutorial to Learn Data Science with Python from Scratch |
| Tutorial on Redis | Redis Tutorial |
Tutorial on Hadoop: Apache Hadoop - Tutorial
print("Hello, World!")