summaryrefslogtreecommitdiff
path: root/docs/contributing/development.rst
diff options
context:
space:
mode:
authorChristian Poessinger <christian@poessinger.com>2019-05-28 22:31:12 +0200
committerChristian Poessinger <christian@poessinger.com>2019-05-28 22:31:12 +0200
commit9c2f5d706c61859e69dd1b7a3b54f898dcf8d480 (patch)
treecd1f6b28d6a81d94a42ef8ec250333a038be0499 /docs/contributing/development.rst
parent337dcdf07c51df2208da65aa9c5ab06a09d5cc3a (diff)
downloadvyos-documentation-9c2f5d706c61859e69dd1b7a3b54f898dcf8d480.tar.gz
vyos-documentation-9c2f5d706c61859e69dd1b7a3b54f898dcf8d480.zip
Contribution: split source into smaller files
Diffstat (limited to 'docs/contributing/development.rst')
-rw-r--r--docs/contributing/development.rst18
1 files changed, 18 insertions, 0 deletions
diff --git a/docs/contributing/development.rst b/docs/contributing/development.rst
new file mode 100644
index 00000000..14f0856a
--- /dev/null
+++ b/docs/contributing/development.rst
@@ -0,0 +1,18 @@
+.. _development:
+
+Development
+===========
+
+The source code is hosted on GitHub under VyOS organization `github.com/vyos`_
+
+The code is split into modules. VyOS is composed of multiple individual packages,
+some of them are periodically synced with upstream, so keeping the whole source
+under a single repository would be very inconvenient and slow. There is now an
+ongoing effort to consolidate all VyOS-specific packages into vyos-1x package,
+but the basic structure is going to stay the same, just with fewer submodules.
+
+The repository that contains the ISO build script is vyos-build_. The README will
+guide you to use the this toplevel repository.
+
+.. _github.com/vyos: https://github.com/vyos
+.. _vyos-build: https://github.com/vyos/vyos-build