Skip to content

Commit 5652fce

Browse files
authored
Version defaults docs (#317)
1 parent 8e6b049 commit 5652fce

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

docs/source/dev_guide/release.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,25 @@ How to Prepare a Release
33

44
In this guide, we'll cover:
55

6+
* Preparing the Documentation
67
* Bumping the Version
78
* Releasing On GitHub
89
* Releasing The Software On Anaconda
910
* Creating a New Version of the Documentation
1011

12+
Preparing the Documentation
13+
---------------------------
14+
15+
1. Checkout a branch
16+
17+
::
18+
19+
git fetch upstream main
20+
git checkout -b versioned-docs upstream/main
21+
22+
2. Edit ``docs/source/parameters.rst``: in ``https://github.com/E3SM-Project/zppy/blob/main/zppy/templates/default.ini``, replace ``main`` with the hash of the latest commit.
23+
3. Create a pull request to the main repo and merge it. Now, when the next version of the documentation is created (see last part of this page), it will point to the relevant defaults.
24+
1125
Bumping the Version
1226
-------------------
1327

0 commit comments

Comments
 (0)