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

Deduplicate kpt function docs #923

Merged
merged 6 commits into from
Aug 18, 2020
Merged

Deduplicate kpt function docs #923

merged 6 commits into from
Aug 18, 2020

Conversation

prachirp
Copy link
Contributor

@prachirp prachirp commented Aug 7, 2020

The kpt function docs had sections which repeated the same content in various ways. This change:

  • Refactors all function docs to have all topics have one source of truth page which explains the content in an authoritative way for Deduplicate fn docs #908
  • Clarifies examples of running privileged docker containers for Document how to run privileged function docker containers #832
  • Fixes W3 Link Checker errors for broken links and reorders links to fit the order they appear on the page
  • Adds Next Steps sections to docs which did not have them
  • Fixes markdownlint errors in function docs

site/content/en/concepts/functions/_index.md Outdated Show resolved Hide resolved
site/content/en/concepts/functions/_index.md Outdated Show resolved Hide resolved
site/content/en/faq/_index.md Outdated Show resolved Hide resolved
site/content/en/guides/consumer/function/_index.md Outdated Show resolved Hide resolved
site/content/en/guides/consumer/function/_index.md Outdated Show resolved Hide resolved
site/content/en/guides/producer/functions/exec/_index.md Outdated Show resolved Hide resolved
site/content/en/guides/producer/functions/exec/_index.md Outdated Show resolved Hide resolved
Copy link
Contributor

@frankfarzan frankfarzan left a comment

Choose a reason for hiding this comment

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

It's very hard to review changes to 78 files. For future PRs, I suggest splitting this up into manageable chunks and changing one things at a time.

site/content/en/reference/fn/run/_index.md Show resolved Hide resolved
@frankfarzan frankfarzan merged commit 8a9a358 into kptdev:master Aug 18, 2020
@prachirp prachirp deleted the dedup branch August 18, 2020 17:35
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

Successfully merging this pull request may close these issues.

None yet

2 participants