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

Automate PR check for Orphaned .md files #731

Closed
pwittrock opened this issue Jun 27, 2016 · 2 comments
Closed

Automate PR check for Orphaned .md files #731

pwittrock opened this issue Jun 27, 2016 · 2 comments

Comments

@pwittrock
Copy link
Member

We need a script that checks for the following on all open PRs and prevents submission until these tests come back clean:

Orphaned .md files

Any new .md file in a PR needs to have an accompanying TOC entry in one of the following left nav files:

  • _data/guides.yml
  • _data/support.yml
  • _data/reference.yml
  • _data/samples.yml
@jaredbhatti
Copy link
Contributor

@devin-donnelly Seems like this issue has already been addressed with new travis checks?

@steveperry-53
Copy link
Contributor

The Travis check now includes a TOC check. https://github.com/kubernetes/kubernetes.github.io/blob/master/verify-docs-format.sh

mikutas pushed a commit to mikutas/k8s-website that referenced this issue Feb 24, 2021
* add linkerd mc with helm

Signed-off-by: Tarun Pothulapati <tarunpothulapati@outlook.com>

* fix nits around case,spellings

Signed-off-by: Tarun Pothulapati <tarunpothulapati@outlook.com>

* update linkerd mc release name

Signed-off-by: Tarun Pothulapati <tarunpothulapati@outlook.com>

* use correct chart name

Signed-off-by: Tarun Pothulapati <tarunpothulapati@outlook.com>

* update doc with allow equivalent

Signed-off-by: Tarun Pothulapati <tarunpothulapati@outlook.com>

* rename createNamespace to installNamespace for consistency

Signed-off-by: Tarun Pothulapati <tarunpothulapati@outlook.com>

* fold helm mc install into install_multicluster.md

Signed-off-by: Tarun Pothulapati <tarunpothulapati@outlook.com>

