Skip to content

Commit 215d4b5

Browse files
committed
add updating DS page to documentation
1 parent 0760200 commit 215d4b5

File tree

3 files changed

+13
-6
lines changed

3 files changed

+13
-6
lines changed

documentation/DS-documentation/_toc.yml

+1
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ parts:
1414
- file: customizing_DS
1515
- file: implementing_DS
1616
- file: troubleshooting_implementation
17+
- file: updating_DS
1718
- caption: Running an application made by Distributed-Something as an end user
1819
chapters:
1920
- file: step_0_prep

documentation/DS-documentation/customizing_DS.md

+1-6
Original file line numberDiff line numberDiff line change
@@ -38,12 +38,7 @@ Implemented examples you can reference are:
3838
## Using the Distributed-Something template
3939

4040
Distributed-Something is a template repository.
41-
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.
42-
We have chosen to provide DS as a template because it provides new implementations with a clean commit history.
43-
Because DS is so customizable, we expect that implementations will diverge from the template.
44-
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.
45-
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.
46-
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.
41+
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.
4742

4843
## Customization details
4944

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Updating Your Distributed-Something Implementation
2+
3+
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.
4+
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.
5+
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.
6+
7+
Because Distributed-Something is so customizable, we expect that implementations will diverge from the template.
8+
Developers should feel free to take what is useful for their application but otherwise change the framework as radically as they need to.
9+
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.
10+
11+
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.

0 commit comments

Comments
 (0)