Skip to content
This repository was archived by the owner on Mar 13, 2024. It is now read-only.

Commit bae5c35

Browse files
committed
Update docs
1 parent dfe8591 commit bae5c35

File tree

3 files changed

+19
-11
lines changed

3 files changed

+19
-11
lines changed

docs/how-to/existing.rst

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,9 @@ This will:
2525
Example merge
2626
-------------
2727

28-
As an example, `scanspec #33 <url>`_ shows the what this adoption looks like.
29-
The commandline tool was run on the existing repo::
28+
As an example, `scanspec #46
29+
<https://github.com/dls-controls/scanspec/pull/46>`_ shows the what this
30+
adoption looks like. The commandline tool was run on the existing repo::
3031

3132
$ cd /path/to/scanspec
3233
$ git checkout -b adopt-skeleton
@@ -74,7 +75,16 @@ The commandline tool was run on the existing repo::
7475
git branch -d skeleton-merge-branch
7576
Instructions on how to develop this module are in CONTRIBUTING.rst
7677

77-
Each of these merge conflicts was fixed, then the pipenv dependencies updated::
78+
First of the boilerplate files were removed::
79+
80+
$ git rm src/scanspec/hello.py docs/images/dls-logo.svg docs/images/dls-favicon.ico docs/how-to/accomplish-a-task.rst docs/explanations/why-is-something-so.rst -f
81+
rm 'docs/explanations/why-is-something-so.rst'
82+
rm 'docs/how-to/accomplish-a-task.rst'
83+
rm 'docs/images/dls-favicon.ico'
84+
rm 'docs/images/dls-logo.svg'
85+
rm 'src/scanspec/hello.py'
86+
87+
Then the merge conflicts were fixed, and the pipenv dependencies updated::
7888

7989
$ pipenv --rm
8090
$ rm Pipfile.lock
@@ -85,11 +95,9 @@ The tests and docs were then run and checked::
8595
$ pipenv run tests
8696
$ pipenv run docs
8797

88-
Finally the results were committed:
89-
90-
.. image:: https://mhutchie.gallerycdn.vsassets.io/extensions/mhutchie/git-graph/1.30.0/1617594001998/Microsoft.VisualStudio.Services.Icons.Default
91-
92-
93-
98+
Finally the results were committed, pushed, merged to master::
9499

100+
$ git commit
101+
$ git push github adopt-skeleton
95102

103+
.. image:: ../images/git_merge.png

docs/how-to/update.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ structure in an existing repo) some time ago, there may be some changes to the
66
structure that you could pick up. You can optionally check what differences
77
these changes make to the files by doing::
88

9-
$ git fetch https://github.com/dls-controls/dls-python3-skeleton
9+
$ git fetch https://github.com/dls-controls/dls-python3-skeleton skeleton
1010
$ git diff ...FETCH_HEAD
1111

1212
To merge the changes in do::
1313

14-
$ git pull https://github.com/dls-controls/dls-python3-skeleton
14+
$ git pull https://github.com/dls-controls/dls-python3-skeleton skeleton

docs/images/git_merge.png

20.8 KB
Loading

0 commit comments

Comments
 (0)