launchpad-reviewers team mailing list archive

[Tushar Gupta <mp+469832@xxxxxxxxxxxxxxxxxx>]

Tushar Gupta has proposed merging ~tushar5526/launchpad-buildd:update-launchpad-dev-docs into launchpad-buildd:master.

Commit message:
feat: Update docs and Makefile for better dev experience

- Add new targets to install deps, build-deps and test docs locally
- Update links to point to new docs

Requested reviews:
  Launchpad code reviewers (launchpad-reviewers)

For more details, see:
https://code.launchpad.net/~tushar5526/launchpad-buildd/+git/launchpad-buildd/+merge/469832
-- 
Your team Launchpad code reviewers is requested to review the proposed merge of ~tushar5526/launchpad-buildd:update-launchpad-dev-docs into launchpad-buildd:master.

diff --git a/Makefile b/Makefile
index fea4c04..50c8db8 100644
--- a/Makefile
+++ b/Makefile
@@ -18,8 +18,19 @@ realclean:
 	rm -f ../launchpad-buildd*deb
 	rm -f ../launchpad-buildd*changes
 
-.PHONY: all clean deb
+.PHONY: all clean deb install realclean src check docs
 
 check:
 	PYTHONPATH=$(CURDIR):$(PYTHONPATH) python3 -m testtools.run \
 		discover -v
+
+install:
+	sudo add-apt-repository ppa:launchpad/ppa \
+	&& sudo apt-get update \
+	&& cat system-dependencies.txt | sudo xargs apt-get install -y \
+
+install-build-deps: install
+	sudo apt install -y dpkg-dev dh-exec dh-python
+
+docs:
+	sphinx-build -M html docs  docs/_build
diff --git a/docs/how-to/building.rst b/docs/how-to/building.rst
index 280b2b7..c130368 100644
--- a/docs/how-to/building.rst
+++ b/docs/how-to/building.rst
@@ -1,22 +1,16 @@
 How to build the project
 ************************
 
-In order to build the package you need ``dpkg-dev`` and ``fakeroot``.
-
-To build the package, do:
+You can make to build the pakcage:
 
 .. code:: bash
 
-    debian/rules package
-    dpkg-buildpackage -rfakeroot -b
-
-It will "fail" because the package built in the "wrong" place.
-Don't worry about that.
+    make install-build-deps
+    make deb
 
 To clean up, do:
 
 .. code:: bash
 
-    fakeroot debian/rules clean
-    rm launchpad-buildd*deb
-    rm ../launchpad-buildd*changes
+    make clean
+    make realclean # if you want to remove all created artificats
\ No newline at end of file
diff --git a/docs/how-to/developing.rst b/docs/how-to/developing.rst
index ebb568c..2398e8e 100644
--- a/docs/how-to/developing.rst
+++ b/docs/how-to/developing.rst
@@ -2,12 +2,18 @@ How to set up a development environment
 ***************************************
 
 First of all, it is recommended that you create an lxc container, since the
-following steps will make changes in your system. And since some build types
-will only work with virtualized containers, creating an lxc vm is the best way
-to go. If you just want to run the test suite, creating a container is
+following steps will make changes in your system by installing new dependencies. 
+And since some build types will only work with virtualized containers, creating an 
+lxc vm is the best way to go. 
+
+You can learn more about LXC and set them up 
+here: https://ubuntu.com/server/docs/lxd-containers
+
+
+PS: If you just want to run the test suite, creating a container is
 sufficient.
 
-You can create a container with the following command:
+You can create a VM with the following command:
 
 .. code:: bash
 
@@ -16,16 +22,19 @@ You can create a container with the following command:
 Note that you may want to have a profile to share the source code with the
 container before running the above command.
 
-Then, inside the container, install the necessary dependencies:
+Then, inside the container clone the repo and install the necessary dependencies:
 
 .. code:: bash
 
-        sudo add-apt-repository ppa:launchpad/ppa
-        sudo apt-get update
-        cat system-dependencies.txt | sudo xargs apt-get install -y
+        git clone https://git.launchpad.net/launchpad-buildd
+        cd launchpad-buildd
+        make install
+
+This should be enough for you to be able to run the test suite:
+
+.. code:: bash
 
-This should be enough for you to be able to run the test suite via `make
-check`.
+        make check
 
 More information on how to integrate it with Launchpad can be found here:
 https://dev.launchpad.net/Soyuz/HowToDevelopWithBuildd
diff --git a/docs/index.rst b/docs/index.rst
index a80b2b3..4b00a2f 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -13,7 +13,7 @@ It is licensed under the GNU Affero General Public Licence, version 3 (see the
 file LICENCE) except for some files originating elsewhere, which are marked
 with the licence that applies.
 
-See https://dev.launchpad.net/ for more context.
+See https://documentation.ubuntu.com/launchpad/en/latest/ for more context.
 
 
 .. toctree::