Skip to content

Commit

Permalink
Further changes to documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
DjangoWill2018 committed Jan 2, 2019
1 parent cc5c9a0 commit 3d0a4e4
Show file tree
Hide file tree
Showing 25 changed files with 398 additions and 270 deletions.
Binary file modified docs/_build/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/_build/doctrees/getting_started/how_to_contribute.doctree
Binary file not shown.
Binary file modified docs/_build/doctrees/index.doctree
Binary file not shown.
@@ -1,9 +1,11 @@
How to Contribute
*****************

h2 -- How the work will be divided
How the work will be divided
############################

h3 -- The project overall
The project overall
*******************

The project will comprise of one core application - a primary module - which can be supplemented by additional apps.

Expand All @@ -17,7 +19,8 @@ The additional modules may duplicate functionality or achieve the same functiona

Initially, we will focus on the Core App. Eventually, we hope contributors will be able to work on separate, compatible apps. When we are at that stage, we will decide whether those apps need their separate repository or can be integrated into the main one.

h3 -- The Core App
The Core App
############

Development of the Core App will be divided into the following "work streams":

Expand All @@ -38,7 +41,8 @@ Development of the Core App will be divided into the following "work streams":

The Core App will have two main branches: *Master* and *Development*. Pull Requests should be made to the Development branch. Only once the admins are sure the development branch is in a stable state will the Development branch be merged into the Master branch - this will happen periodically.

h2 -- How to claim tasks and contribute code
How to claim tasks and contribute code
######################################

**How to claim tasks**

Expand Down
8 changes: 2 additions & 6 deletions docs/_build/html/_sources/index.rst.txt
Expand Up @@ -13,20 +13,16 @@ Welcome to LearnToCodeApp's documentation!
:glob:
:numbered:
:caption: Table of Contents:


