Commit graph

59 commits

Author SHA1 Message Date
Shay Carter
ed9004abe0 Small documentation changes:
- Added a "home" icon for near the top left of the documentation website (there was always a link but it didn't have an icon before, quite strange)
- removed the previous javascript application.js override, because now this is updated and produced correctly in the mkdocs-unidata theme
- updated the copyright from 2020 to 2022
2022-05-26 16:06:33 -04:00
Shay Carter
0c52084b94 A few small documentation updates:
- moved the location of the common-problems.md from the install/ dir to appendix/
- added a section in common problems for disappearing configurations
- updated the cave installation instructions in the system requirements for direct windows install, to include steps on how to turn on the High DPI setting
- updated the educational resources page with our latest awips tips link
2022-05-18 15:15:16 -06:00
Shay Carter
37f31f5e88 Changes to website documentation for upcoming 18.2.1-3 release:
- changes to Procedures and Displays webpage: removed all mention of the word bundle
- updated procedures and displays bundles to match latest CAVE UI
- updated the CAVE and EDEX install pages with the latest version number
2021-12-28 10:43:18 -08:00
Shay Carter
02c5e5936b Add small section for awips tips on the ed res page 2021-11-17 15:00:02 -07:00
Shay Carter
9d8196ee96 Add note about Monterey warning message
- added a section in the Install Cave page in the MacOS subsection mentioning a warning may pop up when running CAVE if running Monterey, but it can be ignored
- added similar section to the Common Problems page
- added a screenshot of the warning provided by user -- **this screenshot should be updated with a real screenshot (not photo from phone) when we have updated our machines to Monterey**
2021-10-26 15:40:53 -06:00
Shay Carter
a01ecc4066 Educational Resources page update:
- modified the Learn AWIPS CAVE Banner image in the elearning section
2021-10-13 14:41:36 -06:00
Shay Carter
7d561055a4 Additional modifications to the new Educational Resources page:
- Added "Access" and "Content" sections for the python-awips notebooks
- added a few screenshots for python-awips notebooks
2021-10-13 12:55:06 -06:00
Shay Carter
532b3f7517 Continuing additions to the new Educational Resources webpage:
- added a prereqs section for the elearning course
- added a few screenshots and additional details for the "design" section
- converted the google form link to html (instead of markdown) to allow the functionality for opening in a separate tab, instead of in the same window
2021-10-13 12:31:55 -06:00
Tiffany Meyer
0baba0b140 Added back in the Import GIS Data documentation and made some changes.
-added more images
-removed the sample attribute since that is no longer a menu option
-commented out the display customization since this is pretty generic to all map products
2021-08-12 16:13:13 -04:00
Tiffany Meyer
bdf615cf50 Minor updates to Display documentation 2021-08-12 15:33:45 -04:00
Tiffany Meyer
33a9560207 Updated the documentation for Displays and Procedures
Removed most language of "bundles" since most of the menu items had updated.
2021-08-11 18:29:29 -04:00
tiffanycmeyer13
dc42127c2a
Merge pull request #343 from srcarter3/website-updates
Install CAVE Webpage updates
2021-07-23 15:24:16 -05:00
Shay Carter
c0c8a060a2 Update the Home page
- update the EDEX schematic shown in the Software Components section
- also, add it to this repo instead of linking to a file on robin
2021-07-23 14:09:11 -06:00
Shay Carter
be270471c5 Small updates for 18.2.1 cave (mac) instructions:
- updated images to remove version number from them
- updated caveMacUserInstall.png to have a border and look a bit more consitent
- added note and image about running CAVE the first time prompts for permission because it was downloaded from the internet
2021-06-22 11:17:22 -06:00
Shay Carter
b292bede4d Merge branch 'unidata_18.1.1' of github.com:Unidata/awips2 into unidata_18.2.1
Brought over latest documentation changes from 18.1.1 to 18.2.1
2021-06-22 10:52:26 -06:00
Shay Carter
e26462658c Update instructions for mac cave install:
- have the instructions for awips-python.pkg come first, so the user doesn't just install cave and then skip this step
- updated with images for the pkg installer, and removed old screenshots, since now it's signed and notarized, those warnings don't appear
2021-06-21 12:57:57 -06:00
Tiffany Meyer
23c8c02d8e Created a new GOES page with updated information for the new GOES E/W products
-Added a lot more RGB products all with images
-Updated the GLM area
-Added new section for DMW
-Added new section for vertical temp/moisture profiles
-Specified which sectors had derived products
-Updated all images
2021-06-16 13:30:46 -04:00
Shay Carter
9c8a3a1c86 Updates to Windows direct installation instructions and new section in the Common Problems page:
- replaced all '> Note' notes with either '!!! note' or '!!! warning' as appropropriate, for more consitency on our website
- updated steps 4 and 5 of the download and installation instructions for the direct windows download to include the new steps to use the new build tools installer to install the proper C++ build tools packages and then run the pip installs
- added screenshots for clarity
- added a new subsection in the common problems page titled "Products Not Loading Properly in Windows" and added some description, and a screenshot of the behavior when jep isn't installed properly
- added a link back to our installation instructions telling them to redo steps 4 and 5
2021-05-20 14:51:18 -06:00
Shay Carter
3c7a375337 Fix a path on one of the gitImport images 2021-05-20 10:56:40 -06:00
Shay Carter
744966c42b Small changes to the ADE webpage based on feedback from Tiffany:
- changed all '>' style notes to the '!!!' style
- moved the "run as root" message to the top of the page and removed it from each subsection
- added 'sudo vi /etc/yum.repos.d/awips2.repo' command in the second section, for clarity
- updated three images: gitImport2 - changed the path, runApplication % debugApplication - extended the view so you can see the project in the project explorer
2021-05-20 10:28:50 -06:00
Shay Carter
57773f3cb6 Updated documentation for our ADE development webpage:
-added notes about running as root when applicable
-added a note to check for libGLU package (because this was an issue I encountered when creating a ADE VM from scratch)
-alphabetized our git clone list and added the goesr repo
-added note about switching branches if desired, before importing into eclipse
-updated the command for running eclipse (no longer has '.sh' on executable)
-Reformated section 5 to have subsections/subheaders
-made paths more specific in section 5 so there is no confusion on where settings are to be found
-added screenshots for importing git repos and cleaning workspace
-reformated section 6 to have subsections/headers
-added screenshots for clarity
2021-05-20 02:24:53 -06:00
Shay Carter
2af518938c Update common problems webpage:
- addeda  "General Troubleshooting" section with info on how to remove caveData
2021-04-22 09:02:18 -06:00
Shay Carter
c74b7f45cc Update to Volume Browser webpage:
- added some text in the beginning describing how/where to find the VB
- added an image highlighting the menus
- moved some text into it's own subsection for the Visual Overview
2021-04-21 16:22:34 -06:00
Shay Carter
ca959805b7 Small changes to the map-views-projections webpage:
- added a subsection to the Map Editor for Adding a New editor and for Renaming an Editor
- Added text to be a little more clear when referring to the file menu (in the add map section as well as the add projection section)
- replaced the old gif for adding a tab with a new one that reflects the current menu options
- added a new gif for renaming map tabs

Added all the images that were supposed to go in with the previous commit for updates to the d2d perspective page
2021-04-01 16:57:26 -06:00
Shay Carter
7d6ced7995 Updates to CAVE install webpage:
-added "Run CAVE" subsections for each of the install options
-added more specific instructions for the Mac install along with screenshots
2021-03-03 11:31:55 -08:00
Shay Carter
effa1ac3be Update to AWIPS User Manual:
docs/index.md:
  -changed the python-awips link from the readthedoc site to our python-awips page in the user manual
  -added a note after python-awips "(a python package)"
  -added a section after "Download and Install EDEX", titled "Working with Python-AWIPS" which links to our python-awips section of the user manual
install/install-cave.md:
  -updated the windows direct install system requirements to include "python3.7" for the miniconda install specification
  -added the "python3.7" specification to step one of the install
  -added a screenshot of the miniconda install showing the checked boxes for path and default python options
  -added the full path for the jdk install under step 2, bullet 2
  -updated the environment variables screenshot to have 181 which is what we're distributing
python/overview.md
  -changed the title from Python API to Python-AWIPS
  -Removed "DAF" from the description and reworded it slightly
  -made the link to our documentation the entire last sentence instead of the word "here", and made the whole sentence bold
mkdocs.yml
  -changed the name of the python outline link from "Python API" to "Python-AWIPS" and moved it up to under the EDEX User Manual
2021-02-24 14:39:52 -08:00
Shay Carter
fd088238b1 Updated the CAVE installation page:
- Updated the general system requirements to specify Java 8
- Updated the general system requirements to include NVIDIA Graphics card
- Updated the note in the general sys reqs to state other graphics cards *may* work, but only NVIDIA is recommended
- Updated the opening description for the Windows OS to state the difference between the two installations and what each is recommended for
- Updated the VM installtion instructions at the end, for the "running CAVE" instructions to specify "Once in the VM"
- Updated the Direct Installtion System Requirements to have version numbers and 64-bit for all relevent software
- Added the JDK as a system req
- Added that miniconda needs to be in the PATH as a req
- Added PYTHONPATH as a required var (not just PYTHONHOME)
- Updated the installation instructions to include all 6 steps
- Added proper links for the miniconda and java jdk installtion
- Removed any and all warnings about jep not working
2020-12-09 09:49:17 -07:00
Tiffany Meyer
f9fd8b5f48 Small updates to warngen page to fix syntax and update some verbage 2020-07-13 18:15:53 -04:00
Tiffany Meyer
e566329642 Updated the warngen page with new text, added new youtube video 2020-07-13 16:17:41 -04:00
Shay Carter
331b1746e4 Updated the screenshots for the Windows CAVE Start Up Error page.
Added soft shadow borders to images so they don't blend in directly with the white webpage background.
2020-07-09 12:26:49 -06:00
Shay Carter
c8131af680 Changes to the Import/Export webpage:
-add title header for consistency
-added text to first subsection explaining the png and gif exports
-added note for Mac OS saying it does not support this functionality
-updated screenshot for export images
-changed the kml section to be more consistent (italics v. quotes, adding the menu location in-text instead of a header)
-updated the "Import Formats" and "Export Formats" sections with current information and formatting and added new screenshots
2020-06-30 13:56:07 -06:00
Shay Carter
92eaa8a020 Small change to the home page:
-added a note to disclose that our version of awips is non-operational and some functionality may not be available

Changes to the localization webpage:
-added title header
-reworded connection to talk about OAX instead of BOU because that's the current default
-updated connection screenshot
-fixed "canbe" misspelling
2020-06-25 17:03:56 -06:00
Shay Carter
719ac6c6da Made changes to the Radar Tools webpage:
-added title header for consistency
-added menu screenshot w/highlighted tools
-re-ordered VR Shear to match menu order
-added section dividers for consistency
-updated opening description
-changed formating of DMD,MD,TVS section
-made Radar Controls section have sub-headings
-added sections or DMD, MBA, SRM and SAILS
-changed title of VR-SHear section to match menu option
-updated Radar Display Controls screenshot
2020-06-24 15:09:13 -06:00
Shay Carter
4af07b3fab Changes to the Display Tools webpage:
-added section header for consistency
-added section page breaks for consistency
-updated screenshot w/highlighted tools to help describe what this section is about
-updated the opening description, and added a reference & link to the "Radar Tools" section
-moved the "Time of Arrival/Lead Time" section to match its place in the Tools menu
-updated text descriptions for the "Text Window" and "Text Workstation" (didn't exist previously) sections
-added screenshot for the Text Workstation section
-added imbedded link for the Text Window section
2020-06-24 11:03:33 -06:00
Shay Carter
445915637c Changes made to the Volume Browser webpage (d2d-gridded-models.md):
-added a labeled screenshot of the Volume Browser to make the documentation easier to follow
-added in-text links to subsections
-added section breaks to be consistent with other pages
-completed the Volume Browser Menu Bar section to include the last three options (Tools, Display Types, Animation Types) and added subsection links
-added screenshots for each menu subsection
-added the "choose By ID" section in VB Tools, copied from the Display Tools Webpage
-Fixed the starting sentence in "Plan View" section to make sense, and took out references to the "Planes" documentation since that doesn't exist at this time
2020-06-23 12:30:54 -06:00
Shay Carter
752ede0356 Created a new webpage for "Common Problems".
Added the symptoms and solutions for the IPv6 problem on Windows 10 machines.
2020-06-22 16:11:32 -06:00
Shay Carter
88e5ac064a Updated the GOES 16/17 webpage:
-updated opening text to descripe Satellite Menu
-updated screenshot of menu options to be current
-updated the pattern action
-updated sections to include images of AK and HI
-made sections for "Ind Channels" and "RGB Composites" and made existing sections into subsections of those
-moved the warning for RGB images above the sample screenshots
-changed 'u' to a proper mu symbol
-updated sections and removed the "NOAAPort Provisional Products" and "L2+" Sections and combined everything with existing sections into "Ind. Channels", "RGB Composites", "Channel Diffs", and "Derived Products"
-added new text for RGBs, derived products and channel diffs.
-added a note for channel diffs that this relies on client side installation of jep which is troublesome on windows and mac
-added link to CIRA's "Quick Guides" for derived products
-updated the HDF5 locations
-updated the GLM text and menu screenshots
-removed the DMW section for now (left a comment for the section header to re-enable and fill out if we add DMW products to AWIPS)
2020-06-18 17:36:49 -06:00
Shay Carter
05a4b5e02e Small change to the NSHARP webpage to make an image appear, there was a small misspelling which was causing a dead link. 2020-06-17 11:30:38 -06:00
Shay Carter
bcc7507624 Changes made to the Nsharp webpage:
-removed the last option in the list for how to access the nsharp viewer, this was not valid
-updated the second last option to say both the "Tools" and "Models" menus can be used to access the VolumeBrowser
-added additional text and screenshots to explain the Volume Browser because it is not that straight forward
-added a screenshot for the nsharp toolbar icon
-added page breaks to be consistent with other pages
-reformatted, rearranged and clarified the "NSHARP Config" section
-clarified Skew-T Display text and added link to the previous section
-Update all references to the NSHAPR Overview page to be actual links
-Remove all references to "NSHARP schematic image" and add all new screenshots for each of the subsections
2020-06-16 18:12:00 -06:00
Shay Carter
d228124088 Changes to the Localization Perspective webpage:
-added initial header to be consistent with other markdown pages
-changed "...lower level..." to "...higher level..."
-changed some italics to bold for consistency with other pages
-added menu location description for the Localization Perspective
-fixed "made" to "make"
-changed some description text in "Customizing CAVE Menus" to make sense
-added screenshot for that section
-commented out the NCP section since it doesn't apply to our current version
2020-06-11 18:56:04 -06:00
Shay Carter
6c80eeeb3f Small update to the Maps, Views, Projections webpage:
-added the initial header (#) at the top of the file to be consistent with other .md files

Changes to Bundles and Projections page:
-added the initial header (#) to be consistent with other .md files
-removed instances of ">" and replaced them with ">" for easier readability and to be consistent with other .md files
-fixed misspelling in opening description ('a' > 'as')
-updated the subsection headings to match the file menu options in CAVE
-updated the first screenshot for deleting bundles to be consistent with how CAVE currently looks
-update text referring to menu items to match CAVE
2020-06-10 17:22:19 -06:00
Shay Carter
9c47b1181c One change to D2D Perspective page that didn't make it with the previous commit
-updated the Image Combination section to remove the mention of an icon on the toolbar because it is no longer there

Updates to the Maps, Views, Projections webpage
-fixed the misspelling of "default" in the opening description
-updated the list of projections to match CAVE exactly
-updated the image for the file menu
-updated the image for the Create Projection dialog
2020-06-10 16:53:09 -06:00
Shay Carter
de1a117d0b Numerous changes to the "D2D Perspective" web page:
-Updated the screenshot with an up to date image of the current toolbar and menus (docs/images/caveHeader.png)
-Updated the opening text to have the correct system menus, have the correct data menus (with broken links removed), have the correct toolbar description, and a note with the discrepancies between OS versions.
-Updated the Resource Stack section to have a link to the Right-click Functionality
-Changed all the submenus to have the proper designation (###) so they show up in the outline
-Changed the "Left-Click Background..." section to be "Right-Click Background..." and updated its description
-Added "Display Menu:" text to the submenu items that were specifically from the display menu
-Reordered some sections to show up accordingly under Resource Stack or Display menu Sections
-Updated the Product Browser section to include icon in text for opening the browser, and the menu lo
cation
-Updated the Selections list to remove VIIRS since that's no longer shown.
-Added a note for the differences between Mac/Linux and Windows (GFE availability)
-Commented out the Switch Pane Layouts because this isn't specified in the Options menu anymore
-Added a section for the Options menu and made Time Options, Image Combination, Dipslay Props, Loop P
rops, Image Props, Set time, and Set Background Color as subsections
-Commented out the Data Scale section since this is no longer in our distribution
-Updated the Image Combination text as there is no longer a toolbar icon
-Updated the Image Properties section to include the toolbar icon in the description.
-Updated the Switching Perspectives section to have a sentence describing the menu location, in similar fashion to the Cave Preferences section (next section). Also updated the description text to only mention GFE and Localization perspectives (the others are no longer available).  Added a note with the differences between OS versions.  And updated the screenshot with a current one.
-Updated the Load Mode section to more clearly describe where and how to access it.
2020-06-10 16:18:44 -06:00
mjames-upc
9271bd5950 doc update, version update 18.1.1-4 2018-12-21 10:42:26 -07:00
Michael James
953834d480 doc updates for windows 18.1.1 release 2018-09-19 13:52:58 -06:00
Michael James
d0a1b2b927 docs: cave hazard services documents 2018-09-04 13:21:31 -06:00
Michael James
57e9c55649 archive server and cave display document 2017-10-25 13:50:56 -06:00
Michael James
ecc741d40d awips2_distributed.png edit 2017-09-27 10:34:17 -06:00
Michael James
2fcc4432c6 distributed-computing doc update 2017-09-27 10:32:13 -06:00
Michael James
5656a7296d doc update for distributed edex 2017-09-26 21:24:00 -06:00