Co-authored-by: Thomas Rampelberg <thomas@saunter.org>
Okabe-Junya pushed a commit to Okabe-Junya/website that referenced this issue Dec 4, 2023
…n) (kubernetes#1463)

* Settings and initial contents for German localization (kubernetes#347)

* first shot

* WIP german contribution index file

* finalized contribution index, add de.toml

* add contentDir to de config section in config.toml

* change request from catherine

* finalizing style guide

* change request from David and Catherine

Signed-off-by: Noah Ispas (iamNoah1) <noahispas@gmail.com>

* [de] Fix typo in _index.md

* first shot

* change requests

* [de] Add localization cloud computing (kubernetes#711)

* [de] Add localization cloud computing

* [de] Add missing title meta inf

* [de] Adjust wording in cloud computing

* [de] Adjust wording cloud computing

Co-authored-by: Noah Ispas <13436814+iamNoah1@users.noreply.github.com>

Co-authored-by: Noah Ispas <13436814+iamNoah1@users.noreply.github.com>

* update terms to completed (kubernetes#725)

* update terms to completed

* Update content/de/agile_software_development.md

Co-authored-by: Jihoon Seo <46767780+jihoon-seo@users.noreply.github.com>

* Update cloud_computing.md

Co-authored-by: Jihoon Seo <46767780+jihoon-seo@users.noreply.github.com>

* localize feedback section

* [de] Fix template title for agile software dev (kubernetes#731)

* Add german translation for API Gateway (kubernetes#732)

* Add german translation for API Gateway

Add german translation for API Gateway. Solves kubernetes#507

* Update api_gateway.md

fixed all found typos by

* Update api_gateway.md

small wording adjustment, changes state

Co-authored-by: Noah Ispas <13436814+iamNoah1@users.noreply.github.com>

* [de] Add localization for "abstraction"

* [de] Remove whitespaces

* [de] Remove redundant information

* [de] Rephrase sentence

* [de] Rephrase sentence

* [de] Remove white spaces

* [de] Add localization cloud native tech

* Incorporate suggested change

Co-authored-by: Noah Ispas <13436814+iamNoah1@users.noreply.github.com>

* Incorporate suggested change

Co-authored-by: Noah Ispas <13436814+iamNoah1@users.noreply.github.com>

* Incorporate suggested change

Co-authored-by: Noah Ispas <13436814+iamNoah1@users.noreply.github.com>

* Incorporate suggested change to title

* Update cloud_native_tech.md

* rename files, add semantic line breaks, empty lines (kubernetes#974)

* rename files, add semantic line breaks, empty lines

Signed-off-by: Noah Ispas (iamNoah1) <noahispas@gmail.com>

* [DE] Take Over Cloud Native Security localization (kubernetes#990)

* add cloud native sec

Signed-off-by: Max Körbächer <m.koerbaecher@reply.de>
Signed-off-by: Noah Ispas (iamNoah1) <noahispas@gmail.com>

* edits, semantic line breaks

Signed-off-by: Noah Ispas (iamNoah1) <noahispas@gmail.com>

* change requests from Jihoon

Signed-off-by: Noah Ispas (iamNoah1) <noahispas@gmail.com>

* change requests from david

Signed-off-by: Noah Ispas (iamNoah1) <noahispas@gmail.com>

* change requests from david

Signed-off-by: Noah Ispas (iamNoah1) <noahispas@gmail.com>

* Update content/de/cloud-native-security.md

Co-authored-by: DaveVentura <47860237+DaveVentura@users.noreply.github.com>

* Update content/de/cloud-native-security.md

Co-authored-by: DaveVentura <47860237+DaveVentura@users.noreply.github.com>

Co-authored-by: Max Körbächer <m.koerbaecher@reply.de>
Co-authored-by: DaveVentura <47860237+DaveVentura@users.noreply.github.com>

* german localize cloud native apps (kubernetes#1085)

* add german localisation for cloud native apps

* add .md

* Apply suggestions from code review

Co-authored-by: Noah Ispas <13436814+iamNoah1@users.noreply.github.com>
Signed-off-by: DaveVentura <47860237+DaveVentura@users.noreply.github.com>

* apply change requests - remove redundancy

* Update content/de/cloud-native-apps.md

Signed-off-by: Noah Ispas <13436814+iamNoah1@users.noreply.github.com>

* Update content/de/cloud-native-apps.md

Signed-off-by: Noah Ispas <13436814+iamNoah1@users.noreply.github.com>

Signed-off-by: DaveVentura <47860237+DaveVentura@users.noreply.github.com>
Signed-off-by: Noah Ispas <13436814+iamNoah1@users.noreply.github.com>
Co-authored-by: David Wagner <daw@dataone.de>
Co-authored-by: Noah Ispas <13436814+iamNoah1@users.noreply.github.com>

* [DE] Add german definition for canary deployment (kubernetes#1247)

* [de] Add german definition for canary deployment

Signed-off-by: Baris Cubukcuoglu <cubukcuoglu.baris@gmail.com>
Co-authored-by: Noah Ispas <13436814+iamNoah1@users.noreply.github.com>

* Update content/de/canary_deployment.md

Signed-off-by: Noah Ispas <13436814+iamNoah1@users.noreply.github.com>

* Update content/de/canary_deployment.md

Co-authored-by: DaveVentura <47860237+DaveVentura@users.noreply.github.com>
Signed-off-by: Noah Ispas <Noahispas@gmail.com>

* Update content/de/canary_deployment.md

Signed-off-by: Noah Ispas <Noahispas@gmail.com>

Signed-off-by: Baris Cubukcuoglu <cubukcuoglu.baris@gmail.com>
Signed-off-by: Noah Ispas <13436814+iamNoah1@users.noreply.github.com>
Signed-off-by: Noah Ispas <Noahispas@gmail.com>
Co-authored-by: Noah Ispas <13436814+iamNoah1@users.noreply.github.com>
Co-authored-by: Noah Ispas <Noahispas@gmail.com>
Co-authored-by: DaveVentura <47860237+DaveVentura@users.noreply.github.com>

* german autoscaling localization (kubernetes#1111)

* add german autoscaling localisation

* Update content/de/autoscaling.md

Co-authored-by: Noah Ispas <13436814+iamNoah1@users.noreply.github.com>
Signed-off-by: DaveVentura <47860237+DaveVentura@users.noreply.github.com>

* Update content/de/autoscaling.md

Co-authored-by: Noah Ispas <13436814+iamNoah1@users.noreply.github.com>
Signed-off-by: DaveVentura <47860237+DaveVentura@users.noreply.github.com>

* Update content/de/autoscaling.md

Co-authored-by: Noah Ispas <13436814+iamNoah1@users.noreply.github.com>
Signed-off-by: DaveVentura <47860237+DaveVentura@users.noreply.github.com>

* change requests

* Update content/de/autoscaling.md

Signed-off-by: Noah Ispas <Noahispas@gmail.com>

Signed-off-by: DaveVentura <47860237+DaveVentura@users.noreply.github.com>
Signed-off-by: Noah Ispas <Noahispas@gmail.com>
Co-authored-by: Noah Ispas <13436814+iamNoah1@users.noreply.github.com>
Co-authored-by: Noah Ispas <Noahispas@gmail.com>

* corrects filename

Signed-off-by: Noah Ispas (iamNoah1) <noahispas@gmail.com>

* correct wording (kubernetes#1355)

Signed-off-by: Noah Ispas (iamNoah1) <noahispas@gmail.com>

Signed-off-by: Noah Ispas (iamNoah1) <noahispas@gmail.com>

* [localization/german] Add localization for API (kubernetes#1055)

* [localization/german] Add localization for API
Co-authored-by: Noah Ispas <Noahispas@gmail.com>
Signed-off-by: DaveVentura <47860237+DaveVentura@users.noreply.github.com>

* fix filename

Signed-off-by: Noah Ispas (iamNoah1) <noahispas@gmail.com>

* [DE] Localization of Blue Green Deployment (kubernetes#1342)

* first shot

Signed-off-by: Noah Ispas (iamNoah1) <noahispas@gmail.com>

* localize headers

Signed-off-by: Noah Ispas (iamNoah1) <noahispas@gmail.com>

* Update content/de/blue-green-deployment.md

Co-authored-by: DaveVentura <47860237+DaveVentura@users.noreply.github.com>
Signed-off-by: Noah Ispas <Noahispas@gmail.com>

* Update content/de/blue-green-deployment.md

Co-authored-by: DaveVentura <47860237+DaveVentura@users.noreply.github.com>
Signed-off-by: Noah Ispas <Noahispas@gmail.com>

* Update content/de/blue-green-deployment.md

Co-authored-by: DaveVentura <47860237+DaveVentura@users.noreply.github.com>
Signed-off-by: Noah Ispas <Noahispas@gmail.com>

* Update content/de/blue-green-deployment.md

Co-authored-by: DaveVentura <47860237+DaveVentura@users.noreply.github.com>
Signed-off-by: Noah Ispas <Noahispas@gmail.com>

* add change requests from Baris

Signed-off-by: Noah Ispas (iamNoah1) <noahispas@gmail.com>

Signed-off-by: Noah Ispas (iamNoah1) <noahispas@gmail.com>
Signed-off-by: Noah Ispas <Noahispas@gmail.com>
Co-authored-by: DaveVentura <47860237+DaveVentura@users.noreply.github.com>

* change every article state to completed

Signed-off-by: Noah Ispas (iamNoah1) <noahispas@gmail.com>

* extend information about initializing members of german content

Signed-off-by: Noah Ispas (iamNoah1) <noahispas@gmail.com>

Signed-off-by: Noah Ispas (iamNoah1) <noahispas@gmail.com>
Signed-off-by: DaveVentura <47860237+DaveVentura@users.noreply.github.com>
Signed-off-by: Noah Ispas <13436814+iamNoah1@users.noreply.github.com>
Signed-off-by: Baris Cubukcuoglu <cubukcuoglu.baris@gmail.com>
Signed-off-by: Noah Ispas <Noahispas@gmail.com>
Co-authored-by: Dennis Groß <gdennis91@googlemail.com>
Co-authored-by: Jihoon Seo <46767780+jihoon-seo@users.noreply.github.com>
Co-authored-by: Christian Hüning <christianhuening@users.noreply.github.com>
Co-authored-by: Oliver L <oliver@pattern.engineer>
Co-authored-by: Max Körbächer <m.koerbaecher@reply.de>
Co-authored-by: DaveVentura <47860237+DaveVentura@users.noreply.github.com>
Co-authored-by: David Wagner <daw@dataone.de>
Co-authored-by: Baris Cubukcuoglu <cubukcuoglu.baris@googlemail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants