Skip to content

Commit

Permalink
rst images
Browse files Browse the repository at this point in the history
  • Loading branch information
ngr committed May 5, 2019
1 parent 1c71308 commit 0ec4b1b
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 4 deletions.
9 changes: 5 additions & 4 deletions docs/convention.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
.. _bi_doc_convention:
.. _Documentation Convention:

=======================
Documentaion Convention
=======================

==============
Doc Convention
==============

This document states the convention that we follow for writing Documentation and especially docstrings for
classes and functions in Better Impression. This convention is based on
Expand Down
30 changes: 30 additions & 0 deletions docs/pycon.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---------
Sprinting
---------

Welcome to the ``sosw`` sprint in PyCon. You are probably eager to contribute, so try to make the
introduction as short as possible.

Initialization
--------------

* Fork the repository: https://github.com/bimpression/sosw_

* Register Account in AWS: `SignUp`_

* Create DynamoDB Tables:
* You can find the Cloudformation template for the databases in `the example`_.
* If you are not familiar with CloudFormation, we highly recommend at least learning the basics from `the tutorial`_.

* Create Sandbox Lambda with Scheduler

* Play with it.

* Read the :ref:`Documentaion convention`


.. _the example: https://raw.githubusercontent.com/bimpression/sosw/docme/docs/yaml/sosw-shared-dynamodb.yaml
.. _the tutorial: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/GettingStarted.Walkthrough.html
.. _SignUp: https://portal.aws.amazon.com/billing/signup#/start


0 comments on commit 0ec4b1b

Please sign in to comment.