Skip to content

Commit a30a086

Browse files
amystamile-usgsjrcain-usgs
authored andcommitted
Updates to docs with new biweekly dev builds (#137)
* Updates to docs with new biweekly dev builds * fix typo
1 parent 490b730 commit a30a086

File tree

4 files changed

+70
-9
lines changed

4 files changed

+70
-9
lines changed

docs/assets/release-process/menu1.png

11.5 KB
Loading

docs/assets/release-process/menu2.png

13 KB
Loading

docs/how-to-guides/environment-setup-and-maintenance/installing-isis-via-anaconda.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,13 @@ The environment is now ready to download ISIS and its dependencies:
106106
```
107107

108108

109+
=== "Dev"
110+
111+
```sh
112+
conda install -c usgs-astrogeology/label/dev isis
113+
```
114+
115+
109116
## Environmental Variables
110117

111118
ISIS requires these environment variables to be set in order to run correctly:

docs/how-to-guides/software-management/public-release-process.md

Lines changed: 63 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -333,28 +333,82 @@ This step covers creating the builds and the installation environments of ISIS f
333333

334334
**This step is only done for standard feature releases.**
335335

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.
337337

338338

339339
#### Part A: Build the documentation
340340

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:
342+
343+
```diff
344+
- <li class="usa-sidenav__item usa-current">
345+
+ <li class="usa-sidenav__item">
346+
<a href="https://isis.astrogeology.usgs.gov/dev/">Dev</a>
347+
</li>
348+
+ <li class="usa-sidenav__item" usa-current>
349+
+ <a href="https://isis.astrogeology.usgs.gov/NEW VERSION/">NEW VERSION</a>
350+
+ </li>
351+
<li class="usa-sidenav__item">
352+
<a href="https://isis.astrogeology.usgs.gov/8.3.0/">8.3.0</a>
353+
</li>
354+
<li class="usa-sidenav__item">
355+
<a href="https://isis.astrogeology.usgs.gov/8.2.0/">8.2.0</a>
356+
</li>
357+
```
358+
359+
The usa-current class highlights the version. This will allow the user to know which version of isis they are currently viewing.
360+
361+
This is a visual of these html code changes:
362+
363+
![Menu Before](../../../assets/release-process/menu1.png) ![Menu After](../../../assets/release-process/menu2.png)
364+
365+
!!! 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.
342370

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.
344372

345-
* setisis to the build directory from [Step 3 Part A](#part-a-setup-repository).
346373

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
348375

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:
381+
382+
`aws s3 cp --recursive docs/{insert_new_version_here}/ s3://asc-public-docs/isis-site/{insert_new_version_here}/ --profile {insert your configured prod account name} --dryrun`
383+
384+
example: `aws s3 cp --recursive docs/9.0.0/ s3://asc-public-docs/isis-site/9.0.0/ --profile prod-account --dryrun`
349385

350-
#### Part B: Upload the documentation
386+
3. Confirm that the dry run is copying your docs to the correct location. If it is, run the actual copy command by removing `--dryrun`:
351387

352-
This step requires that you have an rclone config for the `asc-docs` bucket. You can get credentials from vault.
388+
`aws s3 cp --recursive docs/{insert_new_version_here}/ s3://asc-public-docs/isis-site/{insert_new_version_here}/ --profile {insert your configured prod account}`
353389

354-
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/`
390+
example: `aws s3 cp --recursive docs/9.0.0/ s3://asc-public-docs/isis-site/9.0.0/ --profile prod-account`
355391

356-
* 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
357393

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.
397+
398+
```diff
399+
<li class="usa-sidenav__item" usa-current>
400+
<a href="https://isis.astrogeology.usgs.gov/dev/">Dev</a>
401+
</li>
402+
+ <li class="usa-sidenav__item">
403+
+ <a href="https://isis.astrogeology.usgs.gov/NEW VERSION/">NEW VERSION</a>
404+
+ </li>
405+
<li class="usa-sidenav__item">
406+
<a href="https://isis.astrogeology.usgs.gov/8.3.0/">8.3.0</a>
407+
</li>
408+
<li class="usa-sidenav__item">
409+
<a href="https://isis.astrogeology.usgs.gov/8.2.0/">8.2.0</a>
410+
</li>
411+
```
358412

359413
### Step 11: Communicate Availability of Build
360414

0 commit comments

Comments
 (0)