Skip to content

Commit

Permalink
Updated changes to links and Contribution Guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
jdkublnick committed Mar 26, 2024
1 parent 3660abc commit e4cfbb4
Show file tree
Hide file tree
Showing 7 changed files with 11 additions and 198 deletions.
8 changes: 4 additions & 4 deletions doc/UsersGuide/source/Backgroundinfo/TechnicalOverview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ It is maintained by EMC and DTC with developments and contributions from the :te

The HAFS repository only hosts major feature branches (e.g., ``feature/hafs_nesting``) that require active group collaborations. Individual developers can work on feature branches in their personal HAFS forks.

.. figure:: https://raw.githubusercontent.com/wiki/hafs-community/HAFS/docs_images/hafs_branching_diagram.png
.. figure:: https://github.com/hafs-community/HAFS/wiki/docs_images/hafs_branching_diagram.png
:width: 50 %
:alt: Example HAFS Branching Diagram

Expand All @@ -65,7 +65,7 @@ HAFS Directory Structure

The following shows the names of the files and directories in the ``HAFS`` repository.

.. figure:: https://raw.githubusercontent.com/wiki/hafs-community/HAFS/docs_images/hafs_directory_structure.png
.. figure:: https://github.com/hafs-community/HAFS/wiki/docs_images/hafs_directory_structure.png
:width: 50 %
:alt: HAFS directory names and explanations (updated 06/29/2023)

Expand All @@ -78,7 +78,7 @@ HAFS Submodules

HAFS contains the following subcomponents:

.. figure:: https://raw.githubusercontent.com/wiki/hafs-community/HAFS/docs_images/hafs_submodules.png
.. figure:: https://github.com/hafs-community/HAFS/wiki/docs_images/hafs_submodules.png
:width: 75 %
:alt: HAFS Subcomponents/Submodules (updated 11/02/2021)

Expand All @@ -88,6 +88,6 @@ HAFS contains the following subcomponents:
HAFS Workflow Schematic
========================

.. figure:: https://raw.githubusercontent.com/wiki/hafs-community/HAFS/docs_images/hafs_workflow_schematic.png
.. figure:: https://github.com/hafs-community/HAFS/wiki/docs_images/hafs_workflow_schematic.png
:width: 75 %
:alt: HAFS Workflow Schematic
97 changes: 0 additions & 97 deletions doc/UsersGuide/source/BuildingRunningTesting/GitHubBasicSteps.rst

This file was deleted.

This file was deleted.

6 changes: 2 additions & 4 deletions doc/UsersGuide/source/BuildingRunningTesting/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ Building, Running, and Testing HAFS
.. toctree::
:maxdepth: 3

ExtQuickStart
GitHubBasicSteps
QuickStart
RegressionTest
HAFSCodeContributionGuidelines
ExtQuickStart
RegressionTest
4 changes: 2 additions & 2 deletions doc/UsersGuide/source/Reference/ReferenceMaterials.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ Guidance Documents

- `NCO Implementation Standards <https://www.nco.ncep.noaa.gov/idsb/implementation_standards/>`__
- `Recommendation for Adoption of NCEP EE2 Process Document <https://drive.google.com/file/d/1oLi3yH11sN2HamScB2SNrgHXmj0HYKol/view?usp=sharing>`__ *
- `Code Management of Repositories Under EMC Management Using GitFlow <https://accounts.google.com/v3/signin/identifier?continue=https%3A%2F%2Fdocs.google.com%2Fdocument%2Fd%2F1H5McooP-ZmDIOhcy4zJwdFVk3DyjbJt_Nyqj4QGBRBU%2Fedit%3Fusp%3Dsharing&followup=https%3A%2F%2Fdocs.google.com%2Fdocument%2Fd%2F1H5McooP-ZmDIOhcy4zJwdFVk3DyjbJt_Nyqj4QGBRBU%2Fedit%3Fusp%3Dsharing&ifkv=ATuJsjySBIW7MoXmDP_KmBbGBczhhgkGy60rTdEICBP_OLhZpvc0bLOwNgprJ80T5Uglzl5y87eaLw&ltmpl=docs&osid=1&passive=1209600&service=wise&flowName=GlifWebSignIn&flowEntry=ServiceLogin&dsh=S1560513977%3A1710346580280798&theme=mn&ddm=0>`__ *
- `EMC Github Repository Code Management <https://accounts.google.com/v3/signin/identifier?continue=https%3A%2F%2Fdocs.google.com%2Fdocument%2Fd%2F1leuJh1qVz2raTkUJz4CQf68ktqNHKEUsWrgPNtVaIH0%2Fedit&followup=https%3A%2F%2Fdocs.google.com%2Fdocument%2Fd%2F1leuJh1qVz2raTkUJz4CQf68ktqNHKEUsWrgPNtVaIH0%2Fedit&ifkv=ATuJsjyM4ZuuN2P-88qyri0BCZF-pyBOPv4iNcy65bitW34nUflE9Q6jFLywM-gtzPr_o7RF8qPbfA&ltmpl=docs&osid=1&passive=1209600&service=wise&flowName=GlifWebSignIn&flowEntry=ServiceLogin&dsh=S755710614%3A1710346580278246&theme=mn&ddm=0>`__ *
- `Code Management of Repositories Under EMC Management Using GitFlow <https://docs.google.com/document/d/1H5McooP-ZmDIOhcy4zJwdFVk3DyjbJt_Nyqj4QGBRBU/edit?usp=sharing>`__ *
- `EMC Github Repository Code Management <https://docs.google.com/document/d/1leuJh1qVz2raTkUJz4CQf68ktqNHKEUsWrgPNtVaIH0/edit>`__ *

\* Requires NOAA email for access

Expand Down
2 changes: 1 addition & 1 deletion doc/UsersGuide/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@
]

linkcheck_allowed_redirects = {r"https://github\.com/hafs-community/HAFS/wiki/.*":
r"https://raw\.githubusercontent\.com/wiki/hafs-community/HAFS/.*",
r"https://raw\.githubusercontent\.com/wiki/hafs-community/HAFS/.*"
}

# -- Options for HTML output -------------------------------------------------
Expand Down
10 changes: 2 additions & 8 deletions doc/UsersGuide/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,8 @@ HAFS User's Guide (|version|)
:numbered:
:maxdepth: 3




Backgroundinfo/index
BuildingRunningTesting/index
CustomizingTheWorkflow/index
Reference/index




ContributorsGuide/index
Reference/index

0 comments on commit e4cfbb4

Please sign in to comment.