Skip to content

Commit

Permalink
expand guidelines README (#934)
Browse files Browse the repository at this point in the history
* update guidelines README

* fix broken links

* Iwona's review
  • Loading branch information
NHingerl authored Sep 18, 2024
1 parent 91a1a31 commit b186f9a
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 10 deletions.
22 changes: 22 additions & 0 deletions docs/guidelines/content-guidelines/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,25 @@
# Content Guidelines

These guidelines provide rules and tips to all who contribute content to the Kyma repositories.

[Content Strategy](00-content-strategy.md): Understand our target audience and document templates.

[User Documentation](01-user-docs.md): Publish documentation on kyma-project.io.

[Style and Terminology](02-style-and-terminology.md): Use active voice and present tense. Look up correct capitalization and vocabulary.

[Formatting](03-formatting.md): Learn about code font and bold font, how to create "Note" boxes, and correct headings.

[UI Elements](04-ui-elements.md): Create concise buttons, tooltips, and (error) messages.

[Tabs and Toggles](05-tabs-toggles.md): Create tabs or expandable sections, for example, for code blocks.

[Links](06-links.md): Create meaningful links.

[Release Notes](07-release-notes.md): <!-- pretty outdated! --> Write release notes for (pre-modular) Kyma.

[Screenshots](08-screenshots.md): Create useful screenshots.

[Diagrams](09-diagrams.md): Learn about the diagram style we use in Kyma.

[Documentation Preview](10-docs-preview.md): Before publishing on kyma-project.io, check how your docs will look like.
11 changes: 1 addition & 10 deletions docs/guidelines/templates/templates-type.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ This table lists all document types used to fully describe a Kyma area and/or co
| [`kyma/docs`](https://github.com/kyma-project/kyma/tree/main/docs) | [`architecture.md`](https://github.com/kyma-project/community/blob/main/templates/resources/architecture.md) | Use the template to describe the architecture of a Kyma component. | All contributors |
| [`kyma/docs`](https://github.com/kyma-project/kyma/tree/main/docs) | [`configuration.md`](https://github.com/kyma-project/community/blob/main/templates/resources/configuration.md) | Use the template to describe configuration options for a Kyma chart or sub-chart. | All contributors |
| [`kyma/docs`](https://github.com/kyma-project/kyma/tree/main/docs) | [`custom-resource.md`](https://github.com/kyma-project/community/blob/main/templates/resources/custom-resource.md) | Use the template to describe a custom resource (CR) and its elements. | All contributors |
| [`kyma/docs`](https://github.com/kyma-project/kyma/tree/main/docs) | [`tutorials.md`](https://github.com/kyma-project/community/blob/main/templates/resources/tutorial.md) | Use the template to provide a clear step-by-step instruction that helps the user to understand a given concept better. | All contributors |
| [`kyma/docs`](https://github.com/kyma-project/kyma/tree/main/docs) | [`task.md`](https://github.com/kyma-project/community/blob/main/templates/resources/task.md) | Use the template to provide a clear step-by-step instruction. | All contributors |
| [`kyma/docs`](https://github.com/kyma-project/kyma/tree/main/docs) | [`troubleshooting.md`](https://github.com/kyma-project/community/blob/main/templates/resources/troubleshooting.md) | Use the template to explain all details needed for Kyma and its components' troubleshooting. | All contributors |

## Official Kyma Graphics and Logo
Expand All @@ -33,15 +33,6 @@ See the following table to find a template of Kyma graphics and logo.
|---|---|---|---|
| No specific repository | [`Official Kyma graphics and logo`](https://github.com/kyma-project/community/tree/main/templates/resources/assets) | Use these graphics for any Kyma-related communication. | All contributors |

## Release Notes

See the templates for providing input and writing release notes.

| Repository | Template | Usage | Author |
|---|---|---|---|
| [`website/content/blog-posts`](https://github.com/kyma-project/website/tree/main/content/blog-posts) | [`release-notes.md`](https://github.com/kyma-project/community/blob/main/templates/resources/release-notes.md) | Use the template to write release notes. | Technical Writers |
| Internal use | [`release-notes-input.md`](https://github.com/kyma-project/community/blob/main/templates/resources/release-notes-input.md) | Use the template to provide input for the release notes. | Product Owners |

## Repository Templates

Go to the [`template-repository`](https://github.com/kyma-project/template-repository) directory for the template of an exemplary Kyma repository.
Expand Down

0 comments on commit b186f9a

Please sign in to comment.