You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/how-to-guides/software-management/public-release-process.md
+63-9Lines changed: 63 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -333,28 +333,82 @@ This step covers creating the builds and the installation environments of ISIS f
333
333
334
334
**This step is only done for standard feature releases.**
335
335
336
-
This step will update the ISIS documentation on our [website](https://isis.astrogeology.usgs.gov/UserDocs/) for our users worldwide.
336
+
This step will update the ISIS documentation on our [website](https://isis.astrogeology.usgs.gov) for our users worldwide.
337
337
338
338
339
339
#### Part A: Build the documentation
340
340
341
-
* Add the new version to Documentation Versions in the [menu.xsl](https://github.com/DOI-USGS/ISIS3/blob/dev/isis/src/docsys/build/menu.xsl#L105).
341
+
1. Add the new version to Documentation Versions in the [menu.xsl](https://github.com/DOI-USGS/ISIS3/blob/dev/isis/src/docsys/build/menu.xsl#L105) under dev. Remove the class "usa-current" from the dev's `<li>` and add it to your newly create `<li>` element. For example:
!!! Warning "Do Not Push these changes to the Dev Branch"
366
+
367
+
Only use these code changes for running `ninja docs` and pushing to the S3. See Part C for instructions on what to push back into dev.
368
+
369
+
2. Run cmake command in build directory. See [developing ISIS with cmake](../../how-to-guides/isis-developer-guides/developing-isis3-with-cmake.md) for details.
342
370
343
-
* Perform a local build (not a conda build) using the instructions for [developing ISIS with cmake](../../how-to-guides/isis-developer-guides/developing-isis3-with-cmake.md).
371
+
3. Run the ```ninja docs``` command from this build directory to build the documentation for this version of the code.
344
372
345
-
* setisis to the build directory from [Step 3 Part A](#part-a-setup-repository).
346
373
347
-
* Run the ```ninja docs``` command from this build directory to build the documentation for this version of the code.
374
+
#### Part B: Upload the documentation
348
375
376
+
1. This step requires that you have aws sso configured for the aws production account.
377
+
378
+
Run `aws sso login --profile {insert your configured prod account name}`
379
+
380
+
2. Run a dryrun of copying new docs to the S3 bucket:
In the `$ISISROOT` directory run the following commands, but replace <your-config> with your config for `asc-docs` and <version-number> with the version of ISIS you are releasing. For example if you config is called `s3-docs` and you are releasing 8.1.0, the first command would be `rclone sync --dry-run docs/8.1.0 s3-docs://asc-docs/isis-site/8.1.0/`
* Optionally add the `--dry-run` flag to test prior to actually uploading, `rclone sync docs/<version-number> <your-config>://asc-docs/isis-site/<version-number>/`
392
+
#### Part C: Update Menu Code in Dev Branch
357
393
394
+
The only difference from what we changed in Part A1 is that, instead of moving the "usa-current" class, we are keeping it under "dev" for the biweekly dev doc builds.
395
+
396
+
The only change that needs to be pushed to the dev branch is the new version `<li>` element under "dev." Ensure that the "usa-current" class is removed from this new version `<li>` element.
0 commit comments