CloudShell DevGuide Source

This is the home repo of the CloudShell DevGuide. The CloudShell Developer's Guide is an open source documentation initiative. You can submit pull requests with articles or bug fixes or post issues for enhancement suggestions, corrections and feedback.

How to contribute

To provide feedback or request enhancements simply create an issue in the repository. You can use the Waffle Board to add issues directly and catch up on the current backlog progress.

You're welcome to submit new documentation articles or suggestions modification or fixes to existing articles. Simply clone or fork the repo and submit pull request to the master branch.

Posting code samples

Any code samples should be posted on the the devguide_examples repository. You can submit a PR to that repository with any code you'd like to include in an article. This DevGuide uses the jekyll-github-sample plugin to link to code posted separately.

You can find more info on the plugin website, generally you include the "github_sample_ref" tag to provide a reference to the file on the github repo and the "github_sample" to include specific lines in the article. Here's a simple example:

{% github_sample_ref /QualiSystems/devguide_examples/blob/driver_deep_dive/adding_examples/driver_deep_dive/src/driver.py %}
{% highlight python %}
{% github_sample /QualiSystems/devguide_examples/blob/driver_deep_dive/adding_examples/driver_deep_dive/src/driver.py 22 35 %}
{% endhighlight %}

Installing locally

The DevGuide is running on Jekyll. To run the DevGuide locally, you'll first need to install Ruby. Then, clone the repo and run the bundle command to install all required gems, including Jekyll.

Finally, run the 'bundle' command to install Jekyll and all dependencies.

To start Jekyll run:

bundle exec jekyll build
bundle exec jekyll serve

You'll be able to see the DevGuide site at the default Jekyll URL at http://127.0.0.1:4000/devguide.