search

access-ci-org / Integration_Roadmaps

ACCESS Infrastructure Integration Roadmaps
0 stars 9 forks source link

Allocations staff updating the Roadmap to include links for RPs serving as Allocations Contacts. #43

Closed deems412 closed 1 year ago

deems412 commented 1 year ago

Per a discussion with JP, I am updating the Roadmap on behalf of the Allocations team. Please contact me at: deems@psc.edu with any questions or concerns. Thank you!

mollycule commented 1 year ago

While this PR has already been merged, the changes aren't viewable at the official Integration Roadmaps documentation because the check for converting to Read the Docs format failed.

This PR failed the check with this error:

/home/docs/checkouts/readthedocs.org/user_builds/integration-roadmaps/checkouts/43/docs/source/cloud/ACCESS_Allocated_Production_Cloud_-_Integration_Roadmap_Description.md:53: WARNING: 'myst' cross-reference target not found: '../tasks/ACCESS_Allocation_Policies_v1.md' [myst.xref_missing]
/home/docs/checkouts/readthedocs.org/user_builds/integration-roadmaps/checkouts/43/docs/source/compute/ACCESS_Allocated_Production_Compute_-_Integration_Roadmap_Description.md:53: WARNING: 'myst' cross-reference target not found: '../tasks/ACCESS_Allocation_Policies_v1.md' [myst.xref_missing]
/home/docs/checkouts/readthedocs.org/user_builds/integration-roadmaps/checkouts/43/docs/source/storage/ACCESS_Allocated_Production_Storage_-_Integration_Roadmap_Description.md:53: WARNING: 'myst' cross-reference target not found: '../tasks/ACCESS_Allocation_Policies_v1.md' [myst.xref_missing]
/home/docs/checkouts/readthedocs.org/user_builds/integration-roadmaps/checkouts/43/docs/source/tasks/Allocations_RP_Staff_Engagement__v1.md:59: WARNING: 'myst' cross-reference target not found: 'rpaccesscommu-wyz4369.slack.com' [myst.xref_missing]

When I do a local clone of the branch: git clone git@github.com:deems412/Integration_Roadmaps.git

I can easily grep recursively through the files and found these old references:

user@hostname [Integration_Roadmaps] grep -r 'ACCESS_Allocation_Policies' *
docs/source/tasks/Allocations_RP_Staff_Engagement__v1.md:Resource Providers will need to have proper representation for Allocation questions, reviewing RP requests and provide guidance to both ACCESS Allocations staff and review panels. This document details required [Integration Instructions](https://github.com/deems412/Integration_Roadmaps/blob/main/docs/source/tasks/ACCESS_Allocation_Policies_v1.md#integration-instructions), [Operating Instructions](https://github.com/deems412/Integration_Roadmaps/blob/main/docs/source/tasks/ACCESS_Allocation_Policies_v1.md#operating-instructions), [Contact Information](https://github.com/deems412/Integration_Roadmaps/blob/main/docs/source/tasks/ACCESS_Allocation_Policies_v1.md#contact-information), and other [Helpful Resources](https://github.com/deems412/Integration_Roadmaps/blob/main/docs/source/tasks/ACCESS_Allocation_Policies_v1.md#other-helpful-resources) for RPs functioning as *Allocations Contacts*.
docs/source/storage/ACCESS_Allocated_Production_Storage_-_Integration_Roadmap_Description.md:5.  [*ACCESS Allocation Policies v1*](../tasks/ACCESS_Allocation_Policies_v1.md)
docs/source/compute/ACCESS_Allocated_Production_Compute_-_Integration_Roadmap_Description.md:5.  [*ACCESS Allocation Policies v1*](../tasks/ACCESS_Allocation_Policies_v1.md)
docs/source/cloud/ACCESS_Allocated_Production_Cloud_-_Integration_Roadmap_Description.md:5.  [*ACCESS Allocation Policies v1*](../tasks/ACCESS_Allocation_Policies_v1.md)
mollycule commented 1 year ago

Unfortunately because this PR has already been merged, the best path to fix the broken PR is to revert main and resubmit the PR with the additional changes.

@deems412, if the revert is something you are comfortable with doing (and of course have the time to do so), then we would greatly appreciate the help!

Otherwise, I should have time available this week to make the needed additional changes to get the documentation working as expected. :)

deems412 commented 1 year ago

Hi Jess,

Thank you for the assistance here.

I just went back and removed those references to the broken path, but in a "Draft" pull request it failed 4 additional times.

Full transparency - this is my first time submitting a PR; I apologize for my mistakes and asking for your assistance here.

Could you please help with making the appropriate changes in order to pass the readthedocs validation?

Please let me know if you need anything from my end.

Continued best wishes,

Stephen

On Mon, May 29, 2023 at 11:55 PM Jess Haney @.***> wrote:

Unfortunately because this PR has already been merged, the best path to fix the broken PR is to revert main and resubmit the PR with the additional changes.

@deems412 https://github.com/deems412, if the revert is something you are comfortable with doing (and of course have the time to do so), then we would greatly appreciate the help!

Otherwise, I should have time available this week to make the needed additional changes to get the documentation working as expected. :)

— Reply to this email directly, view it on GitHub https://github.com/access-ci-org/Integration_Roadmaps/pull/43#issuecomment-1567721758, or unsubscribe https://github.com/notifications/unsubscribe-auth/AQX3QUYY35SOZ2AATVFQYELXIVVOPANCNFSM6AAAAAAYMBOVH4 . You are receiving this because you were mentioned.Message ID: @.***>

mollycule commented 1 year ago

Hi @deems412,

I am happy to help! This github-based process for Integration Roadmap documentation updates is new to us all, so thank you for your patience while we all work out the hiccups! :laughing:

Something I forgot to point out explicitly in my earlier comment was that the additional changes were needed in all of these files:

I'll create a PR with the changes shortly to better show what I mean. :+1: