Skip to content

Commit

Permalink
Merge pull request #51 from JordanKergoat/docs
Browse files Browse the repository at this point in the history 
[Docs] Adding docs regarding local changes and United Nation popup
  • Loading branch information
@nboury-vsct
nboury-vsct authored Dec 16, 2016
2 parents 54fafcf + f4beb8a commit e39a09d
Show file tree
Hide file tree
Showing 12 changed files with 128 additions and 3 deletions.
60 changes: 58 additions & 2 deletions docs/applications.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ <h3 class="block-title">Overview</h3>
<p><img class="img-responsive" src="assets/images/screenshots/platform_icone_tree_and_block_mode.png"/></p>

</div><!--//section-block-->
<div id="create-logic-representation"" class="section-block">
<div id="create-logic-representation" class="section-block">
<h3 class="block-title">Create your platform</h3>
<p>You will find below the several operations availables to manage a platform according to the selected mode :</p>
<div class="table-responsive">
Expand Down Expand Up @@ -233,7 +233,56 @@ <h3 class="block-title">Update your platform</h3>
</table>
</div><!--//table-responsive-->
</div><!--//section-block-->
</section><!--//doc-section-->
</section><!--//doc-section-->
<section id="united-nation" class="doc-section">
<h2 class="section-title">United Nation popup</h2>
<div class="section-block">
<p>Yes, this is a weird section name, but we chose it because this popup job is to resolve conflicts :) If you haven't heard of local changes please read this section first
(<a href="valuations.html#local-changes">local changes explained</a>)</p>

</div>
<div id="local-changes-introduction" class="section-block">
<h3 class="block-title">Introduction</h3>
<div class="section-block">
<p>From a platform, you can see this button, hit it to enter in the United Nation popup. The value in parentheses represent the global amount of local changes within the
current platform</p>
<img class="img-responsive" src="assets/images/screenshots/nu_intro.png">
</div>
<div class="section-block">
<p>This is the landing page of United Nation popup</p>
<img class="img-responsive" src="assets/images/screenshots/nu_landing_page.png">
<ul>
<li>1 : First module having local changes, The value in parentheses represent the amount of local changes within the module</li>
<li>2 : First module having local changes, The value in parentheses represent the amount of local changes within the module</li>
<li>3 : Input to write you global comment to apply to every module modification</li>
<li>4 : Save button become available when comment is filled, it will save all the local changes of every module listed in United Nation popup</li>
</ul>
</div>
</div>
<div id="local-changes-manage" class="section-block">
<h3 class="block-title">Manage your local changes</h3>
<div class="section-block">
<p>Clicking on the part represented by 1 will display this part</p>
<img class="img-responsive" src="assets/images/screenshots/nu_save_one_module.png">
<ul>
<li>1 : Input to write you comment to apply for this specific module</li>
<li>2 : Save button become available when comment is filled, it will save all the local changes of this module</li>
<li>3 : This column "To save" mean that regardless of checkbox (4) it will save the value as they are display in this column</li>
<li>4 : This checkbox allows yo report current value over your local change</li>
</ul>

<p>In part (3) you can also edit on the input directly if you see fit.</p>
</div>
<div class="section-block">
<p>If you hit the save button in this configuration, you will apply the value present in the "To save" column, so "overriding_by_local" and "my_local_value" will be save</p>
<img class="img-responsive" src="assets/images/screenshots/nu_save_one_module_raw.png">
</div>
<div class="section-block">
<p>But If you hit the save button in this configuration with a checkbox checked, you will also apply the value present in the "To save" column, so "my_real_value" and "my_local_value" will be save</p>
<img class="img-responsive" src="assets/images/screenshots/nu_save_one_module_edit.png">
</div>
</div>
</section>
<section id="events" class="doc-section">
<h2 class="section-title">Events</h2>
<div id="overview-events" class="section-block">
Expand Down Expand Up @@ -382,6 +431,13 @@ <h4 class="callout-title">Prohibition to view password-like properties</h4>
<li><a class="scrollto" href="#update-logic-representation">Update your platform</a></li>
</ul><!--//nav-->
</li>
<li>
<a class="scrollto" href="#united-nation">United Nation popup</a>
<ul class="nav doc-sub-menu">
<li><a class="scrollto" href="#local-changes-introduction">Introduction</a></li>
<li><a class="scrollto" href="#local-changes-manage">Manage your local changes</a></li>
</ul><!--//nav-->
</li>
<li>
<a class="scrollto" href="#events">Events</a>
<ul class="nav doc-sub-menu">
Expand Down
Binary file added docs/assets/images/screenshots/clean_local_1.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/screenshots/clean_local_2.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/screenshots/initial_local.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/screenshots/nu_intro.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/screenshots/nu_landing_page.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/screenshots/nu_save_one_module.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/screenshots/nu_save_one_module_edit.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/screenshots/nu_save_one_module_raw.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/screenshots/save_locally.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/images/screenshots/saved_locally.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
71 changes: 70 additions & 1 deletion docs/valuations.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ <h1 class="doc-title"><i class="icon fa fa-cubes"></i> Valuations</h1>
<section id="overview" class="doc-section">
<h2 class="section-title">Overview</h2>
<div class="section-block">
<p>Now that you know handling templates (if not, go to <a href="templates.html">this section</a>), and applications (if not, go to <a href="applications.html">this section</a>), it's finally time to valuate properties for your application.</p>
<p>Now that you know handling templates (if not, refer to <a href="templates.html">this section</a>), and applications (if not, refer to <a href="applications.html">this section</a>), it's finally time to valuate properties for your application.</p>
<p>You can valuate properties at three levels :</p>
<ul>
<li>Platform Level (optional)</li>
Expand Down Expand Up @@ -395,6 +395,67 @@ <h6>Block mode</h6>
</div>
</div>
</section>
<section id="local-changes" class="doc-section">
<h2 class="section-title">Local Changes</h2>
<div class="section-block">
<p>Local changes can be seens has a way to locally save your work. It allows you to pause and resume later on your work, but also act as a failover system in case of a failure in
the saving process(a local save is automatically done before each save). Allowing you to recover your changes without loosing anything.</p>

