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

docs: GKE - fix some indentation, specify bash code segments #13645

Merged
merged 1 commit into from
Oct 21, 2020

Conversation

ti-mo
Copy link
Contributor

@ti-mo ti-mo commented Oct 20, 2020

For #13627.

Does what it says on the tin. The content of the GKE getting-started guide itself is still 100% correct as far as I can tell.

There's still some weird indentation going on in the connectivity test block, but looks like that's caused by the use of only, which requires the subsequent parsed-literal block to be indented. Haven't found a way to unindent the rendered text, but that's super minor.

For cilium#13627

Signed-off-by: Timo Beckers <timo@isovalent.com>
@ti-mo ti-mo requested a review from a team as a code owner October 20, 2020 13:33
@maintainer-s-little-helper maintainer-s-little-helper bot added the dont-merge/needs-release-note-label The author needs to describe the release impact of these changes. label Oct 20, 2020
@ti-mo ti-mo mentioned this pull request Oct 20, 2020
20 tasks
@pchaigno pchaigno added area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. release-note/misc This PR makes changes that have no direct user impact. labels Oct 21, 2020
@maintainer-s-little-helper maintainer-s-little-helper bot removed the dont-merge/needs-release-note-label The author needs to describe the release impact of these changes. label Oct 21, 2020
@maintainer-s-little-helper maintainer-s-little-helper bot added this to Needs backport from master in 1.9.0-rc3 Oct 21, 2020
@maintainer-s-little-helper maintainer-s-little-helper bot added this to Needs backport from master in 1.8.5 Oct 21, 2020
@pchaigno
Copy link
Member

I'm not seeing any difference in the rendered version before and after this PR. Should I be looking at something else?


image

@ti-mo
Copy link
Contributor Author

ti-mo commented Oct 21, 2020

I'm not seeing any difference in the rendered version before and after this PR. Should I be looking at something else?

Nope, this is just about the indentation in the .rst file. For some reason, the blocks I marked as bash code were indented with 3 spaces instead of 4 everywhere else in the document. 🤷

@aanm aanm merged commit 0dd00f3 into cilium:master Oct 21, 2020
@joestringer
Copy link
Member

Nope, this is just about the indentation in the .rst file. For some reason, the blocks I marked as bash code were indented with 3 spaces instead of 4 everywhere else in the document. shrug

@ti-mo weirdly 3-space indentation is very common in the tree for sphinx code, and at least personally I've found this to more reliably provide the indentation that we want (with the rendering we want).

@nathanjsweet nathanjsweet mentioned this pull request Oct 22, 2020
25 tasks
@ti-mo ti-mo deleted the pr/tb/gke-docs-nit branch October 22, 2020 11:52
@maintainer-s-little-helper maintainer-s-little-helper bot moved this from Needs backport from master to Backport pending to v1.8 in 1.8.5 Oct 22, 2020
@maintainer-s-little-helper maintainer-s-little-helper bot moved this from Needs backport from master to Backport pending to v1.9 in 1.9.0-rc3 Oct 22, 2020
@maintainer-s-little-helper maintainer-s-little-helper bot moved this from Backport pending to v1.8 to Backport done to v1.8 in 1.8.5 Oct 31, 2020
@maintainer-s-little-helper maintainer-s-little-helper bot moved this from Backport pending to v1.9 to Backport done to v1.9 in 1.9.0-rc3 Oct 31, 2020
@maintainer-s-little-helper maintainer-s-little-helper bot moved this from Backport pending to v1.9 to Backport done to v1.9 in 1.9.0-rc3 Oct 31, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. release-note/misc This PR makes changes that have no direct user impact.
Projects
No open projects
1.8.5
Backport done to v1.8
1.9.0-rc3
Backport done to v1.9
Development

Successfully merging this pull request may close these issues.

None yet

6 participants