summaryrefslogtreecommitdiff
path: root/doc/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/README.md')
-rw-r--r--doc/README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/doc/README.md b/doc/README.md
new file mode 100644
index 0000000..5252390
--- /dev/null
+++ b/doc/README.md
@@ -0,0 +1,24 @@
+# Netplan Documentation
+
+```{toctree}
+---
+maxdepth: 2
+---
+reference
+howto
+tutorials
+explanation
+```
+
+## Project and community
+
+* **Reporting bugs**: We want to know about the problems so we can fix them.
+* **Code changes**: The code is open and we are open to accepting changes to
+ it. So, don’t worry about maintaining a new fork, and instead, let's work
+ together.
+
+### If you want to get involved
+* Visit the website at [netplan.io](https://netplan.io)
+* Join the [community forum](https://askubuntu.com/questions/tagged/netplan)
+* Report a bug on [Launchpad](https://bugs.launchpad.net/netplan/+filebug)
+* Contribute on [GitHub](https://github.com/canonical/netplan)