Skip to content

Conversation

joseph-robertson
Copy link
Contributor

@joseph-robertson joseph-robertson commented Dec 10, 2024

Pull Request Description

Add a new "Repository Development" section to the Advanced Tutorial for describing syncing and testing OpenStudio-HPXML branches.
Also, remove "Installer Setup" -- not sure how relevant this page is anymore.

image

Related Pull Requests

[related PRs from different repositories]

Related Issues

[What issue(s) is the PR addressing]

Checklist

Required:

Optional (not all items may apply):

.. toctree::
:maxdepth: 2

installer_setup
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Removing installer setup. Does anyone actually need/use this? Seems like we only need the OS CLI...

@@ -0,0 +1,43 @@
OpenStudio-HPXML
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Add a new "OpenStudio-HPXML" section to the Advanced Tutorial? Currently it would have two subsections:

  • syncing (this is updating resstock's develop branch to match OS-HPXML's master branch)
  • testing (this is using resstock to test an umerged branch of OS-HPXML)

.. rakefile:
Rakefile
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Remove this assuming we've taken out the installer setup section.

@joseph-robertson joseph-robertson added this to the ResStock v3.5.0 milestone Jan 8, 2025
@rajeee rajeee self-requested a review January 10, 2025 22:56
@rajeee
Copy link
Contributor

rajeee commented Jan 10, 2025

Formatting error; number 3 missing.
image

@joseph-robertson
Copy link
Contributor Author

joseph-robertson commented Jan 27, 2025

3 reasons to branch in resstock (these should be the subsections in the new RTD page):

  • not related to OS-HPXML (branch from resstock develop)
  • you want stuff in OS-HPXML master (branch from latest-os-hpxml)
  • you want stuff in OS-HPXML branch (branch from latest-os-hpxml)
    • here you'd need to issue git subtree command
    • this can be complicated, so we just want to cover the 90% and give warnings about the 10%

@joseph-robertson joseph-robertson changed the title RTD: instructions for OS-HPXML subtree TDG: repository management, including subtree Jan 29, 2025
@joseph-robertson joseph-robertson changed the title TDG: repository management, including subtree TDG: repository development, including subtree Jan 29, 2025
@joseph-robertson joseph-robertson marked this pull request as ready for review January 29, 2025 22:54
Copy link
Contributor

@afontani afontani left a comment

Choose a reason for hiding this comment

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

I made some small language modifications in 861d107. It was nice to read this. You have been taking this task on for a long time and I wasn't sure how this was being done.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants