Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

expand guidelines README #934

Merged
merged 4 commits into from
Sep 18, 2024
Merged

expand guidelines README #934

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5b02af5
update guidelines README
NHingerl Sep 17, 2024
d7ef294
Merge 'main' into update-guidelines-README
NHingerl Sep 17, 2024
a8ff930
fix broken links
NHingerl Sep 17, 2024
32d98a9
Iwona's review
NHingerl Sep 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions docs/guidelines/content-guidelines/README.md
View file
Open in desktop
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
View file
Open in desktop
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) | [`tutorials.md`](https://github.com/kyma-project/community/blob/main/templates/resources/task.md) | Use the template to provide a clear step-by-step instruction that helps the user to understand a given concept better. | All contributors |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| [`kyma/docs`](https://github.com/kyma-project/kyma/tree/main/docs) | [`tutorials.md`](https://github.com/kyma-project/community/blob/main/templates/resources/task.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 that helps the user to understand a given task better. | All contributors |

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wouldn't use "concept" in the description. I've replaced it with "task, but it could be "process" or "procedure".

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch!
Thinking about it, we could probably stop the sentence after "instruction" :D

| [`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