Commit graph

843 commits

Author SHA1 Message Date
srcarter3
faf14e1d34
Corrected the EDEX acronym from Enterprise to Environmental 2020-11-18 09:45:35 -07:00
srcarter3
7303fb46a1
Add Java to the list of general requirements 2020-11-18 09:34:11 -07:00
Shay Carter
1eadccdc89 Revamped our CAVE Installation Page
-Change the entire layout to have consistent sections for the three OS's: System Requirements and Download and Installation Instructions.
-Windows now has two distinct installation methods
-Removed RHEL/Centos6 from documention (just say 7)
-Added a General Requirements section that is more directed at hardware (not OS specific)
-Renamed the caveData section to "Local Cache"
-Renamed the AWIPS Data in the Cloud section to "EDEX Connection"
-removed all the tables from the previous formatting, just use section headers, ordered and unordered lists, and notes
2020-11-17 15:04:24 -07:00
srcarter3
77e0a80e21
Change the python-awips link from rtd to our new documentation 2020-11-17 14:06:20 -07:00
srcarter3
b1bfa833af
Removed comment about tab separation for the ldmd.conf as this is incorrect 2020-11-04 15:33:28 -07:00
tiffanycmeyer13
3b285245d1
Merge pull request #298 from Unidata/tiffBuild
In order to add back in the cave/com.raytheon.uf.viz.gisdatastore fea…
2020-09-23 16:03:12 -04:00
Tiffany Meyer
1c6f3f05f5 In order to add back in the cave/com.raytheon.uf.viz.gisdatastore feature for the RPM build, the feature had to be added to the following files:
- cave/build/features.txt
- cave/build/p2-build.xml
- cave/com.raytheon.viz.product.awips/awips.product

Since it already existed in cave/com.raytheon.viz.product.awips/developer.product, it was showing up when deploying from eclipse.
2020-09-23 15:57:47 -04:00
srcarter3
8041a047af
Update python-awips documentation url to new site 2020-09-09 14:19:26 -06:00
srcarter3
b7b6916e75
Update deploy_docs.yml
revert change, meant to do that in an entirely different project!
2020-09-02 13:18:32 -06:00
srcarter3
78e49b5939
Update deploy_docs.yml
changed the publish dir to ./docs/build/html
2020-09-02 13:17:47 -06:00
srcarter3
c6cc7c97a3
Merge pull request #296 from lesserwhirls/searchRedux
Temporary changes that are supposed to bet the search working for awips documentation.
2020-08-04 15:30:46 -06:00
srcarter3
acce80935b
Delete application-0b7df094bf.js
Roll back of the application json file for searching, wasn't in the right location.
2020-08-04 15:29:08 -06:00
Sean Arms
94568fa23a Make sure mkdocs uses our customized javascript file
This change to mkdocs.yml forces mkdocs to override the javascript file
of the same name provided by the theme with the version in this
repository until we regain access the mkdocs unidata theme.
2020-08-04 13:58:34 -06:00
Sean Arms
0f012cd3ec Override theme's base application javascript
The Unidata theme javascript isn't compatible with the version of
mkdocs being used. Starting with mkdocs 0.17, the generated search index
json file located at site/search/search_index.json. However, the themes
application javascript file looks for mkdocs/search_index.json. Because
we cannot update the theme at this point, this commit simply overrides the
javascript file shipped with the theme.
2020-08-04 13:45:51 -06:00
srcarter3
9c6afe57fe
Update index.md
Need to trigger a rebuild for the website to see if the search functionality works, so just added a space at the end of line 3.
2020-08-04 13:32:40 -06:00
srcarter3
e3efe1421c
Create application-0b7df094bf.js
This commit is intended to get the search functionality working on the website again.  This is not the ideal solution -- ideally the mkdocs-unidata theme will be updated and distributed with this change so that the gh-action works with that latest version and the search will work properly.  This file should be removed when that "proper" change has been made and mkdocs-unidata theme has been updated on pip.
2020-08-04 13:29:02 -06:00
Shay Carter
1a4e3c84c5 Small updates to the keyboard shortcuts webpage:
-updated tables to reflect similar information found at: https://vlab.ncep.noaa.gov/web/oclo/awipsfundamentals?page=keyboard-shortcuts#menu
2020-08-04 12:38:32 -06:00
Shay Carter
0727fd14f8 Small change made to the edex purge website:
-updated the logging output for the raw data purging to show the content from the "edex-ingest-purge-[date].log"