getting_started/*


beginner_tasks/*



intermediate_tasks/*


code_standards/*


specifications/*


Expand Down
44 changes: 26 additions & 18 deletions docs/_build/html/beginner_tasks/make_change_to_a_file.html
Expand Up @@ -8,7 +8,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>8. Submit a change to the repository &mdash; LearnToCodeApp documentation</title>
<title>9. Submit a change to the repository &mdash; LearnToCodeApp documentation</title>



Expand All @@ -28,8 +28,8 @@
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="9. Suggest an Issue" href="suggest_an_issue.html" />
<link rel="prev" title="7. Licence for use" href="../getting_started/licence.html" />
<link rel="next" title="10. Suggest an Issue" href="suggest_an_issue.html" />
<link rel="prev" title="8. Licence for use" href="../getting_started/licence.html" />


<script src="../_static/js/modernizr.min.js"></script>
Expand Down Expand Up @@ -83,17 +83,25 @@
<li class="toctree-l1"><a class="reference internal" href="../getting_started/about.html">1. About - a summary of the project</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting_started/contributors.html">2. Contributors to the project</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting_started/dependencies.html">3. Dependencies, tools and technologies we use</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting_started/how_to_contribute.html">4. How to Contribute</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting_started/how_to_review_a_pull_request.html">5. How to Review a Pull Request</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting_started/jargon.html">6. Jargon list</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting_started/licence.html">7. Licence for use</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">8. Submit a change to the repository</a></li>
<li class="toctree-l1"><a class="reference internal" href="suggest_an_issue.html">9. Suggest an Issue</a></li>
<li class="toctree-l1"><a class="reference internal" href="../intermediate_tasks/update_readthedocs_files.html">10. Make a change to the documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../code_standards/javascript.html">11. Javascript Aims and Standards</a></li>
<li class="toctree-l1"><a class="reference internal" href="../code_standards/markup.html">12. Markup Aims and Standards</a></li>
<li class="toctree-l1"><a class="reference internal" href="../code_standards/python.html">13. Python Aims and Standards</a></li>
<li class="toctree-l1"><a class="reference internal" href="../specifications/core_app.html">14. Core App Specifications and List of Functionality</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting_started/how_to_contribute.html">4. How to Contribute</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../getting_started/how_to_contribute.html#how-the-work-will-be-divided">4.1. How the work will be divided</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../getting_started/how_to_contribute.html#the-project-overall">5. The project overall</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../getting_started/how_to_contribute.html#the-core-app">5.1. The Core App</a></li>
<li class="toctree-l2"><a class="reference internal" href="../getting_started/how_to_contribute.html#how-to-claim-tasks-and-contribute-code">5.2. How to claim tasks and contribute code</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../getting_started/how_to_review_a_pull_request.html">6. How to Review a Pull Request</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting_started/jargon.html">7. Jargon list</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting_started/licence.html">8. Licence for use</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">9. Submit a change to the repository</a></li>
<li class="toctree-l1"><a class="reference internal" href="suggest_an_issue.html">10. Suggest an Issue</a></li>
<li class="toctree-l1"><a class="reference internal" href="../intermediate_tasks/update_readthedocs_files.html">11. Make a change to the documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../code_standards/javascript.html">12. Javascript Aims and Standards</a></li>
<li class="toctree-l1"><a class="reference internal" href="../code_standards/markup.html">13. Markup Aims and Standards</a></li>
<li class="toctree-l1"><a class="reference internal" href="../code_standards/python.html">14. Python Aims and Standards</a></li>
<li class="toctree-l1"><a class="reference internal" href="../specifications/core_app.html">15. Core App Specifications and List of Functionality</a></li>
</ul>


Expand Down Expand Up @@ -139,7 +147,7 @@

<li><a href="../index.html">Docs</a> &raquo;</li>

<li>8. Submit a change to the repository</li>
<li>9. Submit a change to the repository</li>


<li class="wy-breadcrumbs-aside">
Expand All @@ -159,7 +167,7 @@
<div itemprop="articleBody">

<div class="section" id="submit-a-change-to-the-repository">
<h1>8. Submit a change to the repository<a class="headerlink" href="#submit-a-change-to-the-repository" title="Permalink to this headline"></a></h1>
<h1>9. Submit a change to the repository<a class="headerlink" href="#submit-a-change-to-the-repository" title="Permalink to this headline"></a></h1>
<p>Most contributions you make to the project will involve making a change to the code. The changes will not be automatically incorporated within the shared version of the project (the “Master” branch).</p>
<p>Instead, you make a change to a copy of the repository (a “branch”) and suggest the change is included in the shared version (a “pull request”).</p>
<p>Since this is central to the task, you may as well get started straight away. If you have no other changes to suggest, you can add your name or username to the list of collaborators in the “readme” file.</p>
Expand All @@ -183,10 +191,10 @@ <h1>8. Submit a change to the repository<a class="headerlink" href="#submit-a-ch

<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">

<a href="suggest_an_issue.html" class="btn btn-neutral float-right" title="9. Suggest an Issue" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="suggest_an_issue.html" class="btn btn-neutral float-right" title="10. Suggest an Issue" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>


<a href="../getting_started/licence.html" class="btn btn-neutral" title="7. Licence for use" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
<a href="../getting_started/licence.html" class="btn btn-neutral" title="8. Licence for use" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>

</div>

Expand Down
44 changes: 26 additions & 18 deletions docs/_build/html/beginner_tasks/suggest_an_issue.html
Expand Up @@ -8,7 +8,7 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>9. Suggest an Issue &mdash; LearnToCodeApp documentation</title>
<title>10. Suggest an Issue &mdash; LearnToCodeApp documentation</title>



Expand All @@ -28,8 +28,8 @@
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="10. Make a change to the documentation" href="../intermediate_tasks/update_readthedocs_files.html" />
<link rel="prev" title="8. Submit a change to the repository" href="make_change_to_a_file.html" />
<link rel="next" title="11. Make a change to the documentation" href="../intermediate_tasks/update_readthedocs_files.html" />
<link rel="prev" title="9. Submit a change to the repository" href="make_change_to_a_file.html" />


<script src="../_static/js/modernizr.min.js"></script>
Expand Down Expand Up @@ -83,17 +83,25 @@
<li class="toctree-l1"><a class="reference internal" href="../getting_started/about.html">1. About - a summary of the project</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting_started/contributors.html">2. Contributors to the project</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting_started/dependencies.html">3. Dependencies, tools and technologies we use</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting_started/how_to_contribute.html">4. How to Contribute</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting_started/how_to_review_a_pull_request.html">5. How to Review a Pull Request</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting_started/jargon.html">6. Jargon list</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting_started/licence.html">7. Licence for use</a></li>
<li class="toctree-l1"><a class="reference internal" href="make_change_to_a_file.html">8. Submit a change to the repository</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">9. Suggest an Issue</a></li>
<li class="toctree-l1"><a class="reference internal" href="../intermediate_tasks/update_readthedocs_files.html">10. Make a change to the documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../code_standards/javascript.html">11. Javascript Aims and Standards</a></li>
<li class="toctree-l1"><a class="reference internal" href="../code_standards/markup.html">12. Markup Aims and Standards</a></li>
<li class="toctree-l1"><a class="reference internal" href="../code_standards/python.html">13. Python Aims and Standards</a></li>
<li class="toctree-l1"><a class="reference internal" href="../specifications/core_app.html">14. Core App Specifications and List of Functionality</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting_started/how_to_contribute.html">4. How to Contribute</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../getting_started/how_to_contribute.html#how-the-work-will-be-divided">4.1. How the work will be divided</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../getting_started/how_to_contribute.html#the-project-overall">5. The project overall</a><ul>
<li class="toctree-l2"><a class="reference internal" href="../getting_started/how_to_contribute.html#the-core-app">5.1. The Core App</a></li>
<li class="toctree-l2"><a class="reference internal" href="../getting_started/how_to_contribute.html#how-to-claim-tasks-and-contribute-code">5.2. How to claim tasks and contribute code</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../getting_started/how_to_review_a_pull_request.html">6. How to Review a Pull Request</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting_started/jargon.html">7. Jargon list</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting_started/licence.html">8. Licence for use</a></li>
<li class="toctree-l1"><a class="reference internal" href="make_change_to_a_file.html">9. Submit a change to the repository</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">10. Suggest an Issue</a></li>
<li class="toctree-l1"><a class="reference internal" href="../intermediate_tasks/update_readthedocs_files.html">11. Make a change to the documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../code_standards/javascript.html">12. Javascript Aims and Standards</a></li>
<li class="toctree-l1"><a class="reference internal" href="../code_standards/markup.html">13. Markup Aims and Standards</a></li>
<li class="toctree-l1"><a class="reference internal" href="../code_standards/python.html">14. Python Aims and Standards</a></li>
<li class="toctree-l1"><a class="reference internal" href="../specifications/core_app.html">15. Core App Specifications and List of Functionality</a></li>
</ul>


Expand Down Expand Up @@ -139,7 +147,7 @@

<li><a href="../index.html">Docs</a> &raquo;</li>

<li>9. Suggest an Issue</li>
<li>10. Suggest an Issue</li>


<li class="wy-breadcrumbs-aside">
Expand All @@ -159,7 +167,7 @@
<div itemprop="articleBody">

<div class="section" id="suggest-an-issue">
<h1>9. Suggest an Issue<a class="headerlink" href="#suggest-an-issue" title="Permalink to this headline"></a></h1>
<h1>10. Suggest an Issue<a class="headerlink" href="#suggest-an-issue" title="Permalink to this headline"></a></h1>
<p>Github allows collaborators and third parties to suggest improvements to a project. Improvements might be:</p>
<blockquote>
<div><ul class="simple">
Expand All @@ -183,10 +191,10 @@ <h1>9. Suggest an Issue<a class="headerlink" href="#suggest-an-issue" title="Per

<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">

<a href="../intermediate_tasks/update_readthedocs_files.html" class="btn btn-neutral float-right" title="10. Make a change to the documentation" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="../intermediate_tasks/update_readthedocs_files.html" class="btn btn-neutral float-right" title="11. Make a change to the documentation" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>


<a href="make_change_to_a_file.html" class="btn btn-neutral" title="8. Submit a change to the repository" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
<a href="make_change_to_a_file.html" class="btn btn-neutral" title="9. Submit a change to the repository" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>

</div>

Expand Down

0 comments on commit 3d0a4e4

Please sign in to comment.