Learn
A public site to learn about Netdata built on Docusaurus 2
Overview
Netdata Learn is an innovative documentation site developed on the Docusaurus framework. This repository serves as a mirrored code base that simplifies the management and contribution of documentation for the Netdata project. Offering a straightforward architecture, it provides users and contributors with an efficient way to access and modify documentation, promoting seamless collaboration and effective content delivery.
What stands out is the automated deployment process via Netlify, ensuring that the latest updates are live without much hassle. The infrastructure is designed in a way that it maintains the original files from the primary Netdata repositories, emphasizing the importance of following specific guidelines for contributions.
Features
-
Automated Deployment: Changes to documentation are deployed automatically to Netlify, ensuring that the most up-to-date content is always accessible.
-
Mirror Architecture: The repository's
/docsfolder mirrors original files from the Netdata repositories, preserving the integrity of the documentation while allowing community contributions. -
Local Development Environment: Users can easily set up a local development environment to test changes and view updates in real time, making it developer-friendly.
-
Markdown Live Updates: Edits made to Markdown files are reflected instantly on the local server, promoting a dynamic development experience without the need for constant restarts.
-
Ingest Process: The manual ingest script allows users to pull documentation from multiple repositories, providing flexibility for those making changes across branches or forks.
-
Python Integration: The requirement for Python v3.9+ ensures that the process is compatible with modern coding practices and allows for easy management of dependencies.
-
Contribution Guidelines: Detailed documentation is available for contributors, including a style guide to maintain high-quality standards in submissions.
-
Version Control: The ability to create separate test branches allows contributors to work safely without affecting the main project until changes are finalized.
- React
React is a widely used JavaScript library for building user interfaces and single-page applications. It follows a component-based architecture and uses a virtual DOM to efficiently update and render UI components
- Tailwind
Tailwind CSS is a utility-first CSS framework that provides pre-defined classes for building responsive and customizable user interfaces.
- Postcss
PostCSS is a popular open-source tool that enables web developers to transform CSS styles with JavaScript plugins. It allows for efficient processing of CSS styles, from applying vendor prefixes to improving browser compatibility, ultimately resulting in cleaner, faster, and more maintainable code.
- Typescript
TypeScript is a superset of JavaScript, providing optional static typing, classes, interfaces, and other features that help developers write more maintainable and scalable code. TypeScript's static typing system can catch errors at compile-time, making it easier to build and maintain large applications.
- Webpack
Webpack is a popular open-source module bundler for JavaScript applications that bundles and optimizes the code and its dependencies for production-ready deployment. It can also be used to transform other types of assets such as CSS, images, and fonts.