Content edits for #71990

department-of-veterans-affairs / va.gov-team

Public resources for building on and in support of VA.gov. Visit complete Knowledge Hub:

https://depo-platform-documentation.scrollhelp.site/index.html

283 stars 204 forks source link

Content edits for #71990 #72001

Closed johnny-jesensky-adhoc closed 4 months ago

johnny-jesensky-adhoc commented 11 months ago

Description

This ticket is to make the updates requested based on this Github ticket.

Details

Add more information about why outbound requests should (must?) be routed via the fwdproxy

Add a basic explanation of the network architecture, linking out to more detailed resources

Improve the configuration link in the AddinganewExternalServiceIntegration-ForwardProxy section to be to where the configuration is added

SME:

Kyle Matheny

Tasks

[x] Review Github ticket
[x] Determine SMEs who can help write the content (perhaps go to one of the engineering CoPs
[x] Assign SME to write content
[ ] Review the content
[ ] Get Adrian Rollett (individual who submitted the ticket) to review changes
[ ] Prepare page for deployment

Acceptance Criteria:

[x] SMEs have been identified who can help write content
[ ] Page has been deployed with changes

johnny-jesensky-adhoc commented 11 months ago

Hey team! Please add your planning poker estimate with Zenhub @BSmolensky @laucon @taylojill

CherylEvans commented 7 months ago

@acrollet Good morning, Adrian! I realize you’re not in until Monday, but I want to take a moment and introduce myself. I am new to the Platform Content team and am working on ticket 72001 (Content edits for ticket 71990).

I reviewed the ticket and made a draft copy of the source page, which I will use to update the source page before publishing it on the PW.
My next step is to work with you to determine the SME who will help write the updated content and coordinate our efforts.
Once the assigned SME writes the updated content, you and I will review it to ensure it meets your content, style, and tone expectations.
Once reviewed, I’ll move the changes from the draft page to the source page.
The Platform Website page will update when Platform Content runs our daily deployment.

Please let me know what time works best to discuss the way ahead or reply in the thread, and we can go from there. Thank you!! FYSA @jknipes @johnny-jesensky-adhoc

acrollet commented 7 months ago

Hi @CherylEvans ! I would reach out to the Platform devops team for support on this issue. thanks!

CherylEvans commented 7 months ago

@jknipes I reached on to Platform Support as directed by Adrian Rollett in this: (LINK) Here the Link to Platform Support ticket

CherylEvans commented 7 months ago

I contacted Peter Hill, who took the reins, to discuss this at their planning meeting and determine which SME is taking on the effort. They will discuss 4/18/24 in DevOps CoP

CherylEvans commented 6 months ago

@jknipes Per LINK, @pjhill will help create the documentation.

jknipes commented 6 months ago

unable to complete due to being blocked by SME, moving to Backlog

jknipes commented 6 months ago

Automation added sprint date to this ticket. We have removed the date until we are certain ticket can be worked on.

CherylEvans commented 6 months ago

@jknipes @pjhill Update: "Good morning, Peter. I’m working on ticket 72001 and wanted to see if you are ready for me to review the content you created. Here is the Slack discussion link. Thanks again for your help with this effort!" Slack LINK

JoeTice commented 6 months ago

We'll get this into the backlog and onto the schedule

CherylEvans commented 6 months ago

@jknipes Update: @little-oddball commented to @JoeTice "FYSA. Based on the updates in the ticket, I would say this hasn't made it to a Reliability Sprint to be worked as of yet. Just raising awareness to ensure some communication and coordination between content and reliability teams." Joe commented: "Rgr, thanks for the heads up, we'll get this into the backlog and get is scheduled" Slack LINK Joe, it looks like this is blocked for now. Thoughts?

jknipes commented 6 months ago

Currently unable to complete due to being blocked by SME, moving to Backlog Need to confirm inclusion in future sprint with @JoeTice

jknipes commented 5 months ago

Sprint May 23 was auto-assigned, we have removed the dates from this ticket, which is still blocked. Hoping to add this ticket to sprint beginning 6/6

jknipes commented 5 months ago

@ph-One

jknipes commented 4 months ago

@ph-One we will work with you in Sprint 5, beg 7/4

ph-One commented 4 months ago

I have completed my updates

CherylEvans commented 4 months ago

I worked with @ph-One to make the updates. Slack Link The document was published this afternoon—closing ticket.