1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
|
# Netplan - Declarative network configuration for various backends
[](https://github.com/canonical/netplan/actions/workflows/build-abi.yml?query=branch%3Amain)
[](https://github.com/canonical/netplan/actions/workflows/check-coverage.yml?query=branch%3Amain)
[](https://github.com/canonical/netplan/actions/workflows/autopkgtest.yml?query=branch%3Amain)
# Website
http://netplan.io
# Documentation
An overview of the architecture can be found at [netplan.io/design](https://netplan.io/design)
Find the full [documentation for Netplan](https://netplan.readthedocs.io) on "Read the Docs".
To contribute documentation, these steps should get you started:
1. Fork and clone the repo:
```
git clone git@github.com:your_user_name/netplan.git
```
2. Create a new branch:
```
git checkout -b <your_branch_name>
```
3. Navigate to the `doc/` directory and make your contribution:
```
cd doc
```
4. View your documentation in the browser by running the `make` command from within the `doc/` directory:
```
make run
```
5. Test your contribution to ensure good quality.
6. Push your contribution to GitHub and create a pull request.
If you face issues, refer to our [comprehensive contribution guide](https://netplan.readthedocs.io/en/stable/contribute-docs/).
# Build using Meson
Steps to build Netplan using the [Meson](https://mesonbuild.com) 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
# Bug reports
Please file bug reports in [Launchpad](https://bugs.launchpad.net/netplan/+filebug).
# Contact us
Please join us on [IRC in #netplan](https://web.libera.chat/gamja/?channels=%23netplan) at Libera.Chat.
Our mailing list is [here](https://lists.launchpad.net/netplan-developers/).
Email the list at [netplan-developers@lists.launchpad.net](mailto:netplan-developers@lists.launchpad.net).
|
