add updating DS page to documentation

DistributedScience · Mar 31, 2023 · 215d4b5 · 215d4b5
1 parent 0760200
commit 215d4b5
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 6 deletions.
diff --git a/documentation/DS-documentation/_toc.yml b/documentation/DS-documentation/_toc.yml
@@ -14,6 +14,7 @@ parts:
   - file: customizing_DS
   - file: implementing_DS
   - file: troubleshooting_implementation
+  - file: updating_DS
 - caption: Running an application made by Distributed-Something as an end user
   chapters:
   - file: step_0_prep

diff --git a/documentation/DS-documentation/customizing_DS.md b/documentation/DS-documentation/customizing_DS.md
@@ -38,12 +38,7 @@ Implemented examples you can reference are:
 ## Using the Distributed-Something template
 
 Distributed-Something is a template repository.
-Read more about [Github template repositories](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template) and follow the instructions to create your own project repository from the template.
-We have chosen to provide DS as a template because it provides new implementations with a clean commit history.
-Because DS is so customizable, we expect that implementations will diverge from the template.
-Unlike forks, for which Github currently provides a "sync fork" function, templates do not have an automatic way of pulling changes from the template into repositories made from the template.
-If you anticipate wanting to keep your implementation more closely linked to the DS template, you can fork the template to create your own project repository instead and use the "sync fork" function as necessary.
-Or, use the six lines of [code described here](https://stackoverflow.com/questions/56577184/github-pull-changes-from-a-template-repository/69563752#69563752) to pull template changes into your repository.  
+Read more about [Github template repositories](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template) and follow the instructions to create your own project repository from the template. 
 
 ## Customization details
 

diff --git a/documentation/DS-documentation/updating_DS.md b/documentation/DS-documentation/updating_DS.md
@@ -0,0 +1,11 @@
+# Updating Your Distributed-Something Implementation
+
+We expect to continue to improve Distributed-Something and it is possible that a developer will want to implement some of the changes that occur to the DS codebase after they have created their implementation from the template.
+Unlike forks, for which Github currently provides a "sync fork" function, templates do not have an automatic way of pulling changes from the template into repositories made from the template. 
+These six lines of [code described here](https://stackoverflow.com/questions/56577184/github-pull-changes-from-a-template-repository/69563752#69563752) simply explain how to pull template changes into your repository.  
+
+Because Distributed-Something is so customizable, we expect that implementations will diverge from the template. 
+Developers should feel free to take what is useful for their application but otherwise change the framework as radically as they need to.
+Therefore, not all developers will want to incorporate code changes made after using the template, nor would all downstream changes even be functional or relevant in all implementations.
+
+If you anticipate wanting to keep your implementation more closely linked to the DS template, you can fork the template to create your own project repository instead and use the "sync fork" function as necessary.