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

Remove self-links with domain names in docs #4299

Merged
merged 20 commits into from
Jul 10, 2017
Merged

Remove self-links with domain names in docs #4299

merged 20 commits into from
Jul 10, 2017

Conversation

ahmetb
Copy link
Member

@ahmetb ahmetb commented Jul 6, 2017

Fixes #4191. Skipping the tutorials we import from kubernetes/examples.
This helps with staging/migration tests better.


This change is Reviewable

Fixes #4191. Skipping the tutorials we import from kubernetes/examples.

Signed-off-by: Ahmet Alp Balkan <ahmetb@google.com>
@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jul 6, 2017
Copy link
Contributor

@chenopis chenopis left a comment

Choose a reason for hiding this comment

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

Some of these links need to be updated to the current path.

`federation-apiserver` and a
[`PVC`](http://kubernetes.io/docs/user-guide/persistent-volumes/) backed
[`PVC`](/docs/user-guide/persistent-volumes/) backed
Copy link
Contributor

Choose a reason for hiding this comment

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

This should be /docs/concepts/storage/persistent-volumes/

Copy link
Contributor

Choose a reason for hiding this comment

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

done

by a dynamically provisioned
[`PV`](http://kubernetes.io/docs/user-guide/persistent-volumes/) for
[`PV`](/docs/user-guide/persistent-volumes/) for
Copy link
Contributor

Choose a reason for hiding this comment

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

This should be /docs/concepts/storage/persistent-volumes/

Copy link
Contributor

Choose a reason for hiding this comment

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

done

@@ -131,12 +131,12 @@ $ federation/deploy/deploy.sh deploy_federation
This spins up the federation control components as pods managed by
[`Deployments`](/docs/concepts/workloads/controllers/deployment/) on your
existing Kubernetes cluster. It also starts a
[`type: LoadBalancer`](http://kubernetes.io/docs/user-guide/services/#type-loadbalancer)
[`Service`](http://kubernetes.io/docs/user-guide/services/) for the
[`type: LoadBalancer`](/docs/user-guide/services/#type-loadbalancer)
Copy link
Contributor

@chenopis chenopis Jul 6, 2017

Choose a reason for hiding this comment

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

This should be /docs/concepts/services-networking/service/#type-loadbalancer

Copy link
Contributor

Choose a reason for hiding this comment

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

done

[`type: LoadBalancer`](http://kubernetes.io/docs/user-guide/services/#type-loadbalancer)
[`Service`](http://kubernetes.io/docs/user-guide/services/) for the
[`type: LoadBalancer`](/docs/user-guide/services/#type-loadbalancer)
[`Service`](/docs/user-guide/services/) for the
Copy link
Contributor

Choose a reason for hiding this comment

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

This should be /docs/concepts/services-networking/service/

Copy link
Contributor

Choose a reason for hiding this comment

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

done

@@ -247,7 +247,7 @@ federation, and
in your federation DNS.

You can find more details about config maps in general at
[config map](http://kubernetes.io/docs/user-guide/configmap/).
[config map](/docs/user-guide/configmap/).
Copy link
Contributor

Choose a reason for hiding this comment

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

This should be /docs/tasks/configure-pod-container/configmap/

Copy link
Contributor

Choose a reason for hiding this comment

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

done

@@ -284,7 +284,7 @@ Note:

## Alternate formats

The default `kompose` transformation will generate Kubernetes [Deployments](/docs/concepts/workloads/controllers/deployment/) and [Services](http://kubernetes.io/docs/user-guide/services/), in yaml format. You have alternative option to generate json with `-j`. Also, you can alternatively generate [Replication Controllers](http://kubernetes.io/docs/user-guide/replication-controller/) objects, [Deamon Sets](http://kubernetes.io/docs/admin/daemons/), or [Helm](https://github.com/helm/helm) charts.
The default `kompose` transformation will generate Kubernetes [Deployments](/docs/concepts/workloads/controllers/deployment/) and [Services](/docs/user-guide/services/), in yaml format. You have alternative option to generate json with `-j`. Also, you can alternatively generate [Replication Controllers](/docs/user-guide/replication-controller/) objects, [Deamon Sets](/docs/admin/daemons/), or [Helm](https://github.com/helm/helm) charts.
Copy link
Contributor

Choose a reason for hiding this comment

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

Services -> /docs/concepts/services-networking/service/
Replication Controllers -> /docs/concepts/workloads/controllers/replicationcontroller/
typo: Daemon Sets -> /docs/concepts/workloads/controllers/daemonset/

Copy link
Contributor

Choose a reason for hiding this comment

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

done

@@ -12,7 +12,7 @@ external IP address.

{% capture prerequisites %}

* Install [kubectl](http://kubernetes.io/docs/tasks/kubectl/install/).
* Install [kubectl](/docs/tasks/kubectl/install/).
Copy link
Contributor

Choose a reason for hiding this comment

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

This should be /docs/tasks/tools/install-kubectl/

Copy link
Contributor

Choose a reason for hiding this comment

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

done

@@ -6,7 +6,7 @@

This example assumes you have a Kubernetes cluster installed and running, and that you have
installed the `kubectl` command line tool somewhere in your path. Please see the [getting
started](http://kubernetes.io/docs/getting-started-guides/) for installation instructions for your platform.
started](/docs/getting-started-guides/) for installation instructions for your platform.
Copy link
Contributor

Choose a reason for hiding this comment

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

This should be /docs/setup/pick-right-solution/

Copy link
Contributor

Choose a reason for hiding this comment

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

done

@@ -1,11 +1,11 @@
Following these examples, you will create a pod with a container that consumes the pod's name,
namespace, and resource values using the [downward API](http://kubernetes.io/docs/user-guide/downward-api/).
namespace, and resource values using the [downward API](/docs/user-guide/downward-api/).
Copy link
Contributor

Choose a reason for hiding this comment

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

This should be /docs/tasks/inject-data-application/downward-api-volume-expose-pod-information/

Copy link
Contributor

Choose a reason for hiding this comment

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

done


## Step Zero: Prerequisites

This example assumes you have a Kubernetes cluster installed and running, and that you have
installed the `kubectl` command line tool somewhere in your path. Please see the [getting
started](http://kubernetes.io/docs/getting-started-guides/) for installation instructions for your platform.
started](/docs/getting-started-guides/) for installation instructions for your platform.
Copy link
Contributor

Choose a reason for hiding this comment

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

This should be /docs/setup/pick-right-solution/

Copy link
Contributor

Choose a reason for hiding this comment

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

done

@ahmetb
Copy link
Member Author

ahmetb commented Jul 8, 2017

@chenopis My intent in this PR is not to fix old links with the new links. (It's often good for a PR to fix only one thing.) It is to make sure while you're browsing the sandbox (on Netlify/localhost) you don't accidentally escape to live site.

If you think they must be fixed: a) feel free to take over the PR (you can commit to my fork/branch) or b) merge this and then submit a PR fixing the old links with new ones.

@chenopis
Copy link
Contributor

Deploy preview ready!

Built with commit 8be9f1d

https://deploy-preview-4299--kubernetes-io-master-staging.netlify.com

@chenopis
Copy link
Contributor

Deploy preview ready!

Built with commit fa4d666

https://deploy-preview-4299--kubernetes-io-master-staging.netlify.com

@chenopis
Copy link
Contributor

Deploy preview ready!

Built with commit b4b4e37

https://deploy-preview-4299--kubernetes-io-master-staging.netlify.com

@chenopis
Copy link
Contributor

Deploy preview ready!

Built with commit 4881e9f

https://deploy-preview-4299--kubernetes-io-master-staging.netlify.com

@chenopis
Copy link
Contributor

Deploy preview ready!

Built with commit 35efb61

https://deploy-preview-4299--kubernetes-io-master-staging.netlify.com

@chenopis
Copy link
Contributor

Deploy preview ready!

Built with commit 379a1a9

https://deploy-preview-4299--kubernetes-io-master-staging.netlify.com

Copy link
Contributor

@chenopis chenopis left a comment

Choose a reason for hiding this comment

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

Ok, I've updated the links.

@chenopis
Copy link
Contributor

Deploy preview ready!

Built with commit f55fd7c

https://deploy-preview-4299--kubernetes-io-master-staging.netlify.com

@chenopis
Copy link
Contributor

Deploy preview ready!

Built with commit fe209b1

https://deploy-preview-4299--kubernetes-io-master-staging.netlify.com

@chenopis chenopis merged commit 0667180 into kubernetes:master Jul 10, 2017
@ahmetb
Copy link
Member Author

ahmetb commented Jul 10, 2017

🙌

jesscodez pushed a commit that referenced this pull request Sep 22, 2017
* Remove self-links with domain names in docs

Fixes #4191. Skipping the tutorials we import from kubernetes/examples.

Signed-off-by: Ahmet Alp Balkan <ahmetb@google.com>

* update federation/index.md user-guide links

* update assign-pod-node.md links

* update dns-pod-service.md link

* update link in jobs-run-to-completion.md

* update link in minikube.md

* update PS link in minikube.md

* update links in stackpoint.md

* update links in storage.md

* fix link in vsphere.md

* fix links in deprecation-policy.md

* Update pick-right-solution.md

* Update web-ui-dashboard.md

* Update ingress.md

* Update federation-service-discovery.md

* Update user-guide.md

* Update expose-external-ip-address.md

* Update README.md

* Update README.md
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.

3 participants