<div class="callout-block callout-warning">
<div class="icon-holder">
<i class="fa fa-exclamation-triangle"></i>
</div><!--//icon-holder-->
<div class="content">
<h4 class="callout-title">Limitations</h4>
<p>At the time being the local change system only works for simple properties, iterables properties aren't supporter yet, but rest assured their time will come as well.</p>
</div><!--//content-->
</div><!--//callout-block-->
</div>
<div id="local-changes-save" class="section-block">
<h3 class="block-title">Save your local changes</h3>
<div class="section-block">
<p>To get started with local change let's assuming you are editing a module</p>
<img class="img-responsive" src="assets/images/screenshots/initial_local.png">
</div>
<div class="section-block">
<p>Type in or out any changes you want and then press LOCAL button to save locally</p>
<img class="img-responsive" src="assets/images/screenshots/save_locally.png">
</div>
<div class="section-block">
<p>When local changes are saved, you can see a message saying that local change has been detected, and you can see them by following the orange color code.</p>
<img class="img-responsive" src="assets/images/screenshots/saved_locally.png">
</div>
</div>
<div id="local-changes-clear" class="section-block">
<h3 class="block-title">Delete your local changes</h3>
<div class="section-block">
<p>We will continue with the previous states of Saving part. The requirement is to have local changes, otherwise the cleaning button won't appear. So let's get to business,
the first things to know is that, right now, when cleaning up local changes, it clean all your local changes, you cannot specify which one you want to delete or keep. It should
be available in the next release.</p>
<p>Hit the LOCAL button associated with the trash icon to get started</p>
<img class="img-responsive" src="assets/images/screenshots/clean_local_1.png">
</div>
<div class="section-block">
<p>A confirmation pops in for you to confirm that you really want to delete all your local changes. Obviously, if you had done changes in another module, it won't delete it.</p>
<img class="img-responsive" src="assets/images/screenshots/clean_local_2.png">
</div>
</div>
<div id="local-changes-ttl" class="section-block">
<h3 class="block-title">Time To Live</h3>
<div class="section-block">
<p>Your local changes has different way of being deleted, pay attention to understand how it work :</p>
<ul>
<li>Removing manually your local changes as explained in the previous part</li>
<li>While saving for real your local changes will be automatically removed if the save process ends as expected</li>
<li>A <b>T</b>ime <b>T</b>o <b>L</b>ive parameter allows Hesperides to control how long your local changes will be kept</li>
</ul>

<p>To explain a bit more about the TTL system, it works with the platform version_id. Each time a user perform a modification against a platform it increase its version_id.
A default TTL of 50 is applied, meaning that when your change will have a difference bigger than 50 they will be automatically removed. The next release will introduce message warning
to remind you that your local changes are close to their expiration time</p>
</div>
</div>
</section>
<section id="predefined-properties" class="doc-section">
<h2 class="section-title">Predefined properties</h2>
<div class="section-block">
Expand Down Expand Up @@ -481,6 +542,14 @@ <h4 class="callout-title">Deleted values</h4>
<li><a class="scrollto" href="#preview-files">Preview files</a></li>
</ul><!--//nav-->
</li>
<li>
<a class="scrollto" href="#local-changes">Local changes</a>
<ul class="nav doc-sub-menu">
<li><a class="scrollto" href="#local-changes-save">Save your local changes</a></li>
<li><a class="scrollto" href="#local-changes-clear">Delete your local changes</a></li>
<li><a class="scrollto" href="#local-changes-ttl">Time To Live</a></li>
</ul><!--//nav-->
</li>
<li>
<a class="scrollto" href="#predefined-properties">Predefined properties</a>
<ul class="nav doc-sub-menu">
Expand Down

0 comments on commit e39a09d

Please sign in to comment.