Skip to content
Snippets Groups Projects
Unverified Commit 40440fb7 authored by Claire W's avatar Claire W Committed by GitHub
Browse files

[cloudflare-docs] Adding folder for PCX templates + updating contribution guidelines (#6242)


* adding content type markdown templates to github

* added link to templates folder in contributing.md

* Update static/_templates/_configuration.md

Co-authored-by: default avatarPedro Sousa <680496+pedrosousa@users.noreply.github.com>

* Update static/_templates/_configuration.md

Co-authored-by: default avatarPedro Sousa <680496+pedrosousa@users.noreply.github.com>

* Update static/_templates/_how-to_multi-procedure-ordered.md

Co-authored-by: default avatarPedro Sousa <680496+pedrosousa@users.noreply.github.com>

* Update static/_templates/_reference.md

Co-authored-by: default avatarPedro Sousa <680496+pedrosousa@users.noreply.github.com>

* Update static/_templates/_reference.md

Co-authored-by: default avatarPedro Sousa <680496+pedrosousa@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: default avatarPedro Sousa <680496+pedrosousa@users.noreply.github.com>

* last edits

Co-authored-by: default avatarPedro Sousa <680496+pedrosousa@users.noreply.github.com>
parent cbbcceb3
No related branches found
No related tags found
No related merge requests found
...@@ -22,8 +22,9 @@ Before proposing significant changes, open an issue so that we can discuss your ...@@ -22,8 +22,9 @@ Before proposing significant changes, open an issue so that we can discuss your
- Commits and commit messages - Commits and commit messages
- Use smaller commits for your work to make it easier to review. In your commit messages, be specific about what you changed in the files. - Use smaller commits for your work to make it easier to review. In your commit messages, be specific about what you changed in the files.
- If you are proposing a new page, use one of the [content type templates](https://github.com/cloudflare/cloudflare-docs/tree/production/static/_templates).
- Pull request titles - Pull request titles
- Follow the title structure of [Product Name]+ work you did + affected file(s) - Follow the title structure of [Product Name] + work you did + affected file(s)
- Example: [Access] fix broken link in example_file.md - Example: [Access] fix broken link in example_file.md
- Pull request descriptions - Pull request descriptions
- Use bullet points to summarize the changes in the commits - Use bullet points to summarize the changes in the commits
......
---
title: About <!---(for high-level product concept page only - otherwise omit this line)-->
weight: xx
pcx_content_type: concept
---
# About <product or noun phrase>
<!---
Provide a brief description of why users should care about this information.
Explain the page topic. Keep paragraphs short and concise to avoid large blocks of text. Feel free to use bulleted lists, notes, and headings for visual breaks.-->
---
weight: xx
pcx_content_type: configuration
---
# Title
Write an overview of the high-level feature here, not more than 2-3 sentences. Outline what users can achieve with it, and if necessary, link to other parts of the docs.
* [Feature 1](#feature-1)
* [Feature 2](#feature-2)
* [Feature 3](#feature-3)
## Feature 1
(Feature 1) allows you to (placeholder). For example, the following configuration (placeholder).
| Setting 1 | Setting 2 | Setting 3 |
| - | - | - |
| Value 1 | Value 2 | Value 3 |
## Feature 2
(Feature 2) allows you to (placeholder). For example, the following configuration (placeholder).
| Setting 1 | Setting 2 | Setting 3 |
| - | - | - |
| Value 1 | Value 2 | Value 3 |
## Feature 3
(Feature 3) allows you to (placeholder). For example, the following configuration (placeholder).
| Setting 1 | Setting 2 | Setting 3 |
| - | - | - |
| Value 1 | Value 2 | Value 3 |
\ No newline at end of file
---
weight: xx
pcx_content_type: how-to
---
<!---
Use this template for how-tos with multiple procedures that must be completed in order-->
# Second-person imperative verb phrase
<!---
Context for procedure (optional)
-->
## 1. Second-person imperative verb phrase
1. Step one.
2. Step two.
3. Step three.
4. ...
Next steps sentence - what users should see as the end result and/or actionable next steps.
## 2. Second-person imperative verb phrase
1. Step one.
2. Step two.
3. Step three.
4. ...
Next steps sentence - what users should see as the end result and/or actionable next steps.
## 3. Second-person imperative verb phrase
1. Step one.
2. Step two.
3. Step three.
4. ...
Next steps sentence - what users should see as the end result and/or actionable next steps.
\ No newline at end of file
---
weight: xx
pcx_content_type: how-to
---
<!---
Use this template for how-tos with multiple procedures that are order-agnostic.-->
# Second-person imperative verb phrase
<!---
Context for procedure (optional)
-->
## Second-person imperative verb phrase
1. Step one.
2. Step two.
3. Step three.
4. ...
Next steps sentence - what users should see as the end result and/or actionable next steps.
## Second-person imperative verb phrase
1. Step one.
2. Step two.
3. Step three.
4. ...
Next steps sentence - what users should see as the end result and/or actionable next steps.
\ No newline at end of file
---
weight: xx
pcx_content_type: how-to
---
# Second-person imperative verb phrase
<!---
Context for procedure (optional)
-->
1. Step one.
2. Step two.
3. Step three.
4. ...
Next steps sentence - what users should see as the end result and/or actionable next steps.
\ No newline at end of file
---
title: Overview
weight: 1
layout: overview
pcx_content_type: overview
---
# Cloudflare <product name> (or {{<beta>}}Cloudflare <product name>{{</beta>}} for products in beta)
{{<description>}}
Product description - What does this product do? Why would you use it? Short overview of product capability (~10-15 words).
{{</description>}}
{{<plan type="<enterprise|pro|business|all|paid|add-on>">}}
Summary - Brief welcoming introductory content. A few sentences describing the product’s benefits to the customer. Focus on customer benefit but can also include general product information.
---
## Features
{{<feature header="Name of feature" href="/link/to/feature/">}}
Description highlighting capabilities of product feature. This section accepts Markdown lists for multiple attributes.
{{</feature>}}
---
## Related products
{{<related header="<Name of product>" href="</link/to/product/>" product="<slugified-product-name>">}}
Description of product used together or connected configuration with current product.
{{</related>}}
---
## More resources
{{<resource-group>}}
{{<resource header="<Resource name>" href="https://www.cloudflare.com/link-to-resource/" icon="icon-name">}}
Description of external resource related to current product.
{{</resource>}}
{{</resource-group>}}
\ No newline at end of file
---
weight: xx
pcx_content_type: reference
---
# Reference
<!---
Write an overview of the reference information on this page. If this section has child pages, add navigation links below using the directory-listing shortcode to add links for each child page in a bulleted list.
-->
{{<directory-listing>}}
## Concise noun title
Brief description of content in this section.
## Concise noun title
Brief description of content in this section.
\ No newline at end of file
---
weight: xx
pcx_content_type: troubleshooting
---
# Troubleshooting <can add product name or feature here>
An introductory paragraph is not required but may be worthwhile if there is a lot of information on this page.
## Concise noun title
Explanation of how to address this issue.
## Concise noun title
Explanation of how to address this issue.
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment