Skip to content

Commit c06f666

Browse files
authored
How to guide order (#172)
* order of howto guides in mkdocs.yml * cards in how to guides and image processing * add missing nav link to oleg's new mission data doc * link spelling
1 parent 0925fa9 commit c06f666

File tree

3 files changed

+79
-26
lines changed

3 files changed

+79
-26
lines changed

docs/how-to-guides/image-processing/index.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,13 @@
55
<div class="grid cards" markdown>
66

77
- [:material-filter-outline: Remove Striping and Noise :octicons-arrow-right-24:](general-utility-with-fx.md)
8+
9+
Raw images often have artifacts that should be removed before further processing.
10+
811
- [:material-plus-minus-variant: General Utility with FX :octicons-arrow-right-24:](general-utility-with-fx.md)
912

13+
Perform general math or logic operations on the pixels of an image.
14+
1015
</div>
1116

1217
## Image Projection
@@ -15,6 +20,8 @@
1520

1621
- [:material-map: Map Projecting :octicons-arrow-right-24:](map-projecting-images.md)
1722

23+
Transform the geometry of an image to match a specific map-projection.
24+
1825
</div>
1926

2027
## Spice
@@ -23,4 +30,6 @@
2330

2431
- [:material-chart-bell-curve-cumulative: Bundle Adjustment in __ISIS__ :octicons-arrow-right-24:](bundle-adjustment-in-isis.md)
2532

33+
Line up images by finding their overlaps, and create a mosaic.
34+
2635
</div>

docs/how-to-guides/index.md

Lines changed: 56 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,67 @@
11
# How-To Guides
22

3-
How-to guides are much like recipes in a recipe book. Write how-to docs to solve specific problems quickly, sometimes copy-pastable. Think of how-to guides as preemptive StackOverflow-like problems.
3+
[comment]: <> (These cards are a good place to highlight specific docs with high value, or ones readers commonly want to see)
4+
5+
<div class="grid cards" markdown>
6+
7+
- :octicons-download-24:{ .lg .middle } __Use our script to install ISIS__
8+
9+
---
10+
11+
```sh
12+
bash <(curl https://raw.githubusercontent.com/DOI-USGS/ISIS3/refs/heads/dev/isis/scripts/install_isis.sh)
13+
```
14+
15+
[:octicons-arrow-right-24: More on Installing ISIS](../how-to-guides/environment-setup-and-maintenance/installing-isis-via-anaconda.md)
16+
17+
- :material-data-matrix-edit:{ .lg .middle } __Image Processing__
18+
19+
---
20+
21+
Manipulate pixels, remove noise, and align multiple images together.
22+
23+
[:octicons-arrow-right-24: Work on Images in ISIS](../how-to-guides/image-processing/index.md)
24+
25+
- :octicons-code-square-24:{ .lg .middle } __ISIS Development Guides__
426

27+
---
28+
29+
Learn how to build, write code for, and contribute to ISIS.
30+
31+
[:octicons-arrow-right-24: Develop in ISIS](../how-to-guides/isis-developer-guides/developing-isis3-with-cmake.md)
32+
33+
- :octicons-comment-discussion-24:{ .lg .middle } __I have an Issue!__
34+
35+
---
36+
37+
Learn how to report issues with ISIS and how the maintainers respond to issues.
38+
39+
[:octicons-arrow-right-24: Report an Issue](../how-to-guides/software-management/guidelines-for-reporting-issues.md)
40+
41+
</div>
42+
43+
-----
44+
45+
How-to guides are much like recipes in a recipe book. Write how-to docs to solve specific problems quickly, sometimes copy-pastable. Think of how-to guides as preemptive StackOverflow-like problems.
546

6-
## For Readers
747
[comment]: <> (This is a good place to mention any places for someone to start looking in. Highlight specific docs with high value or we identify readers commonly want to see)
848

9-
Use the table of contents on the left to start browsing guides.
49+
Use the table of contents on the left to start browsing guides. Check out the above cards if you aren't sure where to start. Use the search bar if you're looking for something specific.
50+
51+
-----
1052

11-
## For Authors
53+
??? quote "Want to write a how-to guide?"
1254

13-
Before you start writing a new How-To guide. Make sure what you are writing belongs here. These are similar to getting-started guides, in that they explain to users how to perform some valuable tasks with the software, but distinct in that they:
55+
When contributing documentation, consider what category it should should go in. Docs in the **how-to guides** category should:
1456

15-
1. Solve practical problems for more experienced users
16-
1. Offer more ambiguous starting points; they should be reusable in many different contexts
17-
1. Can be much shorter than getting-started docs.
57+
1. Solve practical problems for more experienced users
58+
1. Offer more ambiguous starting points; they should be reusable in many different contexts
59+
1. Can be much shorter than getting-started docs
60+
1. Some examples:
61+
- How-to: generate an ISD via loads with specific kernels
62+
- How-to: get GEOJSON from ISIS footprints
63+
- Cookbook of common operations in a library
1864

19-
??? Info Examples
20-
* How-to: generate an ISD via loads with specific kernels
21-
* How-to: get GEOJSON from ISIS footprints
22-
* Cookbook of common operations in a library
65+
On the other hand, docs in the **getting started** category detail specific tasks for users who may not have much experience; docs in the **concepts** category provide an understanding of a topic without necessarily going into detail on how to carry out specific tasks.
66+
2367

mkdocs.yml

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -65,10 +65,11 @@ nav:
6565
- ISIS Environment Setup and Maintenance:
6666
- Installing ISIS: how-to-guides/environment-setup-and-maintenance/installing-isis-via-anaconda.md
6767
- Setting up the ISIS Data Area: how-to-guides/environment-setup-and-maintenance/isis-data-area.md
68-
- Using ISIS in other Conda Envs: how-to-guides/environment-setup-and-maintenance/using-isis-in-other-conda-envs.md
69-
- Anaconda in a Network Environment: how-to-guides/environment-setup-and-maintenance/anaconda-in-a-network-environment.md
7068
- SPICE Kernel Updates in ISIS: how-to-guides/environment-setup-and-maintenance/spice-kernel-updates-in-isis.md
69+
- Setting Up ISIS Data for New Missions: how-to-guides/environment-setup-and-maintenance/setup-isis-data.md
7170
- Adding USGSCSM Plugin to ISIS: how-to-guides/environment-setup-and-maintenance/adding-usgscsm-plugin-to-isis.md
71+
- Using ISIS in other Conda Envs: how-to-guides/environment-setup-and-maintenance/using-isis-in-other-conda-envs.md
72+
- Anaconda in a Network Environment: how-to-guides/environment-setup-and-maintenance/anaconda-in-a-network-environment.md
7273
- SPICE:
7374
- Creating Spice Config Files in SpiceQL: how-to-guides/SPICE/creating-spice-config-files-in-spiceql.md
7475
- Using SpiceQL with Other Libraries: how-to-guides/SPICE/using-spiceql-with-other-libraries.md
@@ -83,26 +84,25 @@ nav:
8384
- ISIS Demos:
8485
- Interactive Online Demos: how-to-guides/demos/isis-demos.md
8586
- Software Management:
86-
- Deprecation: how-to-guides/software-management/deprecation.md
87-
- Software Support: how-to-guides/software-management/software-support.md
8887
- Guidelines for Reporting Issues: how-to-guides/software-management/guidelines-for-reporting-issues.md
8988
- Guidelines for Pull Requests: how-to-guides/software-management/guidelines-for-pull-requests.md
89+
- Deprecation: how-to-guides/software-management/deprecation.md
90+
- Software Support: how-to-guides/software-management/software-support.md
91+
- Releases:
92+
- Home: how-to-guides/software-management/releases/index.md
93+
- Releasing ISIS: how-to-guides/software-management/releases/isis-release-process.md
94+
- Releasing Other Astro Software: how-to-guides/software-management/releases/general-release-process.md
9095
- ISIS Release Schedule: how-to-guides/software-management/isis-release-schedule.md
91-
- Releases:
92-
- Home: how-to-guides/software-management/releases/index.md
93-
- Releasing ISIS: how-to-guides/software-management/releases/isis-release-process.md
94-
- Releasing Other Astro Software: how-to-guides/software-management/releases/general-release-process.md
95-
- ISIS Release Schedule: how-to-guides/software-management/isis-release-schedule.md
96-
- LTS Release Process: how-to-guides/software-management/lts-release-process.md
96+
- LTS Release Process: how-to-guides/software-management/lts-release-process.md
9797
- ISIS Developer Guides:
98+
- Developing ISIS3 with cmake: how-to-guides/isis-developer-guides/developing-isis3-with-cmake.md
99+
- ISIS Development on ARM Macs: how-to-guides/isis-developer-guides/developing-mac-m1-arm-systems.md
100+
- ISIS Test Data: how-to-guides/isis-developer-guides/obtaining-maintaining-submitting-test-data.md
98101
- Contributing to ISIS: how-to-guides/isis-developer-guides/contributing-to-isis.md
102+
- Building and Contributing to ISIS Tutorial: how-to-guides/isis-developer-guides/building-and-contributing-to-isis-tutorial.md
99103
- Writing Tests with CTest and GTest: how-to-guides/isis-developer-guides/writing-isis-tests-with-ctest-and-gtest.md
100104
- App Testing CookBook: how-to-guides/isis-developer-guides/app-testing-cookbook.md
101105
- Doxygen Tag Class Requirement: how-to-guides/isis-developer-guides/class-requirements-for-using-doxygen-tags.md
102-
- Developing ISIS3 with cmake: how-to-guides/isis-developer-guides/developing-isis3-with-cmake.md
103-
- ISIS Development on ARM Macs: how-to-guides/isis-developer-guides/developing-mac-m1-arm-systems.md
104-
- Building and Contributing to ISIS Tutorial: how-to-guides/isis-developer-guides/building-and-contributing-to-isis-tutorial.md
105-
- ISIS Test Data: how-to-guides/isis-developer-guides/obtaining-maintaining-submitting-test-data.md
106106
- ISIS Programming Exercises:
107107
- Exercise 1: how-to-guides/isis-developer-guides/exercise-1.md
108108
- Exercise 2: how-to-guides/isis-developer-guides/exercise-2.md

0 commit comments

Comments
 (0)