-
Notifications
You must be signed in to change notification settings - Fork 108
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* update guidelines README * fix broken links * Iwona's review
- Loading branch information
Showing
2 changed files
with
23 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters