diff --git a/.github/pull-request-template.md b/.github/pull-request-template.md index 9125c5a82c6..8bef5dec4d3 100644 --- a/.github/pull-request-template.md +++ b/.github/pull-request-template.md @@ -9,14 +9,14 @@ your original PR has been merged into the main branch. Once the cherry-pick PR has merged, remove the cherry-pick label from the original PR. Use one of the new content templates: -- [Concept](./template-concept.md) -- Conceptual topics explain how things work or what things mean. -They provide helpful context to readers. They do not include procedures. -- [Procedure](./template-procedure.md) -- Procedural (how-to) topics include detailed steps to -perform a task as well as some context about the task. -- [Troubleshooting](./template-troubleshooting.md) -- Troubleshooting topics list common errors and -solutions. -- [Blog](./template-blog-entry.md) -- Instructions and a template that you can use to help you post -to the Knative blog. +- [Concept](./docs/contributor/templates/template-concept.md) -- Conceptual topics explain how things +work or what things mean. They provide helpful context to readers. They do not include procedures. +- [Procedure](./docs/contributor/templates/template-procedure.md) -- Procedural (how-to) topics +include detailed steps to perform a task as well as some context about the task. +- [Troubleshooting](./docs/contributor/templates/template-troubleshooting.md) -- Troubleshooting +topics list common errors and solutions. +- [Blog](./docs/contributor/templates/template-blog-entry.md) -- Instructions and a template that you +can use to help you post to the Knative blog. Consult [Knative contributor's guide](./help/contributing) for all resources for contributing to Knative documentation. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8fed77805ca..bdc71a8a1f3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,11 +5,11 @@ into a single location: #### [Go to the How-to guides for Knative docs contributors](https://knative.dev/help/) **Quick links**: - * [Docs help](https://knative.dev/help/contributor/) - * New content templates: - * [Concept](template-concept.md) - * [Procedure](template-procedure.md) - * [Troubleshooting](template-troubleshooting.md) - * [Blog](template-blog-entry.md) - * [Website help](https://knative.dev/help/contributor/publishing) - * [Maintainer help](https://knative.dev/help/maintainer/) +* [Docs help](https://knative.dev/help/contributor/) + * New content templates: + * [Concept](./docs/contributor/templates/template-concept.md) + * [Procedure](./docs/contributor/templates/template-procedure.md) + * [Troubleshooting](./docs/contributor/templates/template-troubleshooting.md) + * [Blog](./docs/contributor/templates/template-blog-entry.md) +* [Website help](https://knative.dev/help/contributor/publishing) +* [Maintainer help](https://knative.dev/help/maintainer/) diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index e4a54199d0c..2c23b6703c6 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -14,9 +14,9 @@ into a single location: **Quick links**: * [Docs help](https://knative.dev/help/contributor/) * New content templates: - * [Concept](template-concept.md) - * [Procedure](template-procedure.md) - * [Troubleshooting](template-troubleshooting.md) - * [Blog](template-blog-entry.md) + * [Concept](./docs/contributor/templates/template-concept.md) + * [Procedure](./docs/contributor/templates/template-procedure.md) + * [Troubleshooting](./docs/contributor/templates/template-troubleshooting.md) + * [Blog](./docs/contributor/templates/template-blog-entry.md) * [Website help](https://knative.dev/help/contributor/publishing) * [Maintainer help](https://knative.dev/help/maintainer/) diff --git a/README.md b/README.md index 2fa47dafc5c..4edb3f23106 100644 --- a/README.md +++ b/README.md @@ -66,10 +66,10 @@ We're excited that you're interested in contributing to the Knative documentatio to contribute. - New content templates: - - [Concept](template-concept.md) - - [Procedure](template-procedure.md) - - [Troubleshooting](template-troubleshooting.md) - - [Blog](template-blog-entry.md) + - [Concept](./docs/contributor/templates/template-concept.md) + - [Procedure](./docs/contributor/templates/template-procedure.md) + - [Troubleshooting](./docs/contributor/templates/template-troubleshooting.md) + - [Blog](./docs/contributor/templates/template-blog-entry.md) ## Getting help diff --git a/blog/README.md b/blog/README.md index f25514044c2..21fd129de37 100644 --- a/blog/README.md +++ b/blog/README.md @@ -13,9 +13,9 @@ into a single location: **Quick links**: * [Docs help](https://knative.dev/help/contributor/) * New content templates: - * [Concept](template-concept.md) - * [Procedure](template-procedure.md) - * [Troubleshooting](template-troubleshooting.md) - * [Blog](template-blog-entry.md) + * [Concept](./docs/contributor/templates/template-concept.md) + * [Procedure](./docs/contributor/templates/template-procedure.md) + * [Troubleshooting](./docs/contributor/templates/template-troubleshooting.md) + * [Blog](./docs/contributor/templates/template-blog-entry.md) * [Website help](https://knative.dev/help/contributor/publishing) * [Maintainer help](https://knative.dev/help/maintainer/) diff --git a/help/contributor/gettingstarted.md b/docs/help/contributor/becoming-a-contributor.md similarity index 88% rename from help/contributor/gettingstarted.md rename to docs/help/contributor/becoming-a-contributor.md index dd894ad16fa..7ebe311b225 100644 --- a/help/contributor/gettingstarted.md +++ b/docs/help/contributor/becoming-a-contributor.md @@ -1,11 +1,4 @@ ---- -title: "Joining the project and getting started" -linkTitle: "Join" -weight: 10 -type: "docs" ---- - - +# Becoming a contributor ## Join to become a contributor @@ -57,9 +50,6 @@ Knative documentation: - Try out Knative and [send us feedback](https://github.com/knative/docs/issues/new?template=docs-feature-request.md). - For example, run through the [install guides](../../docs/install/) and then try - [Getting Started with Knative Serving](../../docs/serving/getting-started-knative-app.md) - or [Getting Started With Eventing](../../docs/eventing/getting-started.md). Keep a [friction log](https://devrel.net/developer-experience/an-introduction-to-friction-logging) @@ -108,10 +98,3 @@ also ask a few clarifying questions, or add details such as diagrams or notes if needed. It's not necessarily expected that tech writers will actually execute the steps of a tutorial — it's expected that the SME is responsible for a working tutorial or how-to. - -## What's next - -- [Learn how to use GitHub and clone the `knative/docs` repo](./how-to/github.md) -- [Read the "How to" guides](./how-to/) -- [Learn how to post to the blog](./new-blog/) -- [Learn how the website works](./publishing.md) diff --git a/help/contributor/how-to/codesamples.md b/docs/help/contributor/code-samples.md similarity index 98% rename from help/contributor/how-to/codesamples.md rename to docs/help/contributor/code-samples.md index 20a86e77de4..b5304d8896a 100644 --- a/help/contributor/how-to/codesamples.md +++ b/docs/help/contributor/code-samples.md @@ -1,9 +1,4 @@ ---- -title: "Code samples" -linkTitle: "" -weight: 100 -type: "docs" ---- +# Code samples There are currently two general types of content that focus on code samples, either internal contributor content, or external-facing user content. diff --git a/help/contributor/new-blog/_index.md b/docs/help/contributor/creating-blog-posts.md similarity index 91% rename from help/contributor/new-blog/_index.md rename to docs/help/contributor/creating-blog-posts.md index 2b6f889a4ce..2d47570c195 100644 --- a/help/contributor/new-blog/_index.md +++ b/docs/help/contributor/creating-blog-posts.md @@ -1,12 +1,6 @@ ---- -title: "Creating blog posts" -linkTitle: "New blog post" -weight: 30 -type: "docs" -showlandingtoc: "false" ---- +# Creating blog posts -The Knative blog is owned by the [Documentation working group](https://knative.dev/community/contributing/working-groups/working-groups/#documentation) and run by the [Editorial Team](#leadership). +The Knative blog is owned by the [DUX working group](https://knative.dev/community/contributing/working-groups/working-groups/#documentation--user-experience). This section covers documentation, processes, and roles for the [Knative blog](https://knative.dev/blog/). @@ -41,7 +35,7 @@ To submit a blog post, follow the steps below. #### Suitable content: - **Original content only** - Knative [new feature releases and project updates](#communicating-new-project-releases) -- Tutorials and demos [start a blog](./blog-page.md) +- Tutorials and demos - Use cases - Content that is specific to a vendor or platform about Knative installation and use diff --git a/help/contributor/new-docs/_index.md b/docs/help/contributor/creating-new-docs.md similarity index 78% rename from help/contributor/new-docs/_index.md rename to docs/help/contributor/creating-new-docs.md index bbcf9a51576..55663f9c5ba 100644 --- a/help/contributor/new-docs/_index.md +++ b/docs/help/contributor/creating-new-docs.md @@ -1,26 +1,25 @@ ---- -title: "Adding new documentation" -linkTitle: "New docs" -weight: 20 -type: "docs" -showlandingtoc: "false" ---- +# Creating new documentation To contribute new documentation, follow these steps: 1. Identify the audience and intended use for the information. 1. Choose the [type of content](#content-types) you wish to contribute. -1. You can use a template to get started: - * [New docs file](./docs-page.md) - * [New `_index.md` file](./index-page.md) +1. Use one of the new content templates: + - [Concept](templates/template-concept.md) -- Conceptual topics explain how + things work or what things mean. They provide helpful context to readers. They do not include + procedures. + - [Procedure](templates/template-procedure.md) -- Procedural (how-to) topics + include detailed steps to perform a task as well as some context about the task. + - [Troubleshooting](templates/template-troubleshooting.md) -- Troubleshooting + topics list common errors and solutions. + - [Blog](templates/template-blog-entry.md) -- Instructions and a template + that you can use to help you post to the Knative blog. 1. [Choose appropriate titles and filenames](#choosing-titles-and-filenames). -1. Write your new content. See the [How-to guides](/help/contributor/how-to/) - to help you with this process. Feel free to reach out to the - [Docs Working Group](/help/contributor/gettingstarted.md#get-help-from-the-community) - with any questions. +1. Write your new content. See the [style guide](style-guide/README.md) to help you with this + process. Feel free to reach out to the + [DUX working group](https://knative.dev/community/contributing/working-groups/working-groups/#documentation--user-experience) with any questions. 1. Open a PR in the [knative/docs GitHub repository](https://github.com/knative/docs) - to kick off the review process. For details, see our - [Using GitHub help](/help/contributor/how-to/github/#prs). + to kick off the review process. For details, see our [Using GitHub help](/github.md#prs). ## Identify the audience and intended use @@ -30,9 +29,9 @@ determine the appropriate scope and depth of information to provide, its ideal structure, or the necessary supporting information. The following examples show this principle in action: -- The reader needs to perform a specific task: Tell them how to recognize when - the task is necessary and provide the task itself as a list of numbered steps, - don’t simply describe the task in general terms. +- The reader needs to perform a specific task. Tell them how to recognize when + the task is necessary, and provide the task itself as a list of numbered steps. + Don’t simply describe the task in general terms. - The reader must understand a concept before they can perform a task: Before the task, tell them about the prerequisite information and provide a link to @@ -58,8 +57,8 @@ giving readers all the information you have, because you are unsure about what information they need. If you need help identifying the audience for you content, we are happy to help -and answer all your questions during the [Docs Working Group](https://github.com/knative/community/blob/main/working-groups/WORKING-GROUPS.md) -biweekly meetings. +and answer all your questions during the [DUX working group](https://knative.dev/community/contributing/working-groups/working-groups/#documentation--user-experience) +weekly meetings. ## Content types @@ -77,7 +76,7 @@ their intended audiences, and the goals each type strives to achieve:
{{< branch >}} renders: `{{< branch >}}`
- - The [version shortcode](https://github.com/knative/website/blob/main/layouts/shortcodes/version.md) {{< version >}} renders: `{{< version >}}`
-
-### Artifacts
-
-https://github.com/knative/website/pull/129/files
-
-
-### Tabs
-
-https://github.com/knative/website/pull/124
diff --git a/help/contributor/how-to/styleguide.md b/help/contributor/how-to/styleguide.md
deleted file mode 100644
index cd76e26da0c..00000000000
--- a/help/contributor/how-to/styleguide.md
+++ /dev/null
@@ -1,116 +0,0 @@
----
-title: "Style guide"
-linkTitle: ""
-weight: 30
-type: "docs"
----
-
-All content accepted into the Knative documentation must be **clear** and
-**understandable**. Generally, content should aim to be "task oriented" and
-thorough.
-
-The standard we use to make that determination is defined by
-the [Google Developer Documentation Style
-Guide](https://developers.google.com/style/).
-
-**Start here**:
-
-1. [Highlights](https://developers.google.com/style/highlights)
-2. [General principles](https://developers.google.com/style/tone)
-3. Use the sections below as reference.
-
-## Use sentence case for titles and headings
-
-Use sentence case for all titles and headings. Only capitalize the first
-word of the heading, except for proper nouns or acronyms.
-
-|Do | Don't
-|--------------------|-----
-|Configuring feature | Configuring Feature
-|Using feature. | Using Feature
-|Using HTTPS | Using https
-
-## Use present tense
-
-|Do | Don't
-|-----------------------------|------
-|This command starts a proxy. | This command will start a proxy.
-
-Exception: Use future or past tense if it is required to convey the correct
-meaning. This exception is extremely rare and should be avoided.
-
-## Use active voice
-
-|Do | Don't
-|-------------------------------------------|------
-|You can explore the API using a browser. | The API can be explored using a browser.
-|The YAML file specifies the replica count. | The replica count is specified in the YAML file.
-
-## Use simple and direct language
-
-Use simple and direct language. Avoid using unnecessary phrases, such as saying
-"please."
-
-|Do | |Don't
-|----------------------------|--|----
-|To create a `ReplicaSet`, ... | | In order to create a `ReplicaSet`, ...
-|See the configuration file. | | Please see the configuration file.
-|View the Pods. | | With this next command, we'll view the Pods.
-
-## Address the reader as "you"
-
-|Do | Don't
-|---------------------------------------|------
-|You can create a `Deployment` by ... | We'll create a `Deployment` by ...
-|In the preceding output, you can see...| In the preceding output, we can see ...
-
-## Create useful links
-
-There are good hyperlinks, and bad hyperlinks. The common practice of calling
-links *here* or *click here* are examples of bad hyperlinks. Check out [this
-excellent article](https://medium.com/@heyoka/dont-use-click-here-f32f445d1021)
-explaining what makes a good hyperlink and try to keep these guidelines in
-mind when creating or reviewing site content.
-
-## Avoid using "we"
-
-Using "we" in a sentence can be confusing, because the reader might not know
-whether they're part of the "we" you're describing.
-
-|Do | Don't
-|------------------------------------------|------
-|Version 1.4 includes ... | In version 1.4, we have added ...
-|Knative provides a new feature for ... | We provide a new feature ...
-|This page teaches you how to use pods. | In this page, we are going to learn about pods.
-
-## Avoid jargon and idioms
-
-Some readers speak English as a second language. Avoid jargon and idioms to help
-make their understanding easier.
-
-|Do | Don't
-|----------------------|------
-|Internally, ... | Under the hood, ...
-|Create a new cluster. | Turn up a new cluster.
-|Initially, ... | Out of the box, ...
-
-## Avoid statements about the future
-
-Avoid making promises or giving hints about the future. If you need to talk
-about a feature in development, add a boilerplate under the front matter that
-identifies the information accordingly.
-
-### Avoid statements that will soon be out of date
-
-Avoid using wording that becomes outdated quickly like "currently" and
-"new". A feature that is new today is not new for long.
-
-|Do | Don't
-|------------------------------------|------
-|In version 1.4, ... | In the current version, ...
-|The Federation feature provides ... | The new Federation feature provides ...
-
-## Other related items
-
-* [Page formatting standards](./formatting.md)
-* [Include dynamic content with shortcodes](./shortcodes.md)
diff --git a/help/contributor/new-blog/blog-page.md b/help/contributor/new-blog/blog-page.md
deleted file mode 100644
index 35d6b6063c4..00000000000
--- a/help/contributor/new-blog/blog-page.md
+++ /dev/null
@@ -1,10 +0,0 @@
----
-linkTitle: "Blog template"
-weight: "30"
-type: "docs"
-aliases:
- - "/template-blog-page"
- - "/help/contributor/templates/template-blog-page"
----
-
-{{% readfile file="/template-blog-entry.md" markdown="true" %}}
diff --git a/help/contributor/new-docs/docs-page.md b/help/contributor/new-docs/docs-page.md
deleted file mode 100644
index daa221a4081..00000000000
--- a/help/contributor/new-docs/docs-page.md
+++ /dev/null
@@ -1,10 +0,0 @@
----
-linkTitle: "Docs template"
-weight: "10"
-type: "docs"
-aliases:
- - "/template-docs-page"
- - "/help/contributor/templates/template-docs-page"
----
-
-{{% readfile file="/template-docs-page.md" markdown="true" %}}
diff --git a/help/contributor/new-docs/index-page.md b/help/contributor/new-docs/index-page.md
deleted file mode 100644
index 821c58a634e..00000000000
--- a/help/contributor/new-docs/index-page.md
+++ /dev/null
@@ -1,10 +0,0 @@
----
-linkTitle: "_index.md template"
-weight: "50"
-type: "docs"
-aliases:
- - "/template-_index-page"
- - "/help/contributor/new-docs/template-_index-page"
----
-
-{{% readfile file="/template-_index-page.md" markdown="true" %}}
diff --git a/help/contributor/publishing.md b/help/contributor/publishing.md
deleted file mode 100644
index ec17d985506..00000000000
--- a/help/contributor/publishing.md
+++ /dev/null
@@ -1,187 +0,0 @@
----
-title: "Staging and publishing Knative documentation"
-linkTitle: "Preview Website"
-weight: "60"
-type: "docs"
----
-
-## Testing your documentation
-
-Before you kick off a PR review you can verify that:
-
-- The page and any elements like widgets, titles, and links, work and
- renders correctly.
-- If you moved or deleted a page, make sure to test that the redirects
- (`aliases`) all work.
-
-### Auto PR preview builds
-
-All PRs are automatically built and a Preview is generated at:
-https://app.netlify.com/sites/knative/deploys
-
-This is currently a manual process.
-
-1. Navigate to https://app.netlify.com/sites/knative/deploys
-1. Click to view a build log. The list of build logs are ordered from
- most recent to oldest. If you just pushed to your PR, then that build log is
- near the top.
-1. Scroll down to see the `PR#` in the log and verify that it's for your PR.
-1. When you find the build log for your PR, click the **[Preview]** button to
- view the unique build preview for your PR.
-
- **Important**: Each "event" in a Knative PR triggers a new/unique build
- (Preview). Therefore, if you push a new commit, a new build with those
- changes will appear at the top of https://app.netlify.com/sites/knative/deploys.
-
-### Local preview builds
-
-You can run a local preview of you fork. See the following setup section for
-details about installing the required software.
-
-- Current supported Hugo version https://github.com/knative/website/blob/main/netlify.toml
-- How to build knative.dev locally: Run [`https://github.com/knative/website/blob/main/scripts/localbuild.sh`](https://github.com/knative/website/blob/main/scripts/localbuild.sh)
-
-#### Setup the local requirements
-
-1. Clone this repo (or your fork) using `--recurse-submodules`, like so:
-
- ```bash
- git clone --recurse-submodules https://github.com/knative/website.git
- ```
-
- If you accidentally cloned this repo without `--recurse-submodules`, you'll
- need to do the following inside the repo:
-
- ```bash
- git submodule init
- git submodule update
- cd themes/docsy
- git submodule init
- git submodule update
- ```
-
- (Docsy uses two submodules, but those don't use further submodules.)
-
-1. Clone the docs repo next to (_not inside_) the website repo. This allows you
- to test docs changes alongside the website:
-
- ```bash
- git clone https://github.com/knative/docs.git
- ```
-
- You may also want to clone the community repo:
-
- ```bash
- git clone https://github.com/knative/community.git
- ```
-
-1. (Optional) If you want to change the CSS, install
- [PostCSS](https://www.docsy.dev/docs/getting-started/#install-postcss)
-
-1. Install a supported version of [Hugo](https://www.docsy.dev/docs/getting-started/#install-hugo).
-
-#### Run locally
-
-You can use `./scripts/localbuild.sh` to build and test files locally.
-The script uses Hugo's build and server commands in addition to some Knative
-specific file scripts that enables optimal user experience in GitHub
-(ie. use README.md files, allows our site to use relative linking
-(not
-[`rel` or `relref`](https://gohugo.io/content-management/cross-references/#use-ref-and-relref)),
-etc.) and also meets Hugo/Docsy static site generator
-and template requirements (ie. _index.hmtl files, etc.)
-
-The two local docs build options:
-
-- Simple/static HTML file generation for viewing how your Markdown renders in HTML:
-
- Use this to generate a static build of the documentation site into HTML. This
- uses Hugo's build command [`hugo`](https://gohugo.io/commands/hugo/).
-
- From your clone of knative/website, you run `./scripts/localbuild.sh`.
-
- All of the HTML files are built into the `public/` folder from where you can open,
- view, and test how each file renders.
-
- Notes:
-
- - This method does not mirror how knative.dev is generated and therefore is
- only recommend to for testing how your files render. That also means that link
- checking might not be 100% accurate. Hugo builds relative links differently
- (all links based on the site root vs relative to the file in which the link
- resides - this is part of the Knative specific file processing that is done)
- therefore some links will not work between the statically built HTML files.
- For example, links like `.../index.html` are converted to `.../` for simplicity
- (servers treat them as the same destination) but when you are browsing a local HTML
- file you need to open/click on the individual `index.html` files to get where you want
- to go.
- - This method does however make it easier to read or use local tools on the HTML build
- output files (vs. fetching the HTML from the server). For example, it is useful for
- refactoring/moving content and ensuring that complicated Markdown renders properly.
- - Using this method also avoids the MacOs specific issue (see below), where the default
- open FD limit exceeds the total number of `inotify` calls that Hugo wants to keep open.
-
-- Mimic how knative.dev is built and hosted:
-
- Use this option to locally build knative.dev. This uses Hugo's local server
- command [`hugo server`](https://gohugo.io/commands/hugo_server/).
-
- From your clone of knative/website, you run `./scripts/localbuild.sh -s true`.
-
- All of the HTML files are temporarily copied into the `content/en/` folder to allow
- the Hugo server to locally host those files at the URL:port specified in your terminal.
-
- Notes:
-
- - This method provides the following local build and test build options:
- - test your locally cloned files
- - build and test other user's remote forks (ie. locally build their PRs `./scripts/build.sh -f repofork -b branchname -s`)
- - option to build only a specific branch or all branches (and also from any speicifed fork)
- - fully functioning site links
- - [See all command options in localbuild.sh](https://github.com/knative/website/blob/main/scripts/localbuild.sh)
- - Hugo's live-reload is not completely utilized due to the required Knative specific file processing
- scripts (you need to rerun `./scripts/localbuild.sh -s` to rebuild and reprocess any changes that you
- make to the files from within your local knative/docs clone directory).
-
- Alternatively, if you want to use Hugo's live-reload feature, you can make temporary
- changes to the copied files within the `content/en/` folder, and then when satisfied, you must
- copy those changes into the corresponding files of your knative/docs clone.
- - Files in `content/en/` are overwritten with a new copy of your local files in your knative/docs
- clone folder each time that you run this script. Note that the last set of built files remain
- in `content/en/` for you to run local tools against but are overwritten each time that you rerun the script.
- - Using this method causes the MacOs specific issue (see below), where the default
- open FD limit exceeds the total number of `inotify` calls that the Hugo server wants to keep open.
-
-## On a Mac
-
-If you want to develop on a Mac, you'll find two obstacles:
-
-### Sed
-
-The scripts assume GNU `sed`. You can install this with
-[Homebrew](https://brew.sh/):
-
-```bash
-brew install gnu-sed
-# You need to put it in your PATH before the built-in Mac sed
-PATH="/usr/local/opt/gnu-sed/libexec/gnubin:$PATH"
-```
-
-### File Descriptors in "server mode"
-
-By default, MacOS permits a very small number of open FDs. This will manifest
-as:
-
-```
-ERROR 2020/04/14 12:37:16 Error: listen tcp 127.0.0.1:1313: socket: too many open files
-```
-
-You can fix this with the following (may be needed for each new shell):
-
-```bash
-sudo launchctl limit maxfiles 65535 200000
-# Probably only need around 4k FDs, but 64k is defensive...
-ulimit -n 65535
-sudo sysctl -w kern.maxfiles=100000
-sudo sysctl -w kern.maxfilesperproc=65535
-```
diff --git a/help/faqs.md b/help/faqs.md
deleted file mode 100644
index afa3eccb6f8..00000000000
--- a/help/faqs.md
+++ /dev/null
@@ -1,26 +0,0 @@
----
-title: "FAQs and troubleshooting"
-linkTitle: "FAQs"
-weight: "100"
-type: "docs"
----
-
-A collection of FAQs from other docs contributors.
-
-### Common GitHub PRs FAQs
-
-1. The CLA check fails even though you have signed the CLA. This may occur if
- you accept and commit suggestions in a pull request from another person's
- account, because the email address of that account doesn't match the address
- on record for the CLA. The commit will show up as co-authored, which can
- cause issues if your public email address has not signed the CLA.
-
-1. One or more tests are failing. If you do not see a specific error related to
- a change you made, and instead the errors are related to timeouts, try
- rerunning the test at a later time. There are running tasks that could result
- in timeouts or rate limiting if your test runs at the same time.
-
-### General troubleshooting
-
-1. Other Issues/Unsure - reach out in the #docs Slack channel and someone will
- be happy to help out.