The purpose of these codelabs is to create easily consumable, step-by-step tutorials that walk a developer to achieve a goal.
This repository is included as a submodule in the main site repo. The main codelabs site is deployed from that repo and codelab artifacts are kept here.
- codelabs - contains codelabs that will be served up on https://codelabs.solace.dev/. The raw markdown file is exported into this directory via the claat tool.
- markdown - This directory contains the markdown file that the codelabs were generated from.
- Fork this main repository by clicking on the
Forkbutton on the top right - From a terminal window, clone your fork of the repo
git clone [email protected]:<Your_Github_User>/solace-dev-codelabs.git - Navigate to the newly cloned directory
cd solace-dev-codelabs - Checkout a local branch for your new codelab
git checkout -b add-codelab-<name_of_codelab>
- Setup your environment
- Read the solace guidelines
- From the root directory, run
./init.sh <name-of-codelab>script - Navigate to
/markdown/name-of-codelab - Run the following from terminal
npm install; npm run watch - Edit your
<name-of-codelab>.mdfile in your text editor of choice - When ready, run
export.sh - Navigate to the codelabs root directory (
cd ../../), add and commit your changes in a PR. From the root directory,
cd ../../ #to navigate to the root of the codelabs dir
git add .
git commit -m "add new codelab: <name of codelab>"
git push origin add-codelab-<name_of_codelab>
Note: origin in the command above the name of the remote repository. If your remote repository is of a different name then you will have to git push <name_of_remote_repo> add-codelab-<name_of_codelab>
Follow the steps in this tutorial: https://codelabs.solace.dev/codelabs/codelab-4-codelab
Note: original markdown of this codelab is found under codelabs/codelab-4-codelab
- CodeLabs are being created using Google Codelabs: https://github.com/googlecodelabs/tools