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

Getting Started Guide style update #18181

Merged

Conversation

karlkfi
Copy link
Contributor

@karlkfi karlkfi commented Dec 4, 2015

  • Don't indent top-level lists
  • Use 2 space list item indentation, unless using multi-line items, then use 4 space indents
  • Use underline for page title
  • Auto-generate table of contents
  • Start with lvl 2 headers (lvl 1 headers look too much like the page title)
  • Empty line before new lists

The 4-space list indent is critical to how redcarpet renders lists as html on kubernetes.io. The rest are just for stylistic consistency.

- Don't indent top-level lists
- Use 2 space list item indentation, unless using multi-line items, then use 4 space indents
- Use underline for page title
- Auto-generate table of contents
- Start with lvl 2 headers (lvl 1 headers look too much like the page title)
@karlkfi karlkfi added kind/documentation Categorizes issue or PR as related to documentation. team/mesosphere labels Dec 4, 2015
@karlkfi karlkfi assigned karlkfi and unassigned karlkfi Dec 4, 2015
@k8s-github-robot
Copy link

Labelling this PR as size/L

@k8s-github-robot k8s-github-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Dec 4, 2015
@k8s-bot
Copy link

k8s-bot commented Dec 4, 2015

GCE e2e build/test failed for commit c3c7c81.

@karlkfi
Copy link
Contributor Author

karlkfi commented Dec 4, 2015

e2e flake or bug in master:

Summarizing 1 Failure:

[Fail] Kubectl client Kubectl run job [AfterEach] should create a job from an image when restart is Never [Conformance] 
/go/src/k8s.io/kubernetes/_output/dockerized/go/src/k8s.io/kubernetes/test/e2e/util.go:1159

Ran 116 of 206 Specs in 612.750 seconds
FAIL! -- 115 Passed | 1 Failed | 2 Pending | 88 Skipped 

@karlkfi
Copy link
Contributor Author

karlkfi commented Dec 4, 2015

This will need to be cherry-picked to release-1.1 and then the gh-pages updated in order to get this to kubernetes.io

@jdef jdef assigned karlkfi and unassigned jdef Dec 4, 2015
@karlkfi karlkfi assigned bgrant0607 and unassigned karlkfi Dec 4, 2015
@karlkfi
Copy link
Contributor Author

karlkfi commented Dec 4, 2015

Since this modifies the guide readme, can you take a look @bgrant0607 ? The changes are pretty trivial, just style and formatting. I wasn't ambitious enough to refactor all the docs...

@bgrant0607 bgrant0607 assigned erictune and unassigned bgrant0607 Dec 4, 2015
@erictune
Copy link
Member

erictune commented Dec 7, 2015

lgtm

@erictune erictune added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 7, 2015
@k8s-github-robot
Copy link

Automatic merge from submit-queue

k8s-github-robot pushed a commit that referenced this pull request Dec 8, 2015
@k8s-github-robot k8s-github-robot merged commit 929ab32 into kubernetes:master Dec 8, 2015
@karlkfi karlkfi deleted the guide-spacing branch December 8, 2015 00:02
k8s-github-robot referenced this pull request Dec 9, 2015
…8181-upstream-release-1.1

Auto commit by PR queue bot
karlkfi pushed a commit to mesosphere-backup/kubernetes that referenced this pull request Dec 9, 2015
s-urbaniak pushed a commit to mesosphere-backup/kubernetes that referenced this pull request Dec 10, 2015
shyamjvs referenced this pull request in shyamjvs/kubernetes Dec 1, 2016
…pick-of-#18181-upstream-release-1.1

Auto commit by PR queue bot
shouhong referenced this pull request in shouhong/kubernetes Feb 14, 2017
…pick-of-#18181-upstream-release-1.1

Auto commit by PR queue bot
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/documentation Categorizes issue or PR as related to documentation. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants