An overview of the architecture can be found at netplan.io/design
Find the full documentation for Netplan on "Read the Docs".
To contribute documentation, these steps should get you started:
-
Fork and clone the repo:
git clone [email protected]:your_user_name/netplan.git
-
Create a new branch:
git checkout -b <your_branch_name>
-
Navigate to the
doc/
directory and make your contribution:cd doc
-
View your documentation in the browser by running the
make
command from within thedoc/
directory:make run
-
Test your contribution to ensure good quality.
-
Push your contribution to GitHub and create a pull request.
If you face issues, refer to our comprehensive contribution guide.
Steps to build Netplan using the Meson build system inside the build/
directory:
- meson setup build --prefix=/usr [-Db_coverage=true]
- meson compile -C build
- meson test -C build --verbose [TEST_NAME]
- meson install -C build --destdir ../tmproot
Please file bug reports in Launchpad.
Please join us on IRC in #netplan at Libera.Chat.
Our mailing list is here.
Email the list at [email protected].