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

Updates TOCs to add missing files from #2007 #2149

Merged
merged 9 commits into from
Jan 5, 2017
Merged

Updates TOCs to add missing files from #2007 #2149

merged 9 commits into from
Jan 5, 2017

Conversation

devin-donnelly
Copy link
Contributor

@devin-donnelly devin-donnelly commented Jan 5, 2017

Adds files that failed the new Travis check in PR #2007 that verifies all docs have a TOC entry for titling and findability.


This change is Reviewable

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jan 5, 2017
- docs/user-guide/federation/namespaces.md
- docs/user-guide/federation/replicasets.md
- docs/user-guide/federation/secrets.md
- docs/federation/api-reference/README.md
Copy link
Member

Choose a reason for hiding this comment

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

Should rename to index.md?
Somehow it doesn't work well with TOC https://deploy-preview-2149--kubernetes-io-master-staging.netlify.com/docs/federation/api-reference/readme/ (because title is missing?)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'll try it. I'm leery of renaming things to "index.md" with whatever weird URL-shortening/prettifying has been installed on the Kubernetes website. I'll give it a test run and see if it works.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Also, the title isn't missing; there's just both an explicit title and an H1 heading, which looks terrible.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Okay, it looks like it works.

## Change Pod Definitions

Edit both `show-rc.yaml` and `backend-rc.yaml` and replace the
specified `image:` with the one that you built.
Copy link
Member

Choose a reason for hiding this comment

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

This looks like an example / tutorial. There are some other files under this folder. Do we want to kill it completely? Should we copy it to become a real example / tutorial?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I mentioned that in PR #2007. We can punt this and the configmap/README.md to a different PR.

Corrected link on Guides TOC.
Corrected duplicate title in federation/api-reference/index.md.
@devin-donnelly devin-donnelly merged commit 50d34bd into kubernetes:master Jan 5, 2017
@devin-donnelly devin-donnelly deleted the toc-updates branch January 6, 2017 20:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants