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

#738 - Fixed markdown linting violations from landing zone v2 readme document #722

Merged
merged 9 commits into from
Jan 22, 2024

Conversation

jacyang2010
Copy link
Collaborator

@jacyang2010 jacyang2010 commented Nov 23, 2023

This PR is to fix some minor markdown issues from the landingzone v2 readme.md.
See #738

@jacyang2010 jacyang2010 self-assigned this Nov 24, 2023
@jacyang2010 jacyang2010 marked this pull request as ready for review November 24, 2023 20:51
@jacyang2010
Copy link
Collaborator Author

Just a tiny doc pr to make a start here. Please feel free to review it. @fmichaelobrien and @cartyc

Copy link
Contributor

@fmichaelobrien fmichaelobrien left a comment

Choose a reason for hiding this comment

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

Nice, the indenting on that section has been an issue for part of the year - thank you
will hold off on the PR submit until the release - which is still ongoing as of 1600 right now.
Will revisit on monday Jackson for main PRs

@jacyang2010
Copy link
Collaborator Author

I see that and please let me know when it can be merged after release. @fmichaelobrien

@fmichaelobrien
Copy link
Contributor

All good, Jackson the changes look good - I will load the branch to render a quick check
Another release just came in and likely we will check on comms for the final code freeze

#735 (review)

@fmichaelobrien
Copy link
Contributor

fmichaelobrien commented Nov 27, 2023

Jackson, good morning

@fmichaelobrien
Copy link
Contributor

Reviewing the branch - can it be merged with the latest main updates (10 behind)
https://github.com/GoogleCloudPlatform/pubsec-declarative-toolkit/tree/gh333-yw-landingzone-v2-readme-doc

@jacyang2010 jacyang2010 changed the title Fix some landingzone v2 markdown readme issues #738 - Fix some landingzone v2 markdown readme issues Nov 27, 2023
@jacyang2010 jacyang2010 force-pushed the gh333-yw-landingzone-v2-readme-doc branch from 38227c2 to 187a19b Compare November 27, 2023 18:20
@fmichaelobrien
Copy link
Contributor

Jackson, can we spawn off a separate issue/pr for the lz delete with minimal testing. I feel it needs a separate pr like the following

#593

We can keep this pr on readme formatting

@jacyang2010 jacyang2010 changed the title #738 - Fix some landingzone v2 markdown readme issues #738 - Fix markdown linting violations from landing zone v2 readme document Nov 27, 2023
fmichaelobrien
fmichaelobrien previously approved these changes Nov 27, 2023
Copy link
Contributor

@fmichaelobrien fmichaelobrien left a comment

Choose a reason for hiding this comment

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

/lgtm

@fmichaelobrien
Copy link
Contributor

thanks for the split off of the kubectl delete - script section in
#739
and merging with main

@jacyang2010
Copy link
Collaborator Author

jacyang2010 commented Nov 27, 2023

Jackson, can we spawn off a separate issue/pr for the lz delete with minimal testing. I feel it needs a separate pr like the following

#593

We can keep this pr on readme formatting

Done

@fmichaelobrien
Copy link
Contributor

Sounds good, I also inadvertently caused a 2nd merge conflict with Jackson's 722. I was thinking of keeping 744 unmerged until after his so I would take on the merge conflict. All good, next time I will put a heads up comment in the PR.
#744
https://github.com/GoogleCloudPlatform/pubsec-declarative-toolkit/pull/722/files

@jacyang2010 jacyang2010 force-pushed the gh333-yw-landingzone-v2-readme-doc branch from 107f066 to f0864b0 Compare December 1, 2023 20:21
@jacyang2010 jacyang2010 added the documentation Improvements or additions to documentation label Dec 1, 2023
@jacyang2010
Copy link
Collaborator Author

Sounds good, I also inadvertently caused a 2nd merge conflict with Jackson's 722. I was thinking of keeping 744 unmerged until after his so I would take on the merge conflict. All good, next time I will put a heads up comment in the PR. #744 https://github.com/GoogleCloudPlatform/pubsec-declarative-toolkit/pull/722/files

Rebased to latest main.

@jacyang2010 jacyang2010 changed the title #738 - Fix markdown linting violations from landing zone v2 readme document docs(landing-zone-v2): fix markdown linting violations from landing zone v2 readme document Dec 4, 2023
@jacyang2010 jacyang2010 changed the title docs(landing-zone-v2): fix markdown linting violations from landing zone v2 readme document #738 - Fixed markdown linting violations from landing zone v2 readme document Dec 4, 2023
@jacyang2010
Copy link
Collaborator Author

jacyang2010 commented Dec 4, 2023

Hi @cartyc do you mind review and approve this PR as the second reviewer? Thanks a lot.

fmichaelobrien
fmichaelobrien previously approved these changes Dec 4, 2023
Copy link
Contributor

@fmichaelobrien fmichaelobrien left a comment

Choose a reason for hiding this comment

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

/lgtm
However, we need to wait until the current release is merged and the code freeze on main is lifted - before merging this PR

#741

@Michael-McAuley-SSC
Copy link
Collaborator

Michael-McAuley-SSC commented Dec 19, 2023 via email

Copy link
Collaborator

@obriensystems obriensystems left a comment

Choose a reason for hiding this comment

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

/lgtm

Copy link
Contributor

@fmichaelobrien fmichaelobrien left a comment

Choose a reason for hiding this comment

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

/lgtm

@fmichaelobrien
Copy link
Contributor

Merge #738 or#739 first and fix any merge conflict

@tackaberry tackaberry merged commit d5b7614 into main Jan 22, 2024
2 checks passed
@tackaberry tackaberry deleted the gh333-yw-landingzone-v2-readme-doc branch January 22, 2024 19:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fix markdown linting violations from landing zone v2 readme document
8 participants