From 8652d053d68e99beefa11e937651198d43cedd01 Mon Sep 17 00:00:00 2001 From: Sumesh Premraj Date: Tue, 24 Nov 2020 11:51:32 +0530 Subject: [PATCH] Add local build documentation --- courses/CONTRIBUTING.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/courses/CONTRIBUTING.md b/courses/CONTRIBUTING.md index 52323d2..2b50de4 100644 --- a/courses/CONTRIBUTING.md +++ b/courses/CONTRIBUTING.md @@ -3,3 +3,12 @@ We realise that the initial content we created is just a starting point and our As a contributor, you represent that the content you submit is not plagiarised. By submitting the content, you (and, if applicable, your employer) are licensing the submitted content to LinkedIn and the open source community subject to the BSD 2-Clause license. We suggest to open an issue first and seek advice for your changes before submitting a pull request. + +### Building and testing locally +Run the following commands to build and view the site locally before opening a PR. + +``` +pip install -r requirements.txt +mkdocs build +mkdocs serve +``` \ No newline at end of file