Skip to content

Commit

Permalink
Create docs folder (#64)
Browse files Browse the repository at this point in the history
* Move docs contributing info to separate folder

* update link to DOCS-CONTRIBUTING

* adding OWNERS

* fixing OWNERS

* moving aliases to top level
  • Loading branch information
samodell authored Jan 29, 2020
1 parent bdd7fc4 commit 6bf2e3f
Show file tree
Hide file tree
Showing 7 changed files with 106 additions and 4 deletions.
4 changes: 3 additions & 1 deletion OWNERS_ALIASES
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,6 @@ aliases:
- pmorie
- rgregg
- lindydonna
- jdumars
docs-team:
- samodell
- richieescarez
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ Submit a Pull Request to the community sample directory under the Knative
component folder that aligns with your document. For example, Knative Serving
samples are under the `serving` folder. A reviewer will be assigned to review
your submission. They'll work with you to ensure that your submission is clear,
correct, and meets the [style guide](./DOCS-CONTRIBUTING.md), but it helps if
correct, and meets the [style guide](./docs/DOCS-CONTRIBUTING.md), but it helps if
you follow it as you write your tutorial.

## Meetings and work groups
Expand Down
3 changes: 1 addition & 2 deletions DOCS-CONTRIBUTING.md → docs/DOCS-CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
title: "Contributing to the Knative documentation"
linkTitle: "Contributing to docs"
title: "How to contribute"
weight: 20
type: "docs"
---
Expand Down
6 changes: 6 additions & 0 deletions docs/OWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# The OWNERS file is used by prow to automatically merge approved PRs.

approvers:
- docs-team
reviewers:
- docs-team
14 changes: 14 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@

We're excited that you're interested in contributing to the Knative documentation! Check out the resources below to get started.

## Getting started

- [How to contribute](DOCS-CONTRIBUTING.md) -- Contains information about how to contribute and outlines the roles for Docs contributors.

- [Template page](https://raw.githubusercontent.com/knative/community/master/docs/new-page-template.md) -- A blank documentation page that demonstrates how to format a new page and includes tips on structuring your documentation.

## Getting help

- [#docs on the Knative Slack](https://slack.knative.dev) -- The #docs channel is the best place to go if you have questions about making changes to the documentation. We're happy to help!

- [Documentation working group](../WORKING-GROUPS.md#documentation) -- Come join us in the working group to meet other docs contributors and ask any questions you might have.
8 changes: 8 additions & 0 deletions docs/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
title: "Contributing to the Knative documentation"
linkTitle: "Contributing to the docs"
weight: 20
type: "docs"
---

{{% readfile file="README.md" %}}
73 changes: 73 additions & 0 deletions docs/new-page-template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
---
# This section is called the "frontmatter" for your page
title: "Title for your page" # Use sentence case for titles
#linkTitle: "Link for this page in the sidebar"
# The linkTitle field (above) is optional; use it to provide a shorter link if your page title is very long
weight: 10 # This affects the placement of the link in the sidebar on the left. Pages are ordered from top to bottom by weight, lowest to highest.
type: "docs" # You won't need to update this.
#aliases:
# - /docs/example/redirect/moved-renamed-page
# - /docs/another-example
# Has the page ever moved? If yes, include the prior location above, starting with path from the site root (for example /docs/, /blog/, or /community/). The old URL will redirect to this new file. For a new pages, "aliases" are not required.
---

This guide shows you how to do something very cool. Make sure to include
a value proposition for the user: for example, this guide shows you how to do X,
which is useful for doing Y and Z. Make sure you answer the questions "what does
this guide show you how to do?" and "why would someone want to do this?".

## Before you begin

You need:

- A Kubernetes cluster with [Knative installed](../install/README.md). <!-- Update this relative link as needed,
depending on where the new page is located in the file structure. -->
- Anything else?

## Break steps into logical sections

Avoid nesting headings directly on top of each other with no text inbetween.

1. Use ordered lists for steps.

1. Step number two.

1. Step number three.

<!-- GitHub's markdown processor will correctly automate the numbers in ordered
lists if every list item starts with one. Our site has a known issue with
rendering the numbers in ordered lists (see https://github.com/knative/docs/issues/1202)
but we still recommend contributors avoid manually numbered ordered lists. -->

### You can use smaller sections within sections for related tasks

Avoid nesting headings directly on top of each other with no text inbetween.

Put code into a code block.

1. Here's a code snippet:
<!-- Use spaces and not tabs to indent code blocks, and leave one blank line before and after the block. -->
```bash
kubectl apply --filename test.yaml
```
1. Another code snippet:

```bash
kubectl apply --filename test2.yaml
```

Always explain code snippets thoroughly so that how they work or what they do
is clear.

## Cleaning up

If your guide installs a sample application, show the user how to delete it.

## What's next

Provide links to other relevant topics, if applicable. Once someone has
completed these steps, what might they want to do next?

- [Link](./page.md) <!-- Always use relative links if linking to a page within the Docs repo. -->
- [Link](./page.md)
- [Link](./page.md)

0 comments on commit 6bf2e3f

Please sign in to comment.