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 missing docs that should be on 1.10 release branch #14996

Merged
merged 2 commits into from
Apr 12, 2022

Conversation

raskchanky
Copy link
Contributor

@raskchanky raskchanky commented Apr 11, 2022

I'm not confident that I've done this correctly, but let me detail what I've actually done and maybe someone can correct me if I'm wrong. The goal here is to add docs to the 1.10 release branch that should be there, but aren't.

For context, see the discussion starting here #14927 (comment)

I originally attempted to calculate the diff between the release/1.10.x and stable-website branches, constrained to the website directory, but that proved an exercise in futility. The resulting diff I got wouldn't apply cleanly to release/1.10.x, which made me feel like I was going about this wrong.

In the end, instead of diffing release/1.10.x and stable-website, I diffed release/1.10.x and main, figuring that all docs changes would've been merged to main anyway. Here are the exact commands I used, starting from a freshly updated main branch:

$ git checkout -b release/1.10.x origin/release/1.10.x
$ git checkout -b add-missing-docs
$ git diff --output=website.patch release/1.10.x..main -- website
$ git apply website.patch
$ rm website.patch

I think this should have the effect of bringing over all the changes that have been made to the website directory on the main branch into the release/1.10.x branch. I'm not certain I got this correct however, and would appreciate some extra eyes. The litmus test I was using was checking to see if the MFA docs I wrote were added, since those should be on the release/1.10.x branch.

@raskchanky raskchanky requested review from mladlow and removed request for mladlow April 11, 2022 20:08
@raskchanky
Copy link
Contributor Author

Tagging @kalafut @ldilalla-HC @peaceofthepai @mladlow here at Meggie's request.

Copy link
Contributor

@stevendpclark stevendpclark left a comment

Choose a reason for hiding this comment

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

Looked through the changes to all relevant docs for the crypto-sec team, (SSH, PKI, managed keys, hsm, seal). All these changes look good to me and should appear on 1.10 branch.

I also agree with the technique used to generate the diff, for at least the crypto-sec related stuff nothing will be backported that is targeting 1.11 that I can see.

Copy link
Contributor

@kalafut kalafut left a comment

Choose a reason for hiding this comment

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

A quick diff against stable-website looked reasonable. I'm good with merging. We can still fix things up if we discover missed items.

@vercel vercel bot temporarily deployed to Preview – vault April 12, 2022 16:00 Inactive
@vercel vercel bot temporarily deployed to Preview – vault-storybook April 12, 2022 16:00 Inactive
@raskchanky raskchanky merged commit 643fee1 into release/1.10.x Apr 12, 2022
@raskchanky raskchanky deleted the add-missing-docs branch April 12, 2022 18:47
Copy link
Contributor

@kitography kitography left a comment

Choose a reason for hiding this comment

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

I'm too late, this is cool updates and correct, but submitting review so typo-references exist.

@mladlow
Copy link
Contributor

mladlow commented Apr 26, 2022

I'm late to this party but thanks for following up on this @raskchanky !

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

Successfully merging this pull request may close these issues.

5 participants