Skip to content

Commit 2adc441

Browse files
authored
Merge pull request #4396 from hhunter-ms/issue_4395
Update contributing Guide
2 parents b82a4b9 + 987da58 commit 2adc441

File tree

5 files changed

+10
-7
lines changed

5 files changed

+10
-7
lines changed

daprdocs/content/en/contributing/contributing-overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ See the [Dapr community repository](https://github.com/dapr/community) for more
1818

1919
1. **Docs**: This [repository](https://github.com/dapr/docs) contains the documentation for Dapr. You can contribute by updating existing documentation, fixing errors, or adding new content to improve user experience and clarity. Please see the specific guidelines for [docs contributions]({{< ref contributing-docs >}}).
2020

21-
2. **Quickstarts**: The Quickstarts [repository](https://github.com/dapr/quickstarts) provides simple, step-by-step guides to help users get started with Dapr quickly. Contributions in this repository involve creating new quickstarts, improving existing ones, or ensuring they stay up-to-date with the latest features.
21+
2. **Quickstarts**: The Quickstarts [repository](https://github.com/dapr/quickstarts) provides simple, step-by-step guides to help users get started with Dapr quickly. [Contributions in this repository](https://github.com/dapr/quickstarts/blob/master/CONTRIBUTING.md) involve creating new quickstarts, improving existing ones, or ensuring they stay up-to-date with the latest features.
2222

2323
3. **Runtime**: The Dapr runtime [repository](https://github.com/dapr/dapr) houses the core runtime components. Here, you can contribute by fixing bugs, optimizing performance, implementing new features, or enhancing existing ones.
2424

daprdocs/content/en/contributing/daprbot.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
type: docs
33
title: "Dapr bot reference"
44
linkTitle: "Dapr bot"
5-
weight: 15
5+
weight: 70
66
description: "List of Dapr bot capabilities."
77
---
88

daprdocs/content/en/contributing/docs-contrib/contributing-docs.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41,15 +41,18 @@ Style and tone conventions should be followed throughout all Dapr documentation
4141

4242
## Diagrams and images
4343

44-
Diagrams and images are invaluable visual aids for documentation pages. Diagrams are kept in a [Dapr Diagrams Deck](https://github.com/dapr/docs/tree/v1.11/daprdocs/static/presentations), which includes guidance on style and icons.
44+
Diagrams and images are invaluable visual aids for documentation pages. Use the diagram style and icons in the [Dapr Diagrams template deck](https://github.com/dapr/docs/tree/v1.14/daprdocs/static/presentations).
4545

46-
As you create diagrams for your documentation:
46+
The process for creating diagrams for your documentation:
4747

48-
- Save them as high-res PNG files into the [images folder](https://github.com/dapr/docs/tree/v1.11/daprdocs/static/images).
49-
- Name your PNG files using the convention of a concept or building block so that they are grouped.
48+
1. Download the [Dapr Diagrams template deck](https://github.com/dapr/docs/tree/v1.14/daprdocs/static/presentations) to use the icons and colors.
49+
1. Add a new slide and create your diagram.
50+
1. Screen capture the diagram as high-res PNG file and save in the [images folder](https://github.com/dapr/docs/tree/v1.14/daprdocs/static/images).
51+
1. Name your PNG files using the convention of a concept or building block so that they are grouped.
5052
- For example: `service-invocation-overview.png`.
5153
- For more information on calling out images using shortcode, see the [Images guidance](#images) section below.
52-
- Add the diagram to the correct section in the `Dapr-Diagrams.pptx` deck so that they can be amended and updated during routine refresh.
54+
1. Add the diagram to the appropriate section in your documentation using the HTML `<image>` tag.
55+
1. In your PR, comment the diagram slide (not the screen capture) so it can be reviewed and added to the diagram deck by maintainers.
5356

5457
## Contributing a new docs page
5558

2.15 MB
Binary file not shown.
-14.8 MB
Binary file not shown.

0 commit comments

Comments
 (0)