Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add FAQ page and a caution with using reserved variables #2898

Merged
merged 1 commit into from
Sep 9, 2024

Conversation

aerorahul
Copy link
Contributor

Description

This PR:

  • Creates a standalone page for FAQ and Common issues
  • Adds a block of caution on using variables in a users' bashrc

Fixes: #2850

Type of change

  • Maintenance (documentation update)

Change characteristics

  • Is this a breaking change (a change in existing functionality)? NO
  • Does this change require a documentation update? NO (This is a documentation update)
  • Does this change require an update to any of the following submodules? NO

How has this been tested?

Tested in PR

Checklist

  • Any dependent changes have been merged and published
  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • My changes generate no new warnings
  • New and existing tests pass with my changes
  • I have made corresponding changes to the documentation if necessary

@aerorahul
Copy link
Contributor Author

Copy link
Member

@KateFriedman-NOAA KateFriedman-NOAA left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, thanks @aerorahul !

Copy link
Contributor

@DavidHuber-NOAA DavidHuber-NOAA left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@aerorahul aerorahul merged commit 0953c0f into NOAA-EMC:develop Sep 9, 2024
6 checks passed
@aerorahul aerorahul deleted the feature/doco-faq branch September 9, 2024 17:06
DavidHuber-NOAA added a commit to DavidHuber-NOAA/global-workflow that referenced this pull request Sep 9, 2024
* origin/develop:
  Add FAQ page and a caution with using reserved variables (NOAA-EMC#2898)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

The DATAROOT is not setup correctly while running setup_xml.py
3 participants