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.

Sign up for GitHub

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

Jump to bottom

Fix GHA documentation workflow #2282

Closed
8 of 20 tasks
JohnHalleyGotway opened this issue Sep 28, 2022 · 0 comments · Fixed by #2283
Closed
8 of 20 tasks

Fix GHA documentation workflow #2282

JohnHalleyGotway opened this issue Sep 28, 2022 · 0 comments · Fixed by #2283
Assignees
@JohnHalleyGotway
Labels
component: documentation Documentation issue component: testing Software testing issue priority: high High Priority reporting: DTC NCAR Base NCAR Base DTC Project reporting: DTC NOAA BASE NOAA Office of Atmospheric Research DTC Project requestor: METplus Team METplus Development Team type: enhancement Improve something that it is currently doing
Milestone
MET 11.0.0

Comments

@JohnHalleyGotway
Copy link
Collaborator

Describe the Enhancement

The build_documentation.sh script called by the documentation workflow is not working as expected. After MET#1920 restructured the repository, we failed to update this script accordingly.

Recommend doing so, and adding a check to make sure that docs directory actually exists. Error out if not.

Also include some minor docs changes.

Time Estimate

2 hours

Sub-Issues

Consider breaking the enhancement down into sub-issues.
None.

Relevant Deadlines

List relevant project deadlines here or state NONE.

Funding Source

Define the source of funding and account keys here or state NONE.

Define the Metadata

Assignee

  • Select engineer(s) or no engineer required
  • Select scientist(s) or no scientist required: None needed

Labels

  • Select component(s)
  • Select priority
  • Select requestor(s)

Projects and Milestone

  • Select Repository and/or Organization level Project(s) or add alert: NEED PROJECT ASSIGNMENT label
  • Select Milestone as the next official version or Future Versions

Define Related Issue(s)

Consider the impact to the other METplus components.

Enhancement Checklist

See the METplus Workflow for details.

  • Complete the issue definition above, including the Time Estimate and Funding Source.
  • Fork this repository or create a branch of develop.
    Branch name: feature_<Issue Number>_<Description>
  • Complete the development and test your changes.
  • Add/update log messages for easier debugging.
  • Add/update unit tests.
  • Add/update documentation.
  • Push local changes to GitHub.
  • Submit a pull request to merge into develop.
    Pull request: feature <Issue Number> <Description>
  • Define the pull request metadata, as permissions allow.
    Select: Reviewer(s) and Linked issues
    Select: Repository level development cycle Project for the next official release
    Select: Milestone as the next official version
  • Iterate until the reviewer(s) accept and merge your changes.
  • Delete your fork or branch.
  • Close this issue.
@JohnHalleyGotway JohnHalleyGotway added type: enhancement Improve something that it is currently doing component: documentation Documentation issue component: testing Software testing issue requestor: METplus Team METplus Development Team priority: high High Priority labels Sep 28, 2022
@JohnHalleyGotway JohnHalleyGotway added this to the MET 11.0.0 milestone Sep 28, 2022
@JohnHalleyGotway JohnHalleyGotway self-assigned this Sep 28, 2022
@JohnHalleyGotway JohnHalleyGotway moved this from Backlog to In Progress in MET-11.0.0-beta4 (11/02/22) Sep 28, 2022
JohnHalleyGotway added a commit that referenced this issue Sep 28, 2022
@JohnHalleyGotway
Per #2282, update build_documentation.sh script to error out if the d…
cfcb7a4 
…ocs dir doesn't exist. Note that the documentation workflow SHOULD FAIL since I haven't fixed the path yet. This is a test to confirm that is the case.
JohnHalleyGotway added a commit that referenced this issue Sep 28, 2022
@JohnHalleyGotway
Per #2282, move info about setting env vars to the configuration file…
aa8d4fa 
… overview chapter and update references to it.
JohnHalleyGotway added a commit that referenced this issue Sep 28, 2022
@JohnHalleyGotway
Per #2282, add back in documentation about HiRA for Ensemble-Stat.
c9fb474
JohnHalleyGotway added a commit that referenced this issue Sep 28, 2022
@JohnHalleyGotway
Per #2282, fix the path the docs in MET.
7034c8c
@JohnHalleyGotway JohnHalleyGotway linked a pull request Sep 28, 2022 that will close this issue
Feature 2282 docs #2283
Merged
15 tasks
Repository owner moved this from In Progress to Done in MET-11.0.0-beta4 (11/02/22) Sep 29, 2022
@JohnHalleyGotway JohnHalleyGotway changed the title Fix the documentation GHA workflow Fix GHA documentation workflow Oct 30, 2022
@TaraJensen TaraJensen added reporting: DTC NCAR Base NCAR Base DTC Project reporting: DTC NOAA BASE NOAA Office of Atmospheric Research DTC Project labels Jan 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@JohnHalleyGotway JohnHalleyGotway

Labels
component: documentation Documentation issue component: testing Software testing issue priority: high High Priority reporting: DTC NCAR Base NCAR Base DTC Project reporting: DTC NOAA BASE NOAA Office of Atmospheric Research DTC Project requestor: METplus Team METplus Development Team type: enhancement Improve something that it is currently doing
Projects
No open projects
MET-11.0.0-beta4 (11/02/22)
Status: Done
Milestone
MET 11.0.0
Development

Successfully merging a pull request may close this issue.

Feature 2282 docs dtcenter/MET
2 participants
@JohnHalleyGotway @TaraJensen