whentimeslows/website
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

WIP: Cleanup /docs/contribute/ migration (#3278)

Browse Source 
* WIP: Cleanup /docs/contribute/ migration

* #3278 Changing /docs/contribute to /docs/home/contribute (#3285)

* WIP: #3278 Adding redirects /docs/contribute/ /docs/home/contribute/

* WIP: #3278 modifying /docs/contribute/ paths within files to /docs/home/contribute/

* Revert "WIP: #3278 Adding redirects /docs/contribute/ /docs/home/contribute/"

This reverts commit a82efdee505d7a409cb3c86240cc0ee976a2e566.

* WIP: #3278 Adding redirects /docs/contribute/ /docs/home/contribute/

* WIP: #3278 Correcting syntax mistake in redirect.js

* WIP: #3278 Correcting another syntax mistake in redirect.js

* WIP: #3278 Removing deprecated files so redirects work

* Removing the #

* WIP: #3278 Updating pattern in redirect.js

* WIP: #3278 Removed the wrong # previously redirect.js
This commit is contained in:
Andrew Chen
2017-04-10 13:24:14 -07:00
committed by GitHub
parent 299142058a
commit 005fce03fe
23 changed files with 56 additions and 92 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CONTRIBUTING.md
+2 -2
View File
@@ -17,7 +17,7 @@ The [Kubernetes SIG Docs Discussion Group](https://groups.google.com/forum/#!for
### Style Guides and Templates
Before submitting a pull request to create new content, please review the [Kubernetes.io style guide](http://kubernetes.io/docs/contribute/style-guide/) and follow the [instructions for using page templates](http://kubernetes.io/docs/contribute/page-templates/).
Before submitting a pull request to create new content, please review the [Kubernetes.io style guide](http://kubernetes.io/docs/home/contribute/style-guide/) and follow the [instructions for using page templates](http://kubernetes.io/docs/home/contribute/page-templates/).
## Contributing to Documentation
@@ -33,4 +33,4 @@ Note that code issues should be filed against the main kubernetes repository, wh
### Submitting Documentation Pull Requests
If you're fixing an issue in the existing documentation, you should submit a PR against the master branch. Follow [these instructions to create a documentation pull request against the kubernetes.io repository](http://kubernetes.io/docs/contribute/create-pull-request/).
If you're fixing an issue in the existing documentation, you should submit a PR against the master branch. Follow [these instructions to create a documentation pull request against the kubernetes.io repository](http://kubernetes.io/docs/home/contribute/create-pull-request/).
README.md
+5 -5
View File
@@ -7,11 +7,11 @@ You can click the **Fork** button in the upper-right area of the screen to creat
For more information about contributing to the Kubernetes documentation, see:
* [Contributing to the Kubernetes Documentation](http://kubernetes.io/editdocs/)
* [Creating a Documentation Pull Request](http://kubernetes.io/docs/contribute/create-pull-request/)
* [Writing a New Topic](http://kubernetes.io/docs/contribute/write-new-topic/)
* [Staging Your Documentation Changes](http://kubernetes.io/docs/contribute/stage-documentation-changes/)
* [Using Page Templates](http://kubernetes.io/docs/contribute/page-templates/)
* [Documentation Style Guide](http://kubernetes.io/docs/contribute/style-guide/)
* [Creating a Documentation Pull Request](http://kubernetes.io/docs/home/contribute/create-pull-request/)
* [Writing a New Topic](http://kubernetes.io/docs/home/contribute/write-new-topic/)
* [Staging Your Documentation Changes](http://kubernetes.io/docs/home/contribute/stage-documentation-changes/)
* [Using Page Templates](http://kubernetes.io/docs/home/contribute/page-templates/)
* [Documentation Style Guide](http://kubernetes.io/docs/home/contribute/style-guide/)
## Thank you!
_data/support.yml
+6 -6
View File
@@ -23,12 +23,12 @@ toc:
- title: Contributing to the Kubernetes Docs
section:
- editdocs.md
- docs/contribute/create-pull-request.md
- docs/contribute/write-new-topic.md
- docs/contribute/stage-documentation-changes.md
- docs/contribute/page-templates.md
- docs/contribute/review-issues.md
- docs/contribute/style-guide.md
- docs/home/contribute/create-pull-request.md
- docs/home/contribute/write-new-topic.md
- docs/home/contribute/stage-documentation-changes.md
- docs/home/contribute/page-templates.md
- docs/home/contribute/review-issues.md
- docs/home/contribute/style-guide.md
- title: Other Resources
section:
docs/concepts/index.md
+1 -1
View File
@@ -59,5 +59,5 @@ The nodes in a cluster are the machines (VMs, physical servers, etc) that run yo
### What's next
If you would like to write a concept page, see
[Using Page Templates](/docs/contribute/page-templates/)
[Using Page Templates](/docs/home/contribute/page-templates/)
for information about the concept page type and the concept template.
docs/contribute/README.md
+1
View File
@@ -0,0 +1 @@
This directory is deprecated and its contents have been moved to /docs/home/contribute/.
docs/contribute/create-pull-request.md
-7
View File
@@ -1,7 +0,0 @@
---
title: Creating a Documentation Pull Request
---
{% include support-content-moved.md %}
[Creating a Documentation Pull Request](/docs/home/contribute/create-pull-request/)
docs/contribute/page-templates.md
-10
View File
@@ -1,10 +0,0 @@
---
redirect_from:
- "/docs/templatedemos/"
- "/docs/templatedemos.html"
title: Using Page Templates
---
{% include support-content-moved.md %}
[Using Page Templates](/docs/home/contribute/page-templates/)
docs/contribute/review-issues.md
-7
View File
@@ -1,7 +0,0 @@
---
title: Reviewing Documentation Issues
---
{% include support-content-moved.md %}
[Reviewing Documentation Issues](/docs/home/contribute/review-issues/)
docs/contribute/stage-documentation-changes.md
-7
View File
@@ -1,7 +0,0 @@
---
title: Staging Your Documentation Changes
---
{% include support-content-moved.md %}
[Staging Your Documentation Changes](/docs/home/contribute/stage-documentation-changes/)
docs/contribute/style-guide.md
-7
View File
@@ -1,7 +0,0 @@
---
title: Documentation Style Guide
---
{% include support-content-moved.md %}
[Documentation Style Guide](/docs/home/contribute/style-guide/)
docs/contribute/write-new-topic.md
-7
View File
@@ -1,7 +0,0 @@
---
title: Writing a New Topic
---
{% include support-content-moved.md %}
[Writing a New Topic](/docs/home/contribute/write-new-topic/)
docs/home/contribute/create-pull-request.md
+5 -5
View File
@@ -39,9 +39,9 @@ is called a *fork*.
a new branch to use for your contribution.
1. In your new branch, make your changes and commit them. If you want to
[write a new topic](/docs/contribute/write-new-topic/),
[write a new topic](/docs/home/contribute/write-new-topic/),
choose the
[page type](/docs/contribute/page-templates/)
[page type](/docs/home/contribute/page-templates/)
that is the best fit for your content.
## Submitting a pull request to the master branch (Current Release)
@@ -90,9 +90,9 @@ next upcoming release. It's automatically updated as new PRs get merged.
{% endcapture %}
{% capture whatsnext %}
* Learn about [writing a new topic](/docs/contribute/write-new-topic).
* Learn about [using page templates](/docs/contribute/page-templates/).
* Learn about [staging your changes](/docs/contribute/stage-documentation-changes).
* Learn about [writing a new topic](/docs/home/contribute/write-new-topic).
* Learn about [using page templates](/docs/home/contribute/page-templates/).
* Learn about [staging your changes](/docs/home/contribute/stage-documentation-changes).
{% endcapture %}
{% include templates/task.md %}
docs/home/contribute/review-issues.md
+3 -3
View File
@@ -65,9 +65,9 @@ Depending on where the dead link is reported, different actions are required to
{% capture whatsnext %}
* Learn about [writing a new topic](/docs/contribute/write-new-topic).
* Learn about [using page templates](/docs/contribute/page-templates/).
* Learn about [staging your changes](/docs/contribute/stage-documentation-changes).
* Learn about [writing a new topic](/docs/home/contribute/write-new-topic).
* Learn about [using page templates](/docs/home/contribute/page-templates/).
* Learn about [staging your changes](/docs/home/contribute/stage-documentation-changes).
{% endcapture %}
{% include templates/concept.md %}
docs/home/contribute/stage-documentation-changes.md
+4 -4
View File
@@ -9,7 +9,7 @@ to the Kubernetes documentation.
{% capture prerequisites %}
Create a fork of the Kubernetes documentation repository as described in
[Creating a Documentation Pull Request](/docs/contribute/create-pull-request/).
[Creating a Documentation Pull Request](/docs/home/contribute/create-pull-request/).
{% endcapture %}
{% capture steps %}
@@ -101,9 +101,9 @@ web server:
{% endcapture %}
{% capture whatsnext %}
* Learn about [writing a new topic](/docs/contribute/write-new-topic/).
* Learn about [using page templates](/docs/contribute/page-templates/).
* Learn about [creating a pull request](/docs/contribute/create-pull-request/).
* Learn about [writing a new topic](/docs/home/contribute/write-new-topic/).
* Learn about [using page templates](/docs/home/contribute/page-templates/).
* Learn about [creating a pull request](/docs/home/contribute/create-pull-request/).
{% endcapture %}
{% include templates/task.md %}
docs/home/contribute/style-guide.md
+6 -6
View File
@@ -9,8 +9,8 @@ propose changes to this document in a pull request.
For additional information on creating new content for the Kubernetes
docs, follow the instructions on
[using page templates](/docs/contribute/page-templates/) and
[creating a documentation pull request](/docs/contribute/create-pull-request/).
[using page templates](/docs/home/contribute/page-templates/) and
[creating a documentation pull request](/docs/home/contribute/create-pull-request/).
{% endcapture %}
{% capture body %}
@@ -227,10 +227,10 @@ considered new in a few months.
{% capture whatsnext %}
* Learn about [writing a new topic](/docs/contribute/write-new-topic/).
* Learn about [using page templates](/docs/contribute/page-templates/).
* Learn about [staging your changes](/docs/contribute/stage-documentation-changes/)
* Learn about [creating a pull request](/docs/contribute/create-pull-request/).
* Learn about [writing a new topic](/docs/home/contribute/write-new-topic/).
* Learn about [using page templates](/docs/home/contribute/page-templates/).
* Learn about [staging your changes](/docs/home/contribute/stage-documentation-changes/)
* Learn about [creating a pull request](/docs/home/contribute/create-pull-request/).
{% endcapture %}
{% include templates/concept.md %}
docs/home/contribute/write-new-topic.md
+5 -5
View File
@@ -8,7 +8,7 @@ This page shows how to create a new topic for the Kubernetes docs.
{% capture prerequisites %}
Create a fork of the Kubernetes documentation repository as described in
[Creating a Documentation Pull Request](/docs/contribute/create-pull-request/).
[Creating a Documentation Pull Request](/docs/home/contribute/create-pull-request/).
{% endcapture %}
{% capture steps %}
@@ -38,7 +38,7 @@ is the best fit for your content:
</table>
Each page type has a
[template](/docs/contribute/page-templates/)
[template](/docs/home/contribute/page-templates/)
that you can use as you write your topic.
Using templates helps ensure consistency among topics of a given type.
@@ -135,9 +135,9 @@ image format is SVG.
{% endcapture %}
{% capture whatsnext %}
* Learn about [using page templates](/docs/contribute/page-templates/).
* Learn about [staging your changes](/docs/contribute/stage-documentation-changes).
* Learn about [creating a pull request](/docs/contribute/create-pull-request/).
* Learn about [using page templates](/docs/home/contribute/page-templates/).
* Learn about [staging your changes](/docs/home/contribute/stage-documentation-changes).
* Learn about [creating a pull request](/docs/home/contribute/create-pull-request/).
{% endcapture %}
{% include templates/task.md %}
docs/tasks/index.md
+1 -1
View File
@@ -74,5 +74,5 @@ single thing, typically by giving a short sequence of steps.
### What's next
If you would like to write a task page, see
[Creating a Documentation Pull Request](/docs/contribute/create-pull-request/).
[Creating a Documentation Pull Request](/docs/home/contribute/create-pull-request/).
docs/tutorials/index.md
+1 -1
View File
@@ -42,5 +42,5 @@ each of which has a sequence of steps.
### What's next
If you would like to write a tutorial, see
[Using Page Templates](/docs/contribute/page-templates/)
[Using Page Templates](/docs/home/contribute/page-templates/)
for information about the tutorial page type and the tutorial template.
editdocs.md
+5 -5
View File
@@ -46,8 +46,8 @@ $( document ).ready(function() {
For more information about contributing to the Kubernetes documentation, see:
* [Creating a Documentation Pull Request](http://kubernetes.io/docs/contribute/create-pull-request/)
* [Writing a New Topic](http://kubernetes.io/docs/contribute/write-new-topic/)
* [Staging Your Documentation Changes](http://kubernetes.io/docs/contribute/stage-documentation-changes/)
* [Using Page Templates](http://kubernetes.io/docs/contribute/page-templates/)
* [Documentation Style Guide](http://kubernetes.io/docs/contribute/style-guide/)
* [Creating a Documentation Pull Request](http://kubernetes.io/docs/home/contribute/create-pull-request/)
* [Writing a New Topic](http://kubernetes.io/docs/home/contribute/write-new-topic/)
* [Staging Your Documentation Changes](http://kubernetes.io/docs/home/contribute/stage-documentation-changes/)
* [Using Page Templates](http://kubernetes.io/docs/home/contribute/page-templates/)
* [Documentation Style Guide](http://kubernetes.io/docs/home/contribute/style-guide/)
js/redirects.js
+6
View File
@@ -12,6 +12,12 @@ $( document ).ready(function() {
"pattern":"kubectl_(\\w+)",
"to":"/docs/user-guide/kubectl/v1.6",
"postfix":"/#<token>"
},
{
"from":"/docs/contribute/",
"pattern":"\/contribute\/([0-9a-zA-Z\-\_]+)",
"to":"/docs/home/contribute",
"postfix":"/<token>"
}];
var doRedirect = false;
var notHere = false;
skip_title_check.txt
+2 -1
View File
@@ -9,4 +9,5 @@ docs/api-reference/v1/definitions.md
docs/api-reference/v1/operations.md
docs/user-guide/pods/_viewing-a-pod.md
docs/user-guide/simple-yaml.md
docs/concepts/abstractions/pod-termination.md
docs/concepts/abstractions/pod-termination.md
docs/contribute/README.md
skip_toc_check.txt
+2 -1
View File
@@ -63,5 +63,6 @@ docs/user-guide/federation/secrets.md
docs/home/security.md
docs/home/deprecation-policy.md
docs/whatisk8s.md
docs/contribute/README.md
verify-docs-format.sh
+1 -1
View File
@@ -52,7 +52,7 @@ for file in `find docs -name "*.md" -type f`; do
done
if ${no_entry}; then
echo "Found ${no_entry_counter} files without entries. For how to fix it, see http://kubernetes.io/docs/contribute/write-new-topic/#creating-an-entry-in-the-table-of-contents"
echo "Found ${no_entry_counter} files without entries. For how to fix it, see http://kubernetes.io/docs/home/contribute/write-new-topic/#creating-an-entry-in-the-table-of-contents"
exit 1
fi