Small changes to the mkdocs.yml file:
-commented out the "Supported Data Types" section and subsections
-moved the "Development" section to come before the "Python API" subsection
-made the "Development" section a direct link, instead of a section with only one subsection
-commented out the "COTS and FOSS" subsection from the Appendix
2020-07-28 14:37:58 -06:00
Shay Carter
8800d97d2f Changes to the development webpage:
-modified the markdown.yml file since there is only one webpage under "Development" no need to have a subdirectory
-added title header
-updated repo code line to point to el7 instead of 6
-converted steps from an ordered list into proper sections with subheadings
-added an initial section about removing existing AWIPS instances
-added some steps for setting up eclipse to convert some errors to warnings and to turn off auto building when importing the repos and turn it back on afterwards
-added a section for troubleshooting with a note taken from Jason Burks' tutorials
-added note in the intro section specifying this is a dev only Environment
-bolded the repo in Step 2
-removed Maven from the mentioned installed packages in Step 3 (it's now packaged with eclipse)
2020-07-28 14:19:33 -06:00
Shay Carter
f4257da6ec Small changes to case study webpage:
-replace 'ingest-modes.xml' with 'modes.xml'
-add page breaks between sections
-replace &lt; and &gt; with < and >
-fixed broken link for edex install page
-updated repo link to point to the centos7 version, instead of centos6
2020-07-23 16:47:40 -06:00
Shay Carter
2b212d1b79 Small changes to the EDEX Monitor Users webpage:
-changed subheading from '#' to '##'
-added title header
-added '[]' around data optional
-added a little more descriptive text in the logging example and updated formatting
2020-07-23 14:35:42 -06:00
Shay Carter
d68666c8d0 Changes made to Edex Purging and Retention webpage:
-added title header
-fixed spelling mistakes
-added a "Purge Types" section for the initial text and broke the page into two main sub sections: Processed Data Purging and Raw Data purging
-added description and example of files in ..../base/purge/
-removed text saying purge rules can be accessed in the CAVE localization perspective, because they cannot anymore
-added page breaks between selections
-cleaned up "All Purge Rules" section since now all rules live in one location only by default
-updated the "Frame-Based Purge" with current example and explanation of modTimeToWait tag
-replaced code blocks with html to bold important sections
-added now "Raw Data Purging" information and sections
2020-07-23 14:21:58 -06:00
Shay Carter
b849dab784 This file goes with the previous commit for the new python-awips webpage 2020-07-23 11:28:08 -06:00
Shay Carter
9c88299889 Small change for the python-awips documentation:
-Removed all existing webpages for the python-awips documentation since they were mostly just outdated versions of what exists on our main python-awips page
-created a new webpage python/overview.md which has a short description of python-awips and the link to the current documentation
2020-07-23 11:24:38 -06:00
srcarter3
09d1fb1193
Rolling back previous commit
Adding an external url into the mkdocs file for the python documentation did not work.
2020-07-22 14:52:08 -06:00
srcarter3
692533fc9f
Change python-awips documentation
Point our python-awips link to existing documentation at https://python-awips.readthedocs.io/en/latest/ and commented out previous existing webpages (since they're duplicated, outdated information compared to the other documentation).
2020-07-22 14:48:43 -06:00
Shay Carter
ee10947d75 Significant changes to the Ingest a New Grid webpage:
-added title header
-replaced instances of "edex_static" with "common_static"
-replaced improper ".../grid/models" path with proper ".../grib/models"
-updated note about wgrib2 in Troubleshooting section since we do distribute it
-added page breaks between sections
-fixed mistype of 'filename' to 'filenames'
-edited many of the code blocks to use html so specific sections could be bolded for emphasis
-added a third bullet in the opening text to do with tables
-link all bullets to their corresponding subsections
-changed capitalization and added ':' between code steps
-fixed 'wrd.xml' mispelling
-fixed broken link for editing menus
-add a new section for Add a Table and relocated the first bullet from Troubleshooting, into this new section
-made the Troubleshooting section into a bulleted list
-added description for finding the table info for the wrf.grib example
-change example file location from /staff/mjames to /software/awips2
-divided every section into "Grib Products" and "Grib2 Products" subsections
-added an example grib2 file and added information for every section for grib2
2020-07-21 11:42:16 -06:00
Shay Carter
c032e41bf9 Merge branch 'unidata_18.1.1' of github.com:Unidata/awips2 into unidata_18.1.1
Merge in Tiffany's warngen updates with my edex data distribution files updates
2020-07-15 16:16:52 -06:00
Shay Carter
d0ae1873ca Small change to the following webpages: Docker EDEX, LDM Feeds, and Data Distribution Files:
-added section page breaks for consistency

Changes to Data Distribution Files webpage:
-added title header
-added clarification for header/filename matching
-changed references of "edex_static" to "common_static" because all the files were moved (by Raytheon) not so long ago
-added a new subsection titled "Overview" because the inital description text was so long
-added another subsection titled "Creating a Site Override" to break up the initial section
-updated the output for the files found in base/distribution/ to match current output
-updated the satellite.xml to satellite.gini.xml and changed the markdown code to use html so that I could bold a line in the code block
-updated the "Editing..." section to link back to the "Creating a Site Override" section becasue it references the same idea
-changed the "Editing..." text to clairfy which regex expressions apply to what text (pqact.conf vs distribution files)
-updated the exampls section to show the xml content and then explain it
-updated the text.xml to reflect current content
-fixed improper bold/italic formatting throughout the webpage
-updated grib example to have current content
-created one last subsection for "Additional Information" and updated the bullets to reflect current thinking.  Also added a bullet for a problem I've personally encountered where the distribution regex would not match the filename
2020-07-15 16:09:25 -06:00
Tiffany Meyer
9353da429e Updated the numbered list so it didn't restart 2020-07-13 18:27:44 -04: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
957b948a27 Merge branch 'unidata_18.1.1' of github.com:Unidata/awips2 into unidata_18.1.1 2020-07-13 16:25:54 -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
41ea42dc2b Changes made to the LDM Feeds webpage:
-added title header
-fixed "that" misspelling
-added a bit more informative text to go along with code examples
-created sub-sections for optional LDM feeds
-updated the "Default Feeds" list
2020-07-13 14:16:11 -06:00
Shay Carter
2f3dbb564a Changes made to Docker EDEX webpage:
-added title header for consistency
-added edex version number used with docker build
-used bold for consistency with other pages
-updateded sections in "Mounted Files" section to be real subsections and reformatted the text found within
-updated some text about the edex server that setup.env is pointing to, for clarification
2020-07-10 17:12:16 -06:00
Shay Carter
ab886677b6 Small change that was missed on previous commit, in the example definition the store and serve server comes first and then the ingest and decode server. Had to switch those in the text description that goes with the "Example Installation" seciton. 2020-07-10 14:15:52 -06:00
Shay Carter
8612e76d49 Changes made to Distributed EDEX webpage:
-added title header for consistency
-added a short section about our current EDEX server system
-added a new "Example Installation" section and moved the opening text and edex diagram into this section.  Also moved the "server" sections to be subsections of this example
-removed the machine specs from the server section since they are no longer accurate/relevant
-added server ip addresses as reference for this example only
2020-07-10 13:59:24 -06: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
srcarter3
7b1b6d92d5
Update install-cave.md
Changed "one"  to "on" for the Windows Method 2 install title.
2020-07-07 11:53:15 -05:00
Shay Carter
27fb9eb27e Small changes to the Edex Settings webpage:
-added title header for consistency
-updated code snippets to reflect current state
-small reformatting changes for consistency
2020-06-30 16:22:26 -06:00
Shay Carter
c7e9f7fa75 Changes made to "EDEX Start and Stop" webpage:
-added title header for consistency
-reformated some 'code' sections to bold
-changed small formatting issues for consistency
-changed name of webpage from "EDEX Start and Stop" to "EDEX Basic Commands" in the mkdocs.yml file as well as the title header
2020-06-30 14:42:41 -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
Tiffany Meyer
0b2e651c5a Added instructions on how to edit an existing menu 2020-06-25 14:15:45 -04:00
Shay Carter
de13e32638 Small change to Radar Tools page to add a page break after the initial section, for consistency with other pages.
Changes to the Editing Menus webpage:
-added title header for consistency
-added page breaks for consistency
-updated the documentation in the "Remove..." section to reflect our current version of AWIPS
-completely removed the "Changing the models displayed with D2D bundles" section since it didn't make sense
-replaced it with a section for "Modifying Menus" and added a failry high-level description for that section
-re-named the second section to simply "Removing Menus"
2020-06-24 16:02:41 -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
Tiffany Meyer
3bd7254a06 Added the recommendation of the NVIDIA Graphics Card for the Linux CAVE install 2020-06-24 10:53:50 -04:00
Tiffany Meyer
b3077b708c Commented out the video link and changed localization from LZK to LUB. 2020-06-23 17:17:10 -